org.opensocial.services

Class AppDataService

java.lang.Object

org.opensocial.services.Service

org.opensocial.services.AppDataService

public class AppDataService
extends Service

OpenSocial API class for AppData (persistent storage) requests; contains static methods for fetching, updating, and deleting AppData.

Author:

Jason Cooper

Field Summary

Fields inherited from class org.opensocial.services.Service

APP, FRIENDS, ME, SELF, VIEWER

Constructor Summary

Constructors

Constructor and Description
AppDataService()

Method Summary

Methods

Modifier and Type	Method and Description
static Request	deleteAppData(List<String> keys) Returns a new Request which, when submitted, deletes the specified keys and their associated values in the current viewer's AppData.
static Request	deleteAppData(String key) Returns a new Request which, when submitted, deletes the specified key and its associated value in the current viewer's AppData.
static Request	deleteAppData(String[] keys) Returns a new Request which, when submitted, deletes the specified keys and their associated values in the current viewer's AppData.
static Request	getAppData() Returns a new Request instance which, when submitted, fetches the current viewer's persistent AppData (set of key/value strings) associated with the current application and makes this available as an AppData object.
static Request	getAppData(String guid) Returns a new Request instance which, when submitted, fetches the specified user's AppData (set of key/value strings) associated with the current application and makes this available as an AppData object.
static Request	getFriendAppData(String guid) Returns a new Request instance which, when submitted, fetches the AppData (set of key/value strings) associated with the current application for the specified user's friends and makes this available as an AppData object.
static Request	updateAppData(Map<String,String> data) Returns a new Request instance which, when submitted, updates the current viewer's AppData with the key/value strings in the passed Map.
static Request	updateAppData(String key, String value) Returns a new Request instance which, when submitted, updates the current viewer's AppData by either adding the specified key if it doesn't already exist or updating the associated value if it does exist.

Methods inherited from class java.lang.Object

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

Constructor Detail

AppDataService

public AppDataService()

Method Detail

getAppData

public static Request getAppData()

Returns a new Request instance which, when submitted, fetches the current viewer's persistent AppData (set of key/value strings) associated with the current application and makes this available as an AppData object. Equivalent to getAppData("@me").

Returns:

new Request object to fetch the current viewer's AppData

See Also:

AppData

getAppData

public static Request getAppData(String guid)

Returns a new Request instance which, when submitted, fetches the specified user's AppData (set of key/value strings) associated with the current application and makes this available as an AppData object.

Parameters:

guid - OpenSocial ID of user whose AppData is to be fetched

Returns:

new Request object to fetch the specified user's AppData

See Also:

AppData

getFriendAppData

public static Request getFriendAppData(String guid)

Returns a new Request instance which, when submitted, fetches the AppData (set of key/value strings) associated with the current application for the specified user's friends and makes this available as an AppData object. Pass "@me" to fetch AppData for all friends of the current viewer.

Parameters:

guid - OpenSocial ID of user whose friends' AppData is to be fetched

Returns:

new Request object to fetch the AppData for the specified user's friends

See Also:

AppData

updateAppData

public static Request updateAppData(String key,
                    String value)

Returns a new Request instance which, when submitted, updates the current viewer's AppData by either adding the specified key if it doesn't already exist or updating the associated value if it does exist.

Parameters:

key - AppData key to update

value - new value to be associated with the specified key

Returns:

new Request object to update the current viewer's AppData

updateAppData

public static Request updateAppData(Map<String,String> data)

Returns a new Request instance which, when submitted, updates the current viewer's AppData with the key/value strings in the passed Map. If the keys don't already exist, they are added; otherwise, the associated values are replaced with those in the passed Map.

Parameters:

data - Map of key/value pairs to be persisted in AppData

Returns:

new Request object to update the current viewer's AppData

deleteAppData

public static Request deleteAppData(String key)

Returns a new Request which, when submitted, deletes the specified key and its associated value in the current viewer's AppData.

Parameters:

key - AppData key to delete

Returns:

new Request object to delete a single key in the current viewer's AppData

deleteAppData

public static Request deleteAppData(String[] keys)

Returns a new Request which, when submitted, deletes the specified keys and their associated values in the current viewer's AppData.

Parameters:

keys - array of AppData keys to delete

Returns:

new Request object to delete one or more keys in the current viewer's AppData

deleteAppData

public static Request deleteAppData(List<String> keys)

Returns a new Request which, when submitted, deletes the specified keys and their associated values in the current viewer's AppData.

Parameters:

keys - List of AppData keys to delete

Returns:

new Request object to delete one or more keys in the current viewer's AppData