Home / Social Apps / Archive by category 'Social API References'

Social API References

Opensocial.requestCreateActivity()

Opensocial.requestCreateActivity()

Description:
Makes a request to the container to create the activity. Parameters include activity (instance of opensocial.Activity), p (priority, specified by opensocial .CreateActivityPriority.HIGH or LOW), and opt_callback (optional callback function to be called when activity is created).

Object:
Opensocial


Opensocial.newNavigationalParameters()

Opensocial.newNavigationalParameters()

Description:
Redirects the user. Parameters include p (parameter map keyed with opensocial.NavagationalParameters.Field.* values that specify where to navigate to and when).

Returns:
opensocial.NavagationalParameters

Object:
Opensocial


Opensocial.newMessage()

Opensocial.newMessage()

Description:
Creates a new message. Parameters include body (string, message) and opt_params (optional parameters, keyed with opensocial.Message.Field.*).

Returns:
opensocial.Message

Object:
Opensocial


Opensocial.newMediaItem()

Opensocial.newMediaItem()

Description:
Creates a media item. Parameters include mt (type of media, specified by opensocial.MediaItem.Field.*), url (location of media, a string), and opt_params (optional parameters specifying additional fields).

Returns:
opensocial.MediaItem

Object:
Opensocial

Example:

var myVideo = opensocial.newMediaItem(opensocial.MediaItem.Field.VIDEO,"http://w3mentor.com/Video.mpg")

Opensocial.newIdSpec()

Opensocial.newIdSpec()

Description:
Creates a new instance of the DataRequest class with which to make data requests

Returns:
opensocial.IdSpec

Object:
Opensocial


Opensocial.newDataRequest()

Opensocial.newDataRequest()

Description:
Creates a new instance of the DataRequest class with which to make data requests

Returns:
opensocial.DataRequest

Object:
Opensocial

Example:

dataReqObj = opensocial.newDataRequest();

Opensocial.newActivity()

Opensocial.newActivity()

Description:
Creates a new instance of opensocial.Activity. Parameters specifying the activity include items such as title, body, and more.

Returns:
opensocial.Activity

Object:
Opensocial


Opensocial.hasPermission(p)

Opensocial.hasPermission(p)

Description:
Tells if application has permission.
Returns:
a Boolean.Parameters include p (an instance of opensocial.Permission).
Object:
Opensocial


Opensocial.getEnvironment()

Opensocial.getEnvironment()

Description:
Obtains the Environment associated with your application.
Returns:
opensocial.Environment
Object:
Opensocial