mbga.BlackList

メソッド

mbga.BlackList.getId

mbga.BlackList.getTargetId

mbga.BlackList.getField

mbga.BlackList.setField

mbga.BlackList.Field

mbga.BlackList.Field.ID

ブラックリストの持ち主のユーザー ID。

mbga.BlackList.Field.TARGET_ID

mbga.BlackList.Field.ID のユーザーにブラックリスト登録されているユーザーのユーザー ID。

mbga.BlackListRequestFields

mbga.newFetchBlackListRequest, mbga.requestBlackList の opt_params で用いる事の出来るフィールド一覧です。

mbga.BlackListRequestFields.SORT_BY

mbga.BlackList.Field.TARGET_IDが指定できます。

mbga.BlackListRequestFields.SORT_ORDER

mbga.BlackList.SortOrder が指定できます。

mbga.BlackListRequestFields.FIRST

blacklistオブジェクト取得の開始位置を自然数で指定します。通常、mbga.BlackListRequestFields.MAXと同時に取得するデータのページングに用いられます。デフォルトの値は1です。

以下のサンプルでは取得するblacklistオブジェクトを5つずつのページに分けた上で、先頭から3番目のページとなる5つ分のデータを取得します。なお、該当するページに指定した数のデータが存在しなかった場合は返せる分だけのデータが取得されます。

サンプル

mbga.BlackListRequestFields.MAX

blacklistオブジェクト取得の最大数を自然数で指定します。通常、mbga.BlackListRequestFields.FIRSTと同時に取得するデータのページングに用いられます。デフォルトの値は50です。

mbga.BlackListRequestFields.PERSON_ID

ここにIDまたはIDの配列を指定した場合、指定したIDをTARGET_IDとしたblacklistオブジェクトのみが取得されます。以下のようなサンプルで、あるユーザ(この場合はVIEWER)が他のユーザ(この場合はID=10902のユーザ)をblacklistに登録しているかどうかを判別できます。

サンプル

mbga.BlackListRequestFields.FORMAT

mbga.BlackList.Format が指定できます

mbga.BlackListRequestFields.FIELDS

mbga.BlackList.Fieldのうちから獲得したいフィールドを並べた配列を指定します。

mbga.BlackListRequest.SortBy

mbga.BlackListRequest.SortBy.TARGET_ID

mbga.Blacklist.Field.TARGET_IDをキーとしてblacklistオブジェクトをソートします。

mbga.BlackListRequest.SortOrder

mbga.BlackListRequest.SortOrder.ASCENDING

キーとなる値の昇順でblacklistオブジェクトをソートします。

mbga.BlackListRequest.SortOrder.DESCENDING

キーとなる値の降順でblacklistオブジェクトをソートします。

mbga.BlackListRequest.Format

mbga.BlackListRequest.Format.JSON


更新履歴

  • 2011/2/1
    • mbga.BlackListRequestFields.PERSON_ID のサンプルを修正

PREVIOUS

mbga

NEXT

mbga.NGWord