org.opensocial.services

Class MessagesService

java.lang.Object

org.opensocial.services.Service

org.opensocial.services.MessagesService

public class MessagesService
extends Service

OpenSocial API class for message requests; contains static methods for fetching and creating messages.

Author:

Okke Harsta

Field Summary

Fields inherited from class org.opensocial.services.Service

APP, FRIENDS, ME, SELF, VIEWER

Constructor Summary

Constructors

Constructor and Description
MessagesService()

Method Summary

Methods

Modifier and Type	Method and Description
static Request	createMessage(Message message) Returns a new Request instance which, when submitted, generates a new message for the current application associated with the current viewer.
static Request	createMessageCollection(MessageCollection messageCollection) Returns a new Request instance which, when submitted, generates a new messageCollection for the current application associated with the current viewer.
static Request	getMessages() Returns a new Request instance which, when submitted, fetches the current viewer's activities previously generated by the current application and makes this data available as a List of Message objects.
static Request	getMessages(String guid) Returns a new Request instance which, when submitted, fetches the specified user's activities previously generated by the current application and makes this data available as a List of Message objects.

Methods inherited from class java.lang.Object

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

Constructor Detail

MessagesService

public MessagesService()

Method Detail

getMessages

public static Request getMessages()

Returns a new Request instance which, when submitted, fetches the current viewer's activities previously generated by the current application and makes this data available as a List of Message objects. Equivalent to getMessages("@me").

Returns:

new Request object to fetch the current viewer's activities

See Also:

Message

getMessages

public static Request getMessages(String guid)

Returns a new Request instance which, when submitted, fetches the specified user's activities previously generated by the current application and makes this data available as a List of Message objects.

Parameters:

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

Returns:

new Request object to fetch the specified user's messages

See Also:

Message

createMessage

public static Request createMessage(Message message)

Returns a new Request instance which, when submitted, generates a new message for the current application associated with the current viewer.

Parameters:

message - Activity object specifying the activity parameters to pass into the request; typically, title, titleId, and body are set

Returns:

new Request object o create a new message for the current viewer

See Also:

Message

createMessageCollection

public static Request createMessageCollection(MessageCollection messageCollection)

Returns a new Request instance which, when submitted, generates a new messageCollection for the current application associated with the current viewer.

Parameters:

messageCollection - MessageCollection object specifying the activity parameters to pass into the request; only title is set

Returns:

new Request object o create a new message for the current viewer

See Also:

MessageCollection