org.opensocial.services

Class PeopleService

java.lang.Object

org.opensocial.services.Service

org.opensocial.services.PeopleService

public class PeopleService
extends Service

OpenSocial API class for people requests; contains static methods for fetching profile information.

Author:

Jason Cooper

Field Summary

Fields inherited from class org.opensocial.services.Service

APP, FRIENDS, ME, SELF, VIEWER

Constructor Summary

Constructors

Constructor and Description
PeopleService()

Method Summary

Methods

Modifier and Type	Method and Description
static Request	getFriends() Returns a new Request instance which, when submitted, fetches the profile information of the current viewer's friends and makes this data available as a List of Person objects.
static Request	getFriends(String guid) Returns a new Request instance which, when submitted, fetches the profile information of the specified user's friends and makes this data available as a List of Person objects.
static Request	getUser(String guid) Returns a new Request instance which, when submitted, fetches the profile information of the user with the specified ID and makes this data available as a Person object.
static Request	getViewer() Returns a new Request instance which, when submitted, fetches the current viewer's profile information and makes this data available as a Person object.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PeopleService

public PeopleService()

Method Detail

getViewer

public static Request getViewer()

Returns a new Request instance which, when submitted, fetches the current viewer's profile information and makes this data available as a Person object. Equivalent to calling getUser("@me").

Returns:

new Request object to fetch the current viewer's profile data

See Also:

Person

getUser

public static Request getUser(String guid)

Returns a new Request instance which, when submitted, fetches the profile information of the user with the specified ID and makes this data available as a Person object.

Parameters:

guid - OpenSocial ID of the user to fetch

Returns:

new Request object to fetch the specified user's profile data

See Also:

Person

getFriends

public static Request getFriends()

Returns a new Request instance which, when submitted, fetches the profile information of the current viewer's friends and makes this data available as a List of Person objects. Equivalent to calling getFriends("@me").

Returns:

new Request object to fetch the current viewer's friends' profile data

See Also:

Person

getFriends

public static Request getFriends(String guid)

Returns a new Request instance which, when submitted, fetches the profile information of the specified user's friends and makes this data available as a List of Person objects.

Parameters:

guid - OpenSocial ID of the user whose friends are to be fetched

Returns:

new Request object to fetch the specified user's friends' profile data

See Also:

Person