Osapi.appdata (v0.9)
NeedsExamples
osapi.appdata
Service object with functions that map to the .-RPC-Protocol.xml#AppData JSON-RPC app data endpoint.
Methods
osapi.appdata.get
;<static> osapi.Request osapi.appdata.get(params)
Parameters
NameTypeDescription |
params | {AuthToken auth = HttpRequest.Authorization,String or Array.<String> userId = "@me",String groupId = "@self",String appId = auth.AppId,Array.<String> keys,} | An optional JSON object containing request parameters. See the get operation of the .-RPC-Protocol.xml#AppData JSON-RPC AppData service for more details. |
Returns
TypeDescription |
A request to retrieve information from the .-RPC-Protocol.xml#AppData JSON-RPC AppData service. |
Description
Builds a request to retrieve data from the AppData JSON-RPC service.
osapi.appdata.update
;<static> osapi.Request osapi.appdata.update(params)
Parameters
NameTypeDescription |
params | {AuthToken auth = HttpRequest.Authorization,String or Array.<String> userId = "@me",String groupId = "@self",String appId = auth.AppId,Map.<String, String> data,} | An optional JSON object containing request parameters. See the update operation of the .-RPC-Protocol.xml#AppData JSON-RPC AppData service for more details. |
Returns
TypeDescription |
A request to retrieve information from the .-RPC-Protocol.xml#AppData JSON-RPC AppData service. |
Description
Builds a request to create or update data from the AppData JSON-RPC service.
osapi.appdata.delete
;<static> osapi.Request osapi.appdata.delete(params)
Parameters
NameTypeDescription |
params | {AuthToken auth = HttpRequest.Authorization,String or Array.<String> userId = "@me",String groupId = "@self",String appId = auth.AppId,Array.<String> keys,} | An optional JSON object containing request parameters. See the delete operation of the .-RPC-Protocol.xml#AppData JSON-RPC AppData service for more details. |
Returns
TypeDescription |
A request to retrieve information from the .-RPC-Protocol.xml#AppData JSON-RPC AppData service. |
Description
Builds a request to delete data from the AppData JSON-RPC service.
{{ JsApiAlphaList_(v0.9) }}