Opensocial.MessageCollection (v0.9)

From VZ Developer Wiki
Jump to: navigation, search

This documentation is not completed yet and will be extended by more examples in future.

opensocial.MessageCollection

Class for MessageCollection features.

Methods

opensocial.MessageCollection.getField

String getField(key, opt_params)
Parameters
Name Type Description
key String The key to get data for; see the Field class for possible values
opt_params Map.<opensocial.DataRequest.DataRequestFields|Object> Additional params to pass to the request.
Returns
Type Description
String The data
Description
Gets the MessageCollection data that's associated with the specified key.

opensocial.MessageCollection.setField

setField(key, data)
Parameters
Name Type Description
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'.



OpenSocial (v0.9)

gadgets

gadgets.io

gadgets.json

gadgets.Prefs

gadgets.util

gadgets.views

gadgets.flash

gadgets.MiniMessage

gadgets.oauth.Popup

gadgets.rpc

gadgets.skins

gadgets.pubsub

gadgets.Tab

gadgets.TabSet

gadgets.window

gadgets.i18n

opensocial

opensocial.Activity

opensocial.Address

opensocial.Album

opensocial.BodyType

opensocial.Collection

opensocial.CreateActivityPriority

opensocial.DataRequest

opensocial.DataResponse

opensocial.Email

opensocial.Enum

opensocial.Environment

opensocial.EscapeType

opensocial.IdSpec

opensocial.MediaItem

opensocial.Message

opensocial.MessageCollection

opensocial.Name

opensocial.NavigationParameters

opensocial.Organization

opensocial.Permission

opensocial.Person

opensocial.Phone

opensocial.ResponseItem

opensocial.Url

osapi.Request

osapi.BatchRequest

osapi.people

osapi.activities

osapi.appdata

osapi.messages

osapi.http