The goog.ui.media.FlickrSetModel Class

goog.ui.media.FlickrSetModel
> goog.ui.media.MediaModel

goog.ui.media.FlickrSetModel(userId, setId, opt_caption, opt_description)

The {@code goog.ui.media.FlickrAlbum} media data model. It stores a required {@code userId} and {@code setId} fields, sets the flickr Set URL, and allows a few optional parameters.

userId {string}
The flickr userId associated with this set.
setId {string}
The flickr setId associated with this set.
opt_caption {string=}
An optional caption of the flickr set.
opt_description {string=}
An optional description of the flickr set.

.buildUrl(userId, setId)

Takes a flickr username and set id and returns an URL.

userId {string}
The owner of the set.
setId {string}
The set id.
returns {string}
The URL of the set.

.findCategoryWithScheme(scheme)

Inherited from goog.ui.media.MediaModel .

Finds the first category with the given scheme.

scheme {string}
The scheme to search for.
returns {goog.ui.media.MediaModel.Category}
The category that has the given scheme. May be null.

.findCreditsWithRole(role)

Inherited from goog.ui.media.MediaModel .

Finds all credits with the given role.

role {string}
The role to search for.
returns {!Array.<!goog.ui.media.MediaModel.Credit>}
An array of credits with the given role. May be empty.

.getCaption()

Inherited from goog.ui.media.MediaModel .

Gets the caption of this media.

returns {string|undefined}
The caption of the media.

.getCategories()

Inherited from goog.ui.media.MediaModel .

Gets the categories of the media.

returns {Array.<goog.ui.media.MediaModel.Category>}
The categories of the media.

.getCredits()

Inherited from goog.ui.media.MediaModel .

Gets the credits of the media.

returns {!Array.<goog.ui.media.MediaModel.Credit>}
The credits of the media.

.getDescription()

Inherited from goog.ui.media.MediaModel .

Gets the description of this media.

returns {string|undefined}
The description of the media.

.getDuration()

Inherited from goog.ui.media.MediaModel .

Gets the duration of the media.

returns {number|undefined}
The duration in seconds.

.getHeight()

Inherited from goog.ui.media.MediaModel .

Gets the height of the media in pixels.

returns {number|undefined}
The height in pixels.

.getMedium()

Inherited from goog.ui.media.MediaModel .

Gets the media medium.

returns {goog.ui.media.MediaModel.Medium|undefined}
The media medium.

.getPlayer()

Inherited from goog.ui.media.MediaModel .

Gets the player data.

returns {goog.ui.media.MediaModel.Player|undefined}
The media player data.

.getSetId()

Gets the Flickr set id.

returns {string}
The Flickr set id.

.getSubTitles()

Inherited from goog.ui.media.MediaModel .

Gets the subtitles for the media.

returns {Array.<goog.ui.media.MediaModel.SubTitle>}
The subtitles.

.getThumbnails()

Inherited from goog.ui.media.MediaModel .

Gets the thumbnail urls.

returns {Array.<goog.ui.media.MediaModel.Thumbnail>}
The list of thumbnails.

.getType()

Inherited from goog.ui.media.MediaModel .

Gets the media mime type.

returns {goog.ui.media.MediaModel.MimeType|undefined}
The media mime type.

.getUrl()

Inherited from goog.ui.media.MediaModel .

Gets the URL of this media.

returns {string|undefined}
The URL of the media.

.getUserId()

Gets the Flickr user id.

returns {string}
The Flickr user id.

.getWidth()

Inherited from goog.ui.media.MediaModel .

Gets the width of the media in pixels.

returns {number|undefined}
The width in pixels.

.newInstance(flickrSetUrl, opt_caption, opt_description)

Takes a {@code flickrSetUrl} and extracts the flickr username and set id.

flickrSetUrl {string}
A Flickr set URL.
opt_caption {string=}
An optional caption of the flickr set.
opt_description {string=}
An optional description of the flickr set.
returns {goog.ui.media.FlickrSetModel}
The data model that represents the Flickr set.
@throws
exception in case the parsing fails

.setCaption(caption)

Inherited from goog.ui.media.MediaModel .

Sets the caption of this media.

caption {string}
The caption of the media.
returns {!goog.ui.media.MediaModel}
The object itself, used for chaining.

.setCategories(categories)

Inherited from goog.ui.media.MediaModel .

Sets the categories of the media

categories {Array.<goog.ui.media.MediaModel.Category>}
The categories of the media.
returns {!goog.ui.media.MediaModel}
The object itself, used for chaining.

.setCredits(credits)

Inherited from goog.ui.media.MediaModel .

Sets the credits of the media

credits {!Array.<goog.ui.media.MediaModel.Credit>}
The credits of the media.
returns {!goog.ui.media.MediaModel}
The object itself, used for chaining.

.setDescription(description)

Inherited from goog.ui.media.MediaModel .

Sets the description of this media.

description {string}
The description of the media.
returns {!goog.ui.media.MediaModel}
The object itself, used for chaining.

.setDuration(duration)

Inherited from goog.ui.media.MediaModel .

Sets duration of the media.

duration {number}
The duration of the media, in seconds.
returns {!goog.ui.media.MediaModel}
The object itself, used for chaining.

.setHeight(height)

Inherited from goog.ui.media.MediaModel .

Sets the height of the media.

height {number}
The height of the media, in pixels.
returns {!goog.ui.media.MediaModel}
The object itself, used for chaining.

.setMedium(medium)

Inherited from goog.ui.media.MediaModel .

Sets the media medium.

medium {goog.ui.media.MediaModel.Medium}
The media medium.
returns {!goog.ui.media.MediaModel}
The object itself, used for chaining.

.setPlayer(player)

Inherited from goog.ui.media.MediaModel .

Sets the player data.

player {goog.ui.media.MediaModel.Player}
The media player data.
returns {!goog.ui.media.MediaModel}
The object itself, used for chaining.

.setSubTitles(subtitles)

Inherited from goog.ui.media.MediaModel .

Sets the subtitles for the media

subtitles {Array.<goog.ui.media.MediaModel.SubTitle>}
The subtitles.
returns {!goog.ui.media.MediaModel}
The object itself.

.setThumbnails(thumbnails)

Inherited from goog.ui.media.MediaModel .

Sets the thumbnail list.

thumbnails {Array.<goog.ui.media.MediaModel.Thumbnail>}
The list of thumbnail.
returns {!goog.ui.media.MediaModel}
The object itself, used for chaining.

.setType(type)

Inherited from goog.ui.media.MediaModel .

Sets the media mime type.

type {goog.ui.media.MediaModel.MimeType}
The media mime type.
returns {!goog.ui.media.MediaModel}
The object itself, used for chaining.

.setUrl(url)

Inherited from goog.ui.media.MediaModel .

Sets the URL of this media.

url {string}
The URL of the media.
returns {!goog.ui.media.MediaModel}
The object itself, used for chaining.

.setWidth(width)

Inherited from goog.ui.media.MediaModel .

Sets the width of the media.

width {number}
The width of the media, in pixels.
returns {!goog.ui.media.MediaModel}
The object itself, used for chaining.

Documentation generated using JvJsDoc, version 0.5 on 2012-09-03.