OpenSocial APIs Supported by Ning

Table of Contents

• 2 opensocial
• 3 opensocial.Activity
• 4 openSocial.Activity.Field
• 5 opensocial.Activity.MediaItem
• 6 opensocial.Activity.MediaItem.Field
• 7 opensocial.Activity.MediaItem.Type
• 8 opensocial.Address
• 9 opensocial.BodyType
• 10 opensocial.Collection
• 11 opensocial.CreateActivityPriority
• 12 opensocial.DataRequest
• 13 opensocial.DataRequest.FilterType
• 14 opensocial.DataRequest.Group
• 15 opensocial.DataRequest.PeopleRequestFields
• 16 opensocial.DataRequest.PersonId
• 17 opensocial.DataRequest.SortOrder
• 18 opensocial.DataResponse
• 19 opensocial.Email
• 20 opensocial.Enum
• 21 opensocial.Enum.Drinker
• 22 opensocial.Enum.Gender
• 23 opensocial.Enum.Smoker
• 24 opensocial.Environment
• 25 opensocial.Environment.ObjectType
• 26 opensocial.Message
• 27 opensocial.Name
• 28 opensocial.Name.Field
• 29 opensocial.Organization
• 30 opensocial.Permission
• 31 openSocial.Person
• 32 openSocial.Person.Field
• 33 opensocial.Phone
• 34 openSocial.ResponseItem
• 35 openSocial.ResponseItem.Error
• 36 opensocial.Url
• 37 Gadget core API
• 38 Legacy Gadget API

OpenSocial APIs

opensocial

http://code.google.com/apis/opensocial/docs/0.7/reference/opensocial.html

Name	Supported	Notes
opensocial	YES
opensocial.getEnvironment()	YES
opensocial.hasPermission()	YES	Always returns 'true' for VIEWER; may be changed in a future release.
opensocial.newActivity()	YES
opensocial.newActivityMediaItem()	YES
opensocial.newDataRequest()	YES
opensocial.newMessage()	YES
opensocial.requestCreateActivity()	YES	The requestCreateActivity API has a quota of 5 invocations per member, per application, per day
opensocial.requestPermission()	NO	returns NOT_IMPLEMENTED; will be implemented in a future release
opensocial.requestSendMessage()	YES	The requestSendMessage API has a quota of 35 invocations per member, per day
opensocial.requestShareApp()	NO	returns NOT_IMPLEMENTED

opensocial.Activity

http://code.google.com/apis/opensocial/docs/0.7/reference/opensocial.Activity.html

Name	Supported	Notes
opensocial.Activity	YES
opensocial.Activity.getField()	YES	removed opt_params (0.8 spec)
opensocial.Activity.getId()	YES
opensocial.Activity.setField()	YES

openSocial.Activity.Field

http://code.google.com/apis/opensocial/docs/0.7/reference/opensocial.Activity.Field.html

Name	Supported	Notes
opensocial.Activity.Field	YES
opensocial.Activity.Field.APP_ID	YES
opensocial.Activity.Field.BODY	YES
opensocial.Activity.Field.BODY_ID	NO	Disabled for the first release
opensocial.Activity.Field.EXTERNAL_ID	NO	Disabled for the first release
opensocial.Activity.Field.ID	YES
opensocial.Activity.Field.MEDIA_ITEMS	NO	Disabled for the first release
opensocial.Activity.Field.POSTED_TIME	YES
opensocial.Activity.Field.PRIORITY	NO	Disabled for the first release
opensocial.Activity.Field.STREAM_FAVICON_URL	NO	Disabled for the first release
opensocial.Activity.Field.STREAM_SOURCE_URL	NO	Disabled for the first release
opensocial.Activity.Field.STREAM_TITLE	NO	Disabled for the first release
opensocial.Activity.Field.STREAM_URL	NO	Disabled for the first release
opensocial.Activity.Field.TEMPLATE_PARAMS	NO	Disabled for the first release
opensocial.Activity.Field.TITLE	YES
opensocial.Activity.Field.TITLE_ID	NO	Disabled for the first release
opensocial.Activity.Field.URL	NO	Disabled for the first release
opensocial.Activity.Field.USER_ID	YES

opensocial.Activity.MediaItem

http://code.google.com/apis/opensocial/docs/0.7/reference/opensocial.Activity.MediaItem.html

Name	Supported	Notes
opensocial.Activity.MediaItem	YES	Object is supported, but all methods allowing retrieval of these objects are disabled
opensocial.Activity.MediaItem.getField()	YES
opensocial.Activity.MediaItem.setField()	YES

