Osapi.activities (v0.9)

NeedsExamples

osapi.activities

Service object with functions that map to the .-RPC-Protocol.xml.

Methods

osapi.activities.get

;<static> osapi.Request osapi.activities.get(params)

Parameters
NameTypeDescription |

params

{AuthToken auth = HttpRequest.Authorization,String or Array.<String> userId = "@me",String groupId = "@self",String appId = auth.AppId,Array.<String> activityIds = OpenSocial Wiki - OLD,Array.<String> fields,int count,int startIndex,int startPage}

An optional JSON object containing request parameters. See the get operation of the (.-RPC-Protocol.xml#Activities JSON-RPC Activities service] for more details.

Returns
TypeDescription |

osapi.Request

A request to retrieve information from the .-RPC-Protocol.xml.

Description
Builds a request to retrieve activities from the Activities JSON-RPC service.

osapi.activities.create

;<static> osapi.Request osapi.activities.create(params)

Parameters
NameTypeDescription |

params

{AuthToken auth = HttpRequest.Authorization,String or Array.<String> userId = "@me",String groupId = "@self",String appId = auth.AppId,opensocial.Activity activity,}

An optional JSON object containing request parameters. See the create operation of the .-RPC-Protocol.xml for more details.

Returns
TypeDescription |

osapi.Request

A request to retrieve information from the .-RPC-Protocol.xml.

Description
Builds a request to create an activity using the Activities JSON-RPC service.

{{ JsApiAlphaList_(v0.9) }}