opensocial.Collection (v0.7)

 概要     詳細

Class opensocial.Collection

便利なアクセサを備えた複数のオブジェクトのコレクションです。より大きなコレクションのサブセット (たとえば 10 ページ中の 1 ページ) を表す場合もあります。その場合は、その大きなコレクションに関する情報が含まれています。

メソッドの概要

 Array.<Object> asArray()

このコレクションに含まれるすべてのオブジェクトの配列を返します。

each(fn)

指定された関数を、コレクションのメンバーごとに 1 回ずつ実行します。各メンバーは、関数に渡すパラメータに応じて順番に実行されます。

 Object? getById(id)

指定された ID 値のエントリを検索します。エントリが見つからない場合は null を返します。

 Number getOffset()

このコレクションの、より大きな結果セット内でのオフセットを取得します。

 Number getTotalSize()

このコレクションが属す、より大きな結果セット全体のサイズを取得します。

 Number size()

このコレクションのサイズを取得します。このサイズは、結果全体のサイズ以下になります。

 

メソッドの詳細

asArray

Array.<Object> asArray()

このコレクションに含まれるすべてのオブジェクトの配列を返します。

戻り値:
Array.<Object> このコレクションの値

each

each(fn)

指定された関数を、コレクションのメンバーごとに 1 回ずつ実行します。各メンバーは、関数に渡すパラメータに応じて順番に実行されます。

パラメータ:
Function fn - 各コレクション エントリで呼び出す関数

getById

Object? getById(id)

指定された ID 値のエントリを検索します。エントリが見つからない場合は null を返します。

パラメータ:
String id - 検索する ID

戻り値:
Object? 取得したデータ

getOffset

Number getOffset()

このコレクションの、より大きな結果セット内でのオフセットを取得します。

戻り値:
Number コレクション全体におけるオフセット

getTotalSize

Number getTotalSize()

このコレクションが属す、より大きな結果セット全体のサイズを取得します。

戻り値:
Number 結果全体のサイズ

size

Number size()

このコレクションのサイズを取得します。このサイズは、結果全体のサイズ以下になります。

戻り値:
Number このコレクションのサイズ

---