com.box.androidsdk.content

Class BoxApiCollection

java.lang.Object

com.box.androidsdk.content.BoxApi

com.box.androidsdk.content.BoxApiCollection

public class BoxApiCollection
extends BoxApi

Represents the API of the collections endpoint on Box. This class can be used to generate request objects for each of the APIs exposed endpoints

Field Summary

Fields inherited from class com.box.androidsdk.content.BoxApi

mBaseUploadUri, mBaseUri, mSession

Constructor Summary

Constructors

Constructor and Description
BoxApiCollection(BoxSession session) Constructs a BoxApiCollection with the provided BoxSession

Method Summary

Modifier and Type	Method and Description
protected java.lang.String	getCollectionItemsUrl(java.lang.String id) Gets the URL for getting the items of a collection
BoxRequestsCollections.GetCollections	getCollectionsRequest() Gets a request that gets the collections belonging to the user
protected java.lang.String	getCollectionsUrl() Gets the URL for getting the available collections
BoxRequestsCollections.GetCollectionItems	getItemsRequest(java.lang.String id) Gets a request that gets the items of a collection

Methods inherited from class com.box.androidsdk.content.BoxApi

getBaseUploadUri, getBaseUri

Methods inherited from class java.lang.Object

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

Constructor Detail

BoxApiCollection

public BoxApiCollection(BoxSession session)

Constructs a BoxApiCollection with the provided BoxSession

Parameters:

session - authenticated session to use with the BoxApiCollection

Method Detail

getCollectionsUrl

protected java.lang.String getCollectionsUrl()

Gets the URL for getting the available collections

Returns:

the URL string for getting the available collections

getCollectionItemsUrl

protected java.lang.String getCollectionItemsUrl(java.lang.String id)

Gets the URL for getting the items of a collection

Parameters:

id - the unique id associated with the item.

Returns:

the URL string for getting a collections items

getCollectionsRequest

public BoxRequestsCollections.GetCollections getCollectionsRequest()

Gets a request that gets the collections belonging to the user

Returns:

request to get collections belonging to the user

getItemsRequest

public BoxRequestsCollections.GetCollectionItems getItemsRequest(java.lang.String id)

Gets a request that gets the items of a collection

Parameters:

id - id of collection to retrieve items of

Returns:

request to get a collections items