opensocial.Activity.MediaItem.Field

http://code.google.com/apis/opensocial/docs/0.7/reference/opensocial.Activity.MediaItem.Field.html

Name	Supported	Notes
opensocial.Activity.MediaItem.Field	YES
opensocial.Activity.MediaItem.Field.MIME_TYPE	YES
opensocial.Activity.MediaItem.Field.TYPE	YES
opensocial.Activity.MediaItem.Field.URL	YES

opensocial.Activity.MediaItem.Type

http://code.google.com/apis/opensocial/docs/0.7/reference/opensocial.Activity.MediaItem.Type.html

Name	Supported	Notes
opensocial.Activity.MediaItem.Type	YES
opensocial.Activity.MediaItem.Type.AUDIO	YES
opensocial.Activity.MediaItem.Type.IMAGE	YES
opensocial.Activity.MediaItem.Type.VIDEO	YES

opensocial.Address

Object is supported, but all methods allowing retrieval of these objects are disabled

opensocial.BodyType

Object is supported, but all methods allowing retrieval of these objects are disabled

opensocial.Collection

http://code.google.com/apis/opensocial/docs/0.7/reference/opensocial.Collection.html

Name	Supported	Notes
opensocial.Collection	YES
opensocial.Collection.asArray()	YES
opensocial.Collection.each()	YES
opensocial.Collection.getById()	YES
opensocial.Collection.getOffset()	YES
opensocial.Collection.getTotalSize()	YES
opensocial.Collection.size()	YES

opensocial.CreateActivityPriority

http://code.google.com/apis/opensocial/docs/0.7/reference/opensocial.CreateActivityPriority.html

Name	Supported	Notes
opensocial.CreateActivityPriority	YES
opensocial.CreateActivityPriority.HIGH	YES
opensocial.CreateActivityPriority.LOW	YES

opensocial.DataRequest

http://code.google.com/apis/opensocial/docs/0.7/reference/opensocial.DataRequest.html

Name	Supported	Notes
opensocial.DataRequest	YES
opensocial.DataRequest.add()	YES
opensocial.DataRequest.newFetchActivitiesRequest()	YES
opensocial.DataRequest.newFetchPeopleRequest()	YES
opensocial.DataRequest.newFetchPersonAppDataRequest()	YES
opensocial.DataRequest.newFetchPersonRequest()	YES
opensocial.DataRequest.newUpdatePersonAppDataRequest()	YES
opensocial.DataRequest.send()	YES

opensocial.DataRequest.FilterType

http://code.google.com/apis/opensocial/docs/0.7/reference/opensocial.DataRequest.FilterType.html

Name	Supported	Notes
opensocial.DataRequest.FilterType	YES
opensocial.DataRequest.FilterType.ALL	YES
opensocial.DataRequest.FilterType.HAS_APP	YES

opensocial.DataRequest.Group

http://code.google.com/apis/opensocial/docs/0.7/reference/opensocial.DataRequest.Group.html

Name	Supported	Notes
opensocial.DataRequest.Group	YES
opensocial.DataRequest.Group.OWNER_FRIENDS	YES
opensocial.DataRequest.Group.VIEWER_FRIENDS	YES

opensocial.DataRequest.PeopleRequestFields

http://code.google.com/apis/opensocial/docs/0.7/reference/opensocial.DataRequest.PeopleRequestFields.html

Name	Supported	Notes
opensocial.DataRequest.PeopleRequestFields	YES
opensocial.DataRequest.PeopleRequestFields.FILTER	YES
opensocial.DataRequest.PeopleRequestFields.FIRST	YES
opensocial.DataRequest.PeopleRequestFields.MAX	YES
opensocial.DataRequest.PeopleRequestFields.PROFILE_DETAILS	YES
opensocial.DataRequest.PeopleRequestFields.SORT_ORDER	YES

opensocial.DataRequest.PersonId

http://code.google.com/apis/opensocial/docs/0.7/reference/opensocial.DataRequest.PersonId.html

Name	Supported	Notes
opensocial.DataRequest.PersonId	YES
opensocial.DataRequest.PersonId.OWNER	YES
opensocial.DataRequest.PersonId.VIEWER	YES

opensocial.DataRequest.SortOrder

http://code.google.com/apis/opensocial/docs/0.7/reference/opensocial.DataRequest.SortOrder.html

Name	Supported	Notes
opensocial.DataRequest.SortOrder	YES
opensocial.DataRequest.SortOrder.NAME	YES
opensocial.DataRequest.SortOrder.TOP_FRIENDS	YES

opensocial.DataResponse

