opOpenSocialPlugin v1.2 documentation

opensocial.DataRequest.PeopleRequestFields

«  opensocial.DataRequest.MediaItemRequestFields   ::   Contents   ::   opensocial.DataRequest.SortOrder  »

opensocial.DataRequest.PeopleRequestFields

class opensocial.DataRequest.PeopleRequestFields()

opensocial.DataRequest.newFetchPeopleRequest メソッドや opensocial.DataRequest.newFetchPersonRequest メソッドで使用するパラメータです。

opensocial.DataRequest.PeopleRequestFields.APP_DATA

opensocial.DataRequest.PeopleRequestFields.APP_DATA

実装されていません メンバー情報とともに指定されたキーの AppData を取得します。

opensocial.DataRequest.PeopleRequestFields.ESCAPE_TYPE

opensocial.DataRequest.PeopleRequestFields.ESCAPE_TYPE

取得したデータのエスケープ方法を指定します。 opensocial.EscapeType で定義された値を指定して下さい。

デフォルトでは HTML_ESCAPE です。

opensocial.DataRequest.PeopleRequestFields.FILTER

opensocial.DataRequest.PeopleRequestFields.FILTER

取得するメンバーを絞り込むためのフィルターを指定します。使用できるフィルターは opensocial.DataRequest.FilterType を参照して下さい。

opensocial.DataRequest.PeopleRequestFields.FILTER_OPTIONS

opensocial.DataRequest.PeopleRequestFields.FILTER_OPTIONS

FILTER で指定されたフィルターで使用するオプション項目。フィルターにより使用できるオプションの種類が異なります。

opensocial.DataRequest.PeopleRequestFields.FIRST

opensocial.DataRequest.PeopleRequestFields.FIRST

メンバー情報を複数ページにわたって取得する場合に、何番目のメンバーから取得するかを指定します。

opensocial.DataRequest.PeopleRequestFields.MAX

opensocial.DataRequest.PeopleRequestFields.MAX

一度に取得するメンバー情報の件数を指定します。デフォルトでは20件です。

このパラメータで100以上を指定しても無視されます。この上限はSNSの管理者が変更可能です。

opensocial.DataRequest.PeopleRequestFields.PROFILE_DETAILS

opensocial.DataRequest.PeopleRequestFields.PROFILE_DETAILS

取得するプロフィール情報を指定します。指定できるフィールドは opensocial.Person.Field を参照して下さい。 また、SNS でサポートされているプロフィール項目を調べる場合は opensocial.Environment.supportsField メソッドを使用して下さい。

opensocial.DataRequest.PeopleRequestFields.SORT_ORDER

opensocial.DataRequest.PeopleRequestFields.SORT_ORDER

実装されていません メンバー情報の並び替え順を指定します。指定できる並び替え方法は opensocial.DataRequest.SortOrder を参照して下さい。

«  opensocial.DataRequest.MediaItemRequestFields   ::   Contents   ::   opensocial.DataRequest.SortOrder  »