org.opensocial.services

Class AlbumsService

java.lang.Object

org.opensocial.services.Service

org.opensocial.services.AlbumsService

public class AlbumsService
extends Service

OpenSocial API class for album requests; contains static methods for fetching, creating, updating and deleting albums (collections of media items).

Author:

Jason Cooper

Field Summary

Fields inherited from class org.opensocial.services.Service

APP, FRIENDS, ME, SELF, VIEWER

Constructor Summary

Constructors

Constructor and Description
AlbumsService()

Method Summary

Methods

Modifier and Type	Method and Description
static Request	createAlbum(Album album) Returns a new Request instance which, when submitted, creates a new album in the current viewer's library.
static Request	deleteAlbum(String albumId) Returns a new Request instance which, when submitted, deletes an existing album from the current viewer's library.
static Request	getAlbum(String albumId) Returns a new Request instance which, when submitted, fetches the specified album and makes this data available as an Album object.
static Request	getAlbums() Returns a new Request instance which, when submitted, fetches the current viewer's albums and makes this data available as a List of Album objects.
static Request	updateAlbum(Album album) Returns a new Request instance which, when submitted, updates an existing album in the current viewer's library.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AlbumsService

public AlbumsService()

Method Detail

getAlbums

public static Request getAlbums()

Returns a new Request instance which, when submitted, fetches the current viewer's albums and makes this data available as a List of Album objects.

Returns:

new Request object to fetch the current viewer's albums

See Also:

Album

getAlbum

public static Request getAlbum(String albumId)

Returns a new Request instance which, when submitted, fetches the specified album and makes this data available as an Album object.

Parameters:

albumId - ID of album to fetch

Returns:

new Request object to fetch the specified album

See Also:

Album

createAlbum

public static Request createAlbum(Album album)

Returns a new Request instance which, when submitted, creates a new album in the current viewer's library.

Parameters:

album - Album object specifying the album parameters to pass into the request; typically, caption and description are set

Returns:

new Request object to create a new album

updateAlbum

public static Request updateAlbum(Album album)
                           throws RequestException

Returns a new Request instance which, when submitted, updates an existing album in the current viewer's library.

Parameters:

album - Album object specifying the album parameters to pass into the request; id must be set in order to specify which album to update and values associated with any other property, e.g. caption and description, are updated

Returns:

new Request object to update an existing album

Throws:

RequestException - if the passed Album object does not have an id property set

deleteAlbum

public static Request deleteAlbum(String albumId)

Returns a new Request instance which, when submitted, deletes an existing album from the current viewer's library.

Parameters:

albumId - ID of album to delete

Returns:

new Request object to delete an existing album