org.opensocial.services

Class MediaItemsService

java.lang.Object

org.opensocial.services.Service

org.opensocial.services.MediaItemsService

public class MediaItemsService
extends Service

OpenSocial API class for media item requests; contains static methods for fetching, creating, updating and deleting media items (video, image, or sound files).

Author:

Jason Cooper

Field Summary

Fields inherited from class org.opensocial.services.Service

APP, FRIENDS, ME, SELF, VIEWER

Constructor Summary

Constructors

Constructor and Description
MediaItemsService()

Method Summary

Methods

Modifier and Type	Method and Description
static Request	createMediaItem(MediaItem item) Returns a new Request instance which, when submitted, creates a new media item in the specified viewer album.
static Request	deleteMediaItem(String itemId, String albumId) Returns a new Request instance which, when submitted, deletes an existing media item from the specified viewer album.
static Request	getMediaItem(String itemId, String albumId) Returns a new Request instance which, when submitted, fetches the specified media item from the specified album and makes this data available as a MediaItem object.
static Request	getMediaItems(String albumId) Returns a new Request instance which, when submitted, fetches the current viewer's media items from the specified album and makes this data available as a List of MediaItem objects.
static Request	getSupportedVideoCategories() Returns a new Request instance which, when submitted, fetches all video categories supported by the container and makes this data available as a JSON array of JSON objects; currently works with MySpace only.
static Request	updateMediaItem(MediaItem item) Returns a new Request instance which, when submitted, updates an existing media item contained within the specified viewer album.
static Request	uploadImage(MediaItem item, File content) Returns a new Request instance which, when submitted, uploads the specified image file as a new media item in the specified viewer album.
static Request	uploadVideo(MediaItem item, File content) Returns a new Request instance which, when submitted, uploads the specified video file as a new media item in the specified viewer album ("@videos" for MySpace).

Methods inherited from class java.lang.Object

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

Constructor Detail

MediaItemsService

public MediaItemsService()

Method Detail

getMediaItems

public static Request getMediaItems(String albumId)

Returns a new Request instance which, when submitted, fetches the current viewer's media items from the specified album and makes this data available as a List of MediaItem objects.

Parameters:

albumId - ID of album whose media item contents are to fetched

Returns:

new Request object to fetch the current viewer's media items

See Also:

MediaItem

getMediaItem

public static Request getMediaItem(String itemId,
                   String albumId)

Returns a new Request instance which, when submitted, fetches the specified media item from the specified album and makes this data available as a MediaItem object.

Parameters:

itemId - ID of media item to fetch

albumId - ID of album containing media item to fetch

Returns:

new Request object to fetch the specified media item

See Also:

MediaItem

getSupportedVideoCategories

public static Request getSupportedVideoCategories()

Returns a new Request instance which, when submitted, fetches all video categories supported by the container and makes this data available as a JSON array of JSON objects; currently works with MySpace only.

createMediaItem

public static Request createMediaItem(MediaItem item)
                               throws RequestException

Returns a new Request instance which, when submitted, creates a new media item in the specified viewer album.

Parameters:

item - MediaItem object specifying the media item parameters to pass into the request; album_id must be set and other properties, e.g. type and url, can also be set

Returns:

new Request object to create a new media item

Throws:

RequestException - if the passed MediaItem object does not have an album_id property set

uploadImage

public static Request uploadImage(MediaItem item,
                  File content)
                           throws RequestException,
                                  IOException

Returns a new Request instance which, when submitted, uploads the specified image file as a new media item in the specified viewer album.

Parameters:

item - MediaItem object specifying the media item parameters to pass into the request; album_id and mime_type must be set

content - local image file to be uploaded as a new media item

Returns:

new Request object to upload the specified image file as a new media item

Throws:

RequestException - if the passed MediaItem object does not have its album_id or mime_type properties set

IOException - if an I/O error occurs while reading the passed file

uploadVideo

public static Request uploadVideo(MediaItem item,
                  File content)
                           throws RequestException,
                                  IOException

Returns a new Request instance which, when submitted, uploads the specified video file as a new media item in the specified viewer album ("@videos" for MySpace). MySpace requires the caption, description, tags, msCategories, and language fields to be set for the passed MediaItem.

Parameters:

item - MediaItem object specifying the media item parameters to pass into the request; album_id and mime_type must be set, and MySpace also requires caption, description, tags, msCategories, and language

content - local video file to be uploaded as a new media item

Returns:

new Request object to upload the specified video file as a new media item

Throws:

RequestException - if the passed MediaItem object does not have its album_id or mime_type properties set

IOException - if an I/O error occurs while reading the passed file

updateMediaItem

public static Request updateMediaItem(MediaItem item)
                               throws RequestException

Returns a new Request instance which, when submitted, updates an existing media item contained within the specified viewer album.

Parameters:

item - MediaItem object specifying the media item parameters to pass into the request; id and album_id must be set in order to specify which media item to update and values associated with any other property, e.g. type and url, are updated

Returns:

new Request object to update an existing media item

Throws:

RequestException - if the passed MediaItem object does not have both id and album_id properties set

deleteMediaItem

public static Request deleteMediaItem(String itemId,
                      String albumId)

Returns a new Request instance which, when submitted, deletes an existing media item from the specified viewer album.

Parameters:

itemId - ID of media item to delete

albumId - ID of album containing media item to delete

Returns:

new Request object to delete an existing media item