OpenSocial JavaScript Features Supported by YAP
Activity
Supported Activity Fields
YAP supports opensocial.CreateActivityPriority.LOW for requestCreateActivity
but does not support opensocial.CreateActivityPriority.HIGH.
Requests for HIGH are treated the same as LOW.
Because OpenSocial 0.8 does not specify ActivityRequestFields,
offsets and limits (using "first" and "max") are not supported.
YAP supports the following Activity fields:
opensocial.Activity.Field.IDopensocial.Activity.Field.TITLEopensocial.Activity.Field.BODYopensocial.Activity.Field.URLopensocial.Activity.Field.USER_IDopensocial.Activity.Field.POSTED_TIME
Application Data
YAP supports up to 1,024 bytes of data per key and up to 1 MB per application.
Messaging
YAP does not support requestSendMessage and requestShareApp.
Person and People
Supported Person Fields
The following fields are in every response:
opensocial.Person.Field.IDopensocial.Person.Field.NAMEopensocial.Person.Field.THUMBNAIL_URL
If the information for the following fields is in the Yahoo! Social Directory, then they are in the response:
opensocial.Name.UNSTRUCTUREDopensocial.Person.Field.PROFILE_URLopensocial.Person.Field.ADDRESSESopensocial.Address.UNSTRUCTURED_ADDRESSopensocial.Person.Field.AGEopensocial.Person.Field.GENDERopensocial.Person.Field.TIME_ZONE(This field is not available when fetching friends.)
Supported PeopleRequest Fields
YAP supports only the following PeopleRequest fields:
opensocial.DataRequest.PeopleRequestFields.FIRSTopensocial.DataRequest.PeopleRequestFields.MAX
YAP does not support other PeopleRequest fields,
including FILTER, PROFILE_DETAILS, and SORT_ORDER.
YAP behaves as if these fields are set to ALL.
Supported DataRequest Fields
YAP supports only the ESCAPE_TYPE DataRequest field. All requests behave as if ESCAPE_TYPE is set to NONE.
Using Environment.supportsField
The Environment.supportsField method returns true
if the specified field is supported by the OpenSocial container.
The method does not check to see if the field value exists
for a given user.
A user might not provide information such as age, gender, and time zone. If this information is not provided, it is not returned in the response.
The supportsField method is useful for checking if the
container stores data for a certain field, for example, location.
If the container does not support location, then the
application must store the location data.
If the container does support location, but location is undefined,
then the application can prompt the user to update
location in the container's preferences.
Permissions
If your Yahoo! Open Application makes OpenSocial calls, on the Permissions tab of the Application Editor, specify Read (or Read/Write) for the following data:
- Yahoo! Profiles
- Yahoo! Updates
Gadget Core APIs
YAP supports the Gadget Core APIs, except for
Prefs, Views, and the Feature-Specific API.