Opensocial.Album (v0.9)

From OpenSocial

opensocial.Album

Class for Album features.

Methods

opensocial.Album.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

opensocial.Album.setField

setField(key, data)

Parameters

Name	Type	Description
key	String	The key to set data for
data	String	The data to set

Description

opensocial.Album.Field

All of the fields that albums can have. It is only required to set ID. Other possible fields to set are: THUMBNAIL_URL, TITLE, DESCRIPTION, LOCATION, OWNER_ID, MEDIA_TYPE, MEDIA_MIME_TYPE, MEDIA_ITEM_COUNT. See also: opensocial.Album.getField()

opensocial.Album.Field.DESCRIPTION

string, description of the album. May be used interchangeably with the string 'description'.

opensocial.Album.Field.ID

string, unique identifier for the album. May be used interchangeably with the string 'id'.

opensocial.Album.Field.LOCATION

opensocial.Address, location corresponding to the album. May be used interchangeably with the string 'location'.

opensocial.Album.Field.MEDIA_ITEM_COUNT

integer, number of items in the album. May be used interchangeably with the string 'mediaItemCount'.

opensocial.Album.Field.MEDIA_MIME_TYPE

array of strings identifying the mime-types of media items in the Album. May be used interchangeably with the string 'mediaMimeType'.

opensocial.Album.Field.MEDIA_TYPE

array of MediaItem.TYPE, types of MediaItems in the Album. May be used interchangeably with the string 'mediaType'.

opensocial.Album.Field.OWNER_ID

string, ID of the owner of the album. May be used interchangeably with the string 'ownerId'.

opensocial.Album.Field.THUMBNAIL_URL

string, URL to a thumbnail cover of the album. May be used interchangeably with the string 'thumbnailUrl'.

opensocial.Album.Field.TITLE

string, the title of the album. May be used interchangeably with the string 'title'.

Category: Pages lacking example code