/
Osapi.messages (v0.9)

Osapi.messages (v0.9)

Oct 05, 2010

NeedsExamples

osapi.messages

Service object with functions that map to the .-RPC-Protocol.xml#Messages JSON-RPC Messages endpoint.

Methods

osapi.messages.send

;<static> osapi.Request osapi.messages.send(params)

Parameters
NameTypeDescription |

params

{AuthToken auth = HttpRequest.Authorization,String userId = "@me",opensocial.Message message}

An optional JSON object containing request parameters. See the send operation of the .-RPC-Protocol.xml#Messages JSON-RPC Messages service for more details.

Returns
TypeDescription |

osapi.Request

A request to retrieve information from the .-RPC-Protocol.xml#Messages JSON-RPC Messages service.

Description
Builds a request to send a message from the Messages JSON-RPC service.

{{ JsApiAlphaList_(v0.9) }}