Osapi.people (v0.9)

From VZ Developer Wiki
Jump to: navigation, search

This documentation is not completed yet and will be extended by more examples in future.

osapi.people

Service object with functions that map to the [./RPC-Protocol.xml#People JSON-RPC people endpoint].

Methods

osapi.people.get

<static> osapi.Request osapi.people.get(params)
Parameters
Name Type Description
params {
AuthToken auth = HttpRequest.Authorization,
String or Array.<String> userId = "@me",
String groupId = "@self",
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#People JSON-RPC people endpoint] for more details.
Returns
Type Description
osapi.Request A request to retrieve information from the [./RPC-Protocol.xml#People JSON-RPC People service].
Description
Builds a request to retrieve information from the JSON-RPC People service. When no parameter is specified, the server defaults, { userId : @me, groupId : @self}, will be used and the viewer's information will be returned.

osapi.people.getViewer

<static> osapi.Request osapi.people.getViewer(params)
Parameters
Name Type Description
params {
AuthToken auth = HttpRequest.Authorization,
Array.<String> fields,
}
An optional JSON object containing request parameters. See the get operation of the [./RPC-Protocol.xml#People JSON-RPC people endpoint] for more details.
Returns
Type Description
osapi.Request A request to retrieve information from the [./RPC-Protocol.xml#People JSON-RPC People service].
Description
A convenience over osapi.people.get() that builds a request to retrieve the viewer, as specified in the security token, from the people JSON-RPC service.

osapi.people.getViewerFriends

<static> osapi.Request osapi.people.getViewerFriends(params)
Parameters
Name Type Description
params {
AuthToken auth = HttpRequest.Authorization,
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#People JSON-RPC people endpoint] for more details.
Returns
Type Description
osapi.Request A request to retrieve information from the [./RPC-Protocol.xml#People JSON-RPC People service].
Description
A convenience over osapi.people.get() that builds a request to retrieve the viewer's friends, as specified in the security token, from the people JSON-RPC service.

osapi.people.getOwner

<static> osapi.Request osapi.people.get(params)
Parameters
Name Type Description
params {
AuthToken auth = HttpRequest.Authorization,
Array.<String> fields,
}
An optional JSON object containing request parameters. See the get operation of the [./RPC-Protocol.xml#People JSON-RPC people endpoint] for more details.
Returns
Type Description
osapi.Request A request to retrieve information from the [./RPC-Protocol.xml#People JSON-RPC People service].
Description
A convenience over osapi.people.get() that builds a request to retrieve the owner, as specified in the security token, from the people JSON-RPC service.

osapi.people.getOwnerFriends

<static> osapi.Request osapi.people.get(params)
Parameters
Name Type Description
params {
AuthToken auth = HttpRequest.Authorization,
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#People JSON-RPC people endpoint] for more details.
Returns
Type Description
osapi.Request A request to retrieve information from the [./RPC-Protocol.xml#People JSON-RPC People service].
Description
A convenience over osapi.people.get() that builds a request to retrieve the owner's friends, as specified in the security token, from the people JSON-RPC service.



OpenSocial (v0.9)

gadgets

gadgets.io

gadgets.json

gadgets.Prefs

gadgets.util

gadgets.views

gadgets.flash

gadgets.MiniMessage

gadgets.oauth.Popup

gadgets.rpc

gadgets.skins

gadgets.pubsub

gadgets.Tab

gadgets.TabSet

gadgets.window

gadgets.i18n

opensocial

opensocial.Activity

opensocial.Address

opensocial.Album

opensocial.BodyType

opensocial.Collection

opensocial.CreateActivityPriority

opensocial.DataRequest

opensocial.DataResponse

opensocial.Email

opensocial.Enum

opensocial.Environment

opensocial.EscapeType

opensocial.IdSpec

opensocial.MediaItem

opensocial.Message

opensocial.MessageCollection

opensocial.Name

opensocial.NavigationParameters

opensocial.Organization

opensocial.Permission

opensocial.Person

opensocial.Phone

opensocial.ResponseItem

opensocial.Url

osapi.Request

osapi.BatchRequest

osapi.people

osapi.activities

osapi.appdata

osapi.messages

osapi.http