com.box.androidsdk.content.requests

Class BoxRequestsCollections.GetCollections

java.lang.Object

com.box.androidsdk.content.requests.BoxRequest<E,R>

com.box.androidsdk.content.requests.BoxRequestItem<E,R>

com.box.androidsdk.content.requests.BoxRequestsCollections.GetCollections

Enclosing class:

BoxRequestsCollections

public static class BoxRequestsCollections.GetCollections
extends BoxRequestItem<E,R>

Request to get the available collections.

Nested Class Summary

Nested classes/interfaces inherited from class com.box.androidsdk.content.requests.BoxRequest

BoxRequest.BoxRequestHandler<R extends BoxRequest>, BoxRequest.ContentTypes, BoxRequest.Methods

Field Summary

Fields inherited from class com.box.androidsdk.content.requests.BoxRequestItem

mId

Fields inherited from class com.box.androidsdk.content.requests.BoxRequest

JSON_OBJECT, mBodyMap, mContentType, mHeaderMap, mListener, mQueryMap, mRequestMethod, mRequestUrlString, mSession

Constructor Summary

Constructors

Constructor and Description
GetCollections(java.lang.String collectionsUrl, BoxSession session) Creates a get collections request with the default parameters.

Method Summary

Modifier and Type	Method and Description
R	setLimit(int limit) Sets the limit of items that should be returned
R	setOffset(int offset) Sets the offset of the items that should be returned

Methods inherited from class com.box.androidsdk.content.requests.BoxRequestItem

getId, setFields

Methods inherited from class com.box.androidsdk.content.requests.BoxRequest

buildUrl, createHttpRequest, createQuery, getIfMatchEtag, getIfNoneMatchEtag, getRequestHandler, getSession, getStringBody, importRequestContentMapsFrom, logDebug, logRequest, parseHashMapEntry, parseJsonObject, send, setBody, setContentType, setHeaders, setIfMatchEtag, setIfNoneMatchEtag, setRequestHandler, setTimeOut, toTask

Methods inherited from class java.lang.Object

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

Constructor Detail

GetCollections

public GetCollections(java.lang.String collectionsUrl,
                      BoxSession session)

Creates a get collections request with the default parameters.

Parameters:

collectionsUrl - URL of the collections endpoint.

session - the authenticated session that will be used to make the request with.

Method Detail

setLimit

public R setLimit(int limit)

Sets the limit of items that should be returned

Parameters:

limit - limit of items to return

Returns:

the get folder items request

setOffset

public R setOffset(int offset)

Sets the offset of the items that should be returned

Parameters:

offset - offset of items to return

Returns:

the offset of the items to return