org.opensocial.models

Class Message

java.lang.Object

java.util.AbstractMap<K,V>

java.util.HashMap

org.json.simple.JSONObject

org.opensocial.models.Model

org.opensocial.models.Message

All Implemented Interfaces:

Serializable, Cloneable, Map, org.json.simple.JSONAware, org.json.simple.JSONStreamAware

public class Message
extends Model

OpenSocial model class representing an message.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
Message()

Method Summary

Methods

Modifier and Type	Method and Description
String	getBody() Returns the message's body, a string specifying an optional expanded version of an message.
String	getBodyId() Returns the message's body ID, a string specifying the body template message ID in the accompanying gadget specification.
String	getId() Returns the message's unique identifier.
String	getTitle() Returns the message's title, a string specifying the primary text of an message.
String	getTitleId() Returns the message's title ID, a string specifying the title template message ID in the accompanying gadget specification.
void	setBody(String body) Sets the message's body, a string specifying an optional expanded version of an message
void	setBodyId(String bodyId) Sets the message's body ID, a string specifying the body template message ID in the accompanying gadget specification.
void	setMessageCollectionId(String messageCollectionId)
void	setRecipient(String recipient)
void	setTitle(String title) Sets the message's title, a string specifying the primary text of an message.
void	setTitleId(String titleId) Sets the message's title ID, a string specifying the title template message ID in the accompanying gadget specification.

Methods inherited from class org.opensocial.models.Model

addTemplateParameter, addToListField, getField, getFieldAsList, getFieldAsMap, getFieldAsString, getFieldNames, getTemplateParameter, hasField, isFieldMultikeyed, isFieldMultivalued, setField

Methods inherited from class org.json.simple.JSONObject

escape, toJSONString, toJSONString, toString, toString, writeJSONString, writeJSONString

Methods inherited from class java.util.HashMap

clear, clone, containsKey, containsValue, entrySet, get, isEmpty, keySet, put, putAll, remove, size, values

Methods inherited from class java.util.AbstractMap

equals, hashCode

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

clear, containsKey, containsValue, entrySet, equals, get, hashCode, isEmpty, keySet, put, putAll, remove, size, values

Constructor Detail

Message

public Message()

Method Detail

getId

public String getId()

Returns the message's unique identifier.

getBody

public String getBody()

Returns the message's body, a string specifying an optional expanded version of an message.

getBodyId

public String getBodyId()

Returns the message's body ID, a string specifying the body template message ID in the accompanying gadget specification.

getTitle

public String getTitle()

Returns the message's title, a string specifying the primary text of an message.

getTitleId

public String getTitleId()

Returns the message's title ID, a string specifying the title template message ID in the accompanying gadget specification.

setBody

public void setBody(String body)

Sets the message's body, a string specifying an optional expanded version of an message

Parameters:

body - body to set

setBodyId

public void setBodyId(String bodyId)

Sets the message's body ID, a string specifying the body template message ID in the accompanying gadget specification.

Parameters:

bodyId - body ID to set

setTitle

public void setTitle(String title)

Sets the message's title, a string specifying the primary text of an message.

Parameters:

title - title to set

setTitleId

public void setTitleId(String titleId)

Sets the message's title ID, a string specifying the title template message ID in the accompanying gadget specification.

Parameters:

titleId - title ID to set

setMessageCollectionId

public void setMessageCollectionId(String messageCollectionId)

setRecipient

public void setRecipient(String recipient)