NeedsExamples
opensocial.MessageCollection
Class for MessageCollection features.
Methods
opensocial.MessageCollection.getField
;String getField(key, opt_params)
Parameters
NameTypeDescription |
Returns
TypeDescription |
String |
The data |
Description
Gets the MessageCollection data that's associated with the specified key.
opensocial.MessageCollection.setField
;setField(key, data)
Parameters
NameTypeDescription |
key |
String |
The key to set data for |
data |
String |
The data to set |
Description
Sets data for this album associated with the given key.
opensocial.MessageCollection.Field
All of the fields that a MessageCollection can have. It is only required to set ID. See also: opensocial.MessageCollection.getField()
opensocial.MessageCollection.Field.ID
string, unique ID for this message collection. May be used interchangeably with the string 'id'.
opensocial.MessageCollection.Field.TITLE
<static> Member of: opensocial.MessageCollection.Field.TITLE string, the title of the MessageCollection. May be used interchangeably with the string 'title'.
opensocial.MessageCollection.Field.TOTAL
<static> Member of: opensocial.MessageCollection.Field.TOTAL int, total number of messages in this group. May be used interchangeably with the string 'total'.
opensocial.MessageCollection.Field.UNREAD
<static> Member of: opensocial.MessageCollection.Field.UNREAD int, number of unread messages in this group. May be used interchangeably with the string 'unread'.
opensocial.MessageCollection.Field.UPDATED
<static> Member of: opensocial.MessageCollection.Field.UPDATED string, last datetime update for this message collection. May be used interchangeably with the string 'updated'.
opensocial.MessageCollection.Field.URLS
opensocial.Url, List of related URLs for this message collection. Supported URL types include: 1. icon: icon for this mailbox 2. alternate: alternate form for this mailbox (text/html being the most common) May be used interchangeably with the string 'urls'.
{{ JsApiAlphaList_(v0.9) }}