opensocial.DataRequest.PeopleRequestFields (v0.7)

 SUMMARY     DETAIL

Static Class opensocial.DataRequest.PeopleRequestFields

Field Summary

<static> object FILTER

How to filter the people objects; defaults to ALL.

<static> object FIRST

When paginating, the index of the first item to fetch.

<static> object MAX

The maximum number of items to fetch; defaults to 20.

<static> object PROFILE_DETAILS

An array of opensocial.Person.Field specifying what profile data to fetch for each of the person objects.

<static> object SORT_ORDER

A sort order for the people objects; defaults to TOP_FRIENDS.

 

Field Detail

FILTER

<static> object FILTER

How to filter the people objects; defaults to ALL. Possible values are defined by FilterType.

FIRST

<static> object FIRST

When paginating, the index of the first item to fetch. Specified as a Number.

MAX

<static> object MAX

The maximum number of items to fetch; defaults to 20. If set to a larger number, a container may honor the request, or may limit the number to a container-specified limit of at least 20. Specified as a Number.

PROFILE_DETAILS

<static> object PROFILE_DETAILS

An array of opensocial.Person.Field specifying what profile data to fetch for each of the person objects. The server will always include ID, NAME, and THUMBNAIL_URL.

SORT_ORDER

<static> object SORT_ORDER

A sort order for the people objects; defaults to TOP_FRIENDS. Possible values are defined by SortOrder.

---