http://code.google.com/apis/opensocial/docs/0.7/reference/opensocial.DataResponse.html

Name	Supported	Notes
opensocial.DataResponse	YES
opensocial.DataResponse.get()	YES
opensocial.DataResponse.hadError()	YES

opensocial.Email

Object is supported, but all methods allowing retrieval of these objects are disabled

opensocial.Enum

http://code.google.com/apis/opensocial/docs/0.7/reference/opensocial.Enum.html

Name	Supported	Notes
opensocial.Enum	YES
opensocial.Enum.getDisplayValue()	YES
opensocial.Enum.getKey()	YES

opensocial.Enum.Drinker

Object is supported, but all methods allowing retrieval of these objects are disabled

opensocial.Enum.Gender

http://code.google.com/apis/opensocial/docs/0.7/reference/opensocial.Enum.Gender.html

Name	Supported	Notes
opensocial.Enum.Gender	YES
opensocial.Enum.Gender.FEMALE	YES
opensocial.Enum.Gender.MALE	YES

opensocial.Enum.Smoker

http://code.google.com/apis/opensocial/docs/0.7/reference/opensocial.Enum.Smoker.html

Name	Supported	Notes
opensocial.Enum.Smoker	YES
opensocial.Enum.Smoker.HEAVILY	YES
opensocial.Enum.Smoker.NO	YES
opensocial.Enum.Smoker.OCCASIONALLY	YES
opensocial.Enum.Smoker.QUIT	YES
opensocial.Enum.Smoker.QUITTING	YES
opensocial.Enum.Smoker.REGULARLY	YES
opensocial.Enum.Smoker.SOCIALLY	YES
opensocial.Enum.Smoker.YES	YES

opensocial.Environment

http://code.google.com/apis/opensocial/docs/0.7/reference/opensocial.Environment.html

Name	Supported	Notes
opensocial.Environment	YES
opensocial.Environment.getDomain()	YES
opensocial.Environment.supportsField()	YES

opensocial.Environment.ObjectType

http://code.google.com/apis/opensocial/docs/0.7/reference/opensocial.Environment.ObjectType.html

Name	Supported	Notes
opensocial.Environment.ObjectType	YES
opensocial.Environment.ObjectType.ACTIVITY	YES
opensocial.Environment.ObjectType.ACTIVITY_MEDIA_ITEM	YES	renamed from MEDIA_ITEM
opensocial.Environment.ObjectType.ADDRESS	YES
opensocial.Environment.ObjectType.BODY_TYPE	YES
opensocial.Environment.ObjectType.EMAIL	YES
opensocial.Environment.ObjectType.FILTER_TYPE	YES
opensocial.Environment.ObjectType.MESSAGE	YES
opensocial.Environment.ObjectType.MESSAGE_TYPE	YES
opensocial.Environment.ObjectType.NAME	YES
opensocial.Environment.ObjectType.ORGANIZATION	YES
opensocial.Environment.ObjectType.PERSON	YES
opensocial.Environment.ObjectType.PHONE	YES
opensocial.Environment.ObjectType.SORT_ORDER	YES
opensocial.Environment.ObjectType.URL	YES

opensocial.Message

http://code.google.com/apis/opensocial/docs/0.7/reference/opensocial.Message.html

Name	Supported	Notes
opensocial.Message.getField()	YES
opensocial.Message.setField()	YES

opensocial.Message.Field

http://code.google.com/apis/opensocial/docs/0.7/reference/opensocial.Message.Field.html

Name	Supported	Notes
opensocial.Message.Field.BODY	YES
opensocial.Message.Field.TITLE	YES
opensocial.Message.Field.TYPE	YES

opensocial.Message.Type

http://code.google.com/apis/opensocial/docs/0.7/reference/opensocial.Message.Type.html

Name	Supported	Notes
opensocial.Message.Type.EMAIL	YES
opensocial.Message.Type.NOTIFICATION	NO
opensocial.Message.Type.PRIVATE_MESSAGE	NO
opensocial.Message.Type.PUBLIC_MESSAGE	NO

opensocial.Name

http://code.google.com/apis/opensocial/docs/0.7/reference/opensocial.Name.html

Name	Supported	Notes
opensocial.Name	YES
opensocial.Name.getField()	YES	removed opt_params

opensocial.Name.Field

http://code.google.com/apis/opensocial/docs/0.7/reference/opensocial.Name.Field.html

