org.opensocial.models.myspace

Class Notification

java.lang.Object

java.util.AbstractMap<K,V>

java.util.HashMap

org.json.simple.JSONObject

org.opensocial.models.Model

org.opensocial.models.myspace.Notification

All Implemented Interfaces:

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

public class Notification
extends Model

MySpace OpenSocial model class representing a MySpace notification. For reference: http://developerwiki.myspace.com/index.php?title=OpenSocial_v0.9_Notifications

Author:

Jason Cooper

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
Notification()

Method Summary

Methods

Modifier and Type	Method and Description
void	addMediaItem(MediaItem item) Adds the passed media item to the list of media items (i.e. images) to post with the notification.
void	addRecipient(String id) Adds the specified user to the list of users that will receive the notification.
void	setContent(String content) Sets the notification's content as a template parameter; the passed string can contain tokens such as ${recipient} which are substituted for appropriate values when the content is rendered.

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

Notification

public Notification()

Method Detail

setContent

public void setContent(String content)

Sets the notification's content as a template parameter; the passed string can contain tokens such as ${recipient} which are substituted for appropriate values when the content is rendered.

Parameters:

content - content to set; can contain template "tokens" of the form ${token}, the values of which are substituted when the content block is rendered

addRecipient

public void addRecipient(String id)

Adds the specified user to the list of users that will receive the notification.

Parameters:

id - OpenSocial ID of user to receive notification

addMediaItem

public void addMediaItem(MediaItem item)

Adds the passed media item to the list of media items (i.e. images) to post with the notification.

Parameters:

item - media item, i.e. image, to post with the notification