Skip to main content

opensocial

Method​

opensocial.requestSendMessage​

<static> requestSendMessage(recipients, message, opt_callback, opt_params)

Makes a request for a message to be sent to the specified user.

Parameters​
NameTypeDescription
recipientsStringRefer to the group or User ID of the receiver. Only the OWNER key is supported.
messageopensocial.MessageMessage object sent to the specified user
opt_callbackFunctionThe callback function that is called when the request is complete
opt_paramsopensocial.NavigationParametersThe parameters that indicate the location the user is moved to when requested, or when a request is accepted
Return value​

None

Sample​
var params = {};
params[opensocial.Message.Field.TITLE] = "Hello!";
var msg = opensocial.newMessage("Hello!", params);
var recipient = "xxxxxx";
opensocial.requestSendMessage(recipient, msg,
function (res) {
if (res.hadError()) {
// ...
} else {
// ...
}
}
);

opensocial.requestShareApp​

<static> requestShareApp(recipients, reason, opt_callback, opt_params)

Makes a request for this application to be shared with the specified user.

Parameters​
NameTypeDescription
recipientsStringOnly VIEWER_FRIENDS can be specified
reasonnullnull
opt_callbackFunctionThe callback function that is called when the request is complete
Return Value​

None

Sample​
var params ={};
params[opensocial.Message.Field.TITLE] = "invite to new Game";
var msg =opensocial.newMessage("Let's play together!in campaign now!", params);
opensocial.requestShareApp("VIEWER_FRIENDS", msg,
function(res) {
if (res.hadError()) {
// ...
} else {
// ...
}
}
);

opensocial.requestCreateActivity​

<static> requestCreateActivity(activity, priority, opt_callback)

Makes a request to create the specified activity without waiting for the operation to be completed.

Parameters​
NameTypeDescription
activityopensocial.ActivityActivity object to be created
priorityopensocial.CreateActivityPriorityRequest Priority
opt_callbackFunctionThe callback function that is called when the request is complete
Return Value​

None

Sample​
var params = {};
params[opensocial.Activity.Field.TITLE] = "Hello!";
var activity = opensocial.newActivity(params);
opensocial.requestCreateActivity(activity, opensocial.CreateActivityPriority.LOW,
function(res) {
if (res.hadError()) {
// ...
} else {
// ...
}
}
);

opensocial.hasPermission​

Not supported

opensocial.requestPermission​

Not supported

opensocial.getEnvironment​

Not supported

opensocial.newDataRequest​

<static> opensocial.DataRequest newDataRequest()

Create a DataRequest object

Parameters​

None

Return Value​
TypeDescription
opensocial.DataRequestNew DataRequest Object
Sample​
var req = opensocial.newDataRequest();

opensocial.newActivity​

<static> opensocial.Activity newActivity(params)

Creates an Activity object

Parameters​
NameTypeDescription
paramsMap.<opensocial.Activity.Field/Object>Other fields that must be set as the Activity object. opensocial.Activity.Field.TITLE can be specified.
Return Value​
TypeDescription
opensocial.ActivityActivity object
Sample​
var params = {};
params[opensocial.Activity.Field.TITLE] = "Hello!";
var activity = opensocial.newActivity(params);

opensocial.newMediaItem​

<static> opensocial.MediaItem newMediaItem(mime_type, url, opt_params)

Creates a MediaItem object

Parameters​
NameTypeDescription
mime_typeStringMedia MIME type
urlStringMedia URL
opt_paramsMap.<opensocial.MediaItem.Field/Object>Other fields that must be set as the MediaItem object
Return Value​
TypeDescription
opensocial.MediaItemMediaItem object
Sample​
var mediaItem = opensocial.newMediaItem("image/gif", "http://example.com/foo.gif");

opensocial.newMessage​

<static> opensocial.Message newMessage(body, opt_params)

Description
Create a Message object

Parameters​
NameTypeDescription
bodyStringMain text of the message
opt_paramsMap.Other fields that must be set as the Message object
Return Value​
TypeDescription
opensocial.MessageMessage object
Sample​
var params = {};
params[opensocial.Message.Field.TITLE] = "Hello!";
var message = opensocial.newMessage("こんにちは!", params);

opensocial.newIdSpec​

<static> opensocial.IdSpec newIdSpec(parameters)

Description
Create an IdSpec object

Parameters​
NameTypeDescription
patametersMap.<opensocial.IdSpec.Field/Object>Other fields that must be set as the IdSpec object
Return Value​
TypeDescription
opensocial.IdSpecIdSpec object
Sample​
var params = {};
params[opensocial.IdSpec.Field.USER_ID] = opensocial.IdSpec.PersonId.VIEWER;
params[opensocial.IdSpec.Field.GROUP_ID] = opensocial.IdSpec.GroupId.FRIENDS;
var id_spec = opensocial.newIdSpec(params);

opensocial.newNavigationParameters​

Not supported

Revision History​

  • 01/24/2011
    • Modified the opensocial.requestSendMessage sample.
  • 12/2010
    • Initial Release.