Name	Supported	Notes
opensocial.Name.Field	YES
opensocial.Name.Field.ADDITIONAL_NAME	NO
opensocial.Name.Field.FAMILY_NAME	NO
opensocial.Name.Field.GIVEN_NAME	NO
opensocial.Name.Field.HONORIFIC_PREFIX	NO
opensocial.Name.Field.HONORIFIC_SUFFIX	NO
opensocial.Name.Field.UNSTRUCTURED	YES

opensocial.Organization

object is supported, but all methods allowing retrieval of these objects are disabled

opensocial.Permission

http://code.google.com/apis/opensocial/docs/0.7/reference/opensocial.Permission.html

Name	Supported	Notes
opensocial.Permission	YES
opensocial.Permission.VIEWER	YES

openSocial.Person

http://code.google.com/apis/opensocial/docs/0.7/reference/opensocial.Person.html

Name	Supported	Notes
opensocial.Person	YES
opensocial.Person.getDisplayName()	YES	removed all code that references other fields than opensocial.Name.Field.UNSTRUCTURED. This must be re-added once we support more fields.
opensocial.Person.getField()	YES	removed additional opt_params parameter
opensocial.Person.getId()	YES
opensocial.Person.isOwner()	YES
opensocial.Person.isViewer()	YES

openSocial.Person.Field

http://code.google.com/apis/opensocial/docs/0.7/reference/opensocial.Person.Field.html

Name	Supported	Notes
opensocial.Person.Field	YES	removed HAS_APP and NETWORK_PRESENCE fields
opensocial.Person.Field.ABOUT_ME	NO
opensocial.Person.Field.ACTIVITIES	NO
opensocial.Person.Field.ADDRESSES	NO
opensocial.Person.Field.AGE	NO
opensocial.Person.Field.BODY_TYPE	NO
opensocial.Person.Field.BOOKS	NO
opensocial.Person.Field.CARS	NO
opensocial.Person.Field.CHILDREN	NO
opensocial.Person.Field.CURRENT_LOCATION	NO
opensocial.Person.Field.DATE_OF_BIRTH	NO
opensocial.Person.Field.DRINKER	NO
opensocial.Person.Field.EMAILS	NO
opensocial.Person.Field.ETHNICITY	NO
opensocial.Person.Field.FASHION	NO
opensocial.Person.Field.FOOD	NO
opensocial.Person.Field.GENDER	NO
opensocial.Person.Field.HAPPIEST_WHEN	NO
opensocial.Person.Field.HEROES	NO
opensocial.Person.Field.HUMOR	NO
opensocial.Person.Field.ID	YES
opensocial.Person.Field.INTERESTS	NO
opensocial.Person.Field.JOB_INTERESTS	NO
opensocial.Person.Field.JOBS	NO
opensocial.Person.Field.LANGUAGES_SPOKEN	NO
opensocial.Person.Field.LIVING_ARRANGEMENT	NO
opensocial.Person.Field.LOOKING_FOR	NO
opensocial.Person.Field.MOVIES	NO
opensocial.Person.Field.MUSIC	NO
opensocial.Person.Field.NAME	YES
opensocial.Person.Field.NICKNAME	NO
opensocial.Person.Field.PETS	NO
opensocial.Person.Field.PHONE_NUMBERS	NO
opensocial.Person.Field.POLITICAL_VIEWS	NO
opensocial.Person.Field.PROFILE_SONG	NO
opensocial.Person.Field.PROFILE_URL	YES
opensocial.Person.Field.PROFILE_VIDEO	NO
opensocial.Person.Field.QUOTES	NO
opensocial.Person.Field.RELATIONSHIP_STATUS	NO
opensocial.Person.Field.RELIGION	NO
opensocial.Person.Field.ROMANCE	NO
opensocial.Person.Field.SCARED_OF	NO
opensocial.Person.Field.SCHOOLS	NO
opensocial.Person.Field.SEXUAL_ORIENTATION	NO
opensocial.Person.Field.SMOKER	NO
opensocial.Person.Field.SPORTS	NO
opensocial.Person.Field.STATUS	NO
opensocial.Person.Field.TAGS	NO
opensocial.Person.Field.THUMBNAIL_URL	YES
opensocial.Person.Field.TIME_ZONE	NO
opensocial.Person.Field.TURN_OFFS	NO
opensocial.Person.Field.TURN_ONS	NO
opensocial.Person.Field.TV_SHOWS	NO
opensocial.Person.Field.URLS	NO

opensocial.Phone

object is supported, but all methods allowing retrieval of these objects are disabled

openSocial.ResponseItem

http://code.google.com/apis/opensocial/docs/0.7/reference/opensocial.ResponseItem.html

