NeedsExamples

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
NameTypeDescription |

Returns
TypeDescription |

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
NameTypeDescription |

Returns
TypeDescription |

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
NameTypeDescription |

Returns
TypeDescription |

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
NameTypeDescription |

Returns
TypeDescription |

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
NameTypeDescription |

Returns
TypeDescription |

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.

{{ JsApiAlphaList_(v0.9) }}