com.google.gwt.gadgets.client.osapi.mediaitems
Class GetMediaItemsRequestBuilder

java.lang.Object
  com.google.gwt.core.client.JavaScriptObject
      com.google.gwt.gadgets.client.osapi.OsapiRequestBuilder<T>
          com.google.gwt.gadgets.client.osapi.CollectionRequestBuilder<GetMediaItemsRequestBuilder>
              com.google.gwt.gadgets.client.osapi.mediaitems.GetMediaItemsRequestBuilder

public class GetMediaItemsRequestBuilder
extends CollectionRequestBuilder<GetMediaItemsRequestBuilder>

Builder for requests returning OsapiCollection of MediaItem.

Constructor Summary

protected

GetMediaItemsRequestBuilder() Required by JavaScriptObject policy.

Method Summary

OsapiRequest<OsapiCollection<MediaItem>>	build() Builds the request.
GetMediaItemsRequestBuilder	setAlbumId(java.lang.String albumId) Sets the ID of the album whose MediaItems are to be returned.
GetMediaItemsRequestBuilder	setIds(java.lang.String... ids) Sets a list of MediaItem IDs specifying the MediaItems to retrieve.

Methods inherited from class com.google.gwt.gadgets.client.osapi.CollectionRequestBuilder

setContainsFilter, setCount, setEqualsFilter, setPresentFilter, setSorting, setStartIndex, setStartsWithFilter

Methods inherited from class com.google.gwt.gadgets.client.osapi.OsapiRequestBuilder

nativeSet, nativeSet, setGroupId, setUpdatedSince, setUserId

Methods inherited from class com.google.gwt.core.client.JavaScriptObject

cast, createArray, createFunction, createObject, equals, hashCode, toSource, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

GetMediaItemsRequestBuilder

protected GetMediaItemsRequestBuilder()

Required by JavaScriptObject policy.

Method Detail

build

public final OsapiRequest<OsapiCollection<MediaItem>> build()

Builds the request.

Returns:

OsapiRequest instance.

setAlbumId

public final GetMediaItemsRequestBuilder setAlbumId(java.lang.String albumId)

Sets the ID of the album whose MediaItems are to be returned. If no albumId is provided, then the container should return media items from all albums.

Parameters:

albumId - The ID of the album whose MediaItems are to be returned.

setIds

public final GetMediaItemsRequestBuilder setIds(java.lang.String... ids)

Sets a list of MediaItem IDs specifying the MediaItems to retrieve.

Parameters:

ids - IDs specifying the MediaItems to retrieve.