Name	Supported	Notes
opensocial.ResponseItem	YES
opensocial.ResponseItem.getData()	YES
opensocial.ResponseItem.getErrorCode()	YES
opensocial.ResponseItem.getErrorMessage()	YES
opensocial.ResponseItem.getOriginalDataRequest()	YES
opensocial.ResponseItem.hadError()	YES

openSocial.ResponseItem.Error

http://code.google.com/apis/opensocial/docs/0.7/reference/opensocial.ResponseItem.Error.html

Name	Supported	Notes
opensocial.ResponseItem.Error	YES	removed LIMIT_EXCEEDED
opensocial.ResponseItem.Error.BAD_REQUEST	YES
opensocial.ResponseItem.Error.FORBIDDEN	YES
opensocial.ResponseItem.Error.INTERNAL_ERROR	YES
opensocial.ResponseItem.Error.NOT_IMPLEMENTED	YES
opensocial.ResponseItem.Error.UNAUTHORIZED	YES

opensocial.Url

http://code.google.com/apis/opensocial/docs/0.7/reference/opensocial.Url.html

Name	Supported	Notes
opensocial.Url	YES
opensocial.Url.getField()	YES	removed optional opt_params parameter
opensocial.Url.Field	YES
opensocial.Url.Field.ADDRESS	YES
opensocial.Url.Field.LINK_TEXT	YES
opensocial.Url.Field.TYPE	YES

Gadget core API

gadgets.io
gadgets.io.encodeValues()
gadgets.io.getProxyUrl()
gadgets.io.makeRequest()
gadgets.io.AuthorizationType
gadgets.io.AuthorizationType.NONE
gadgets.io.AuthorizationType.OAUTH
gadgets.io.AuthorizationType.SIGNED
gadgets.io.ContentType
gadgets.io.ContentType.DOM
gadgets.io.ContentType.FEED
gadgets.io.ContentType.JSON
gadgets.io.ContentType.TEXT
gadgets.io.MethodType
gadgets.io.MethodType.DELETE
gadgets.io.MethodType.GET
gadgets.io.MethodType.HEAD
gadgets.io.MethodType.POST
gadgets.io.MethodType.PUT
gadgets.io.ProxyUrlRequestParameters
gadgets.io.ProxyUrlRequestParameters.REFRESH_INTERVAL
gadgets.io.RequestParameters
gadgets.io.RequestParameters:AUTHORIZATION
gadgets.io.RequestParameters.CONTENT_TYPE
gadgets.io.RequestParameters.GET_SUMMARIES
gadgets.io.RequestParameters.HEADERS
gadgets.io.RequestParameters.METHOD
gadgets.io.RequestParameters.NUM_ENTRIES
gadgets.io.RequestParameters.POST_DATA
gadgets.json
gadgets.json.parse()
gadgets.json.stringify()
gadgets.Prefs
gadgets.Prefs.getArray()
gadgets.Prefs.getBool()
gadgets.Prefs.getCountry()
gadgets.Prefs.getFloat()
gadgets.Prefs.getInt()
gadgets.Prefs.getLang()
gadgets.Prefs.getModuleId()
gadgets.Prefs.getMsg()
gadgets.Prefs.getString()
gadgets.Prefs.set()
gadgets.Prefs.setArray()
gadgets.skins.getProperty()
gadgets.skins.Property.ANCHOR_COLOR
gadgets.skins.Property.BG_COLOR
gadgets.skins.Property.BG_IMAGE
gadgets.skins.Property.FONT_COLOR
gadgets.util
gadgets.util.escapeString()
gadgets.util.getFeatureParameters()
gadgets.util.hasFeature()
gadgets.util.registerOnLoadHandler()
gadgets.util.unescapeString()

Legacy Gadget API

To support older Gadgets, there is also a legacy API:

_IG_Prefs()
<userprefs>.getString()
<userprefs>.getInt()
<userprefs>.getBool()
<userprefs>.getArray()
<userprefs>.set()
<userprefs>.setArray()
<userprefs>.dump()
_IG_FetchContent()
_IG_FetchXmlContent()
_IG_FetchFeedAsJSON()
_IG_RegisterOnloadHandler()
_gel()
_gelstn()
_esc()
_unesc()
_trim()
_uc()
_min()
_max()
_hesc()
_args()
_toggle()
_IG_GetImage()
_IG_GetCachedUrl()

• Terminology and Anatomy of an Ning OpenSocial Application
• Ning OpenSocial Application Tutorials
• Testing and Submitting Your Ning OpenSocial Application
• OpenSocial Best Practices, Known Issues & Other Resources
• OpenSocial APIs Supported by Ning