com.box.androidsdk.content.requests

Class BoxRequestsShare.GetCollaborationInfo

java.lang.Object

com.box.androidsdk.content.requests.BoxRequest<BoxCollaboration,BoxRequestsShare.GetCollaborationInfo>

com.box.androidsdk.content.requests.BoxRequestsShare.GetCollaborationInfo

All Implemented Interfaces:

BoxCacheableRequest<BoxCollaboration>, java.io.Serializable

Enclosing class:

BoxRequestsShare

public static class BoxRequestsShare.GetCollaborationInfo
extends BoxRequest<BoxCollaboration,BoxRequestsShare.GetCollaborationInfo>
implements BoxCacheableRequest<BoxCollaboration>

Request for retrieving information on a collaboration

See Also:

Serialized Form

Nested Class Summary

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

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

Field Summary

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

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

Constructor Summary

Constructors

Constructor and Description
GetCollaborationInfo(java.lang.String collaborationId, java.lang.String requestUrl, BoxSession session) Creates a request to get a collaboration with the default parameters

Method Summary

Modifier and Type	Method and Description
java.lang.String	getId() Returns the id of the collaboration being retrieved.
protected void	onSendCompleted(BoxResponse<BoxCollaboration> response) Post action that will be performed after a successful send occurs.
BoxCollaboration	sendForCachedResult() Sends the request to fetch results from cache synchronously.
BoxFutureTask<BoxCollaboration>	toTaskForCachedResult() Converts the request to a BoxCacheFutureTask that can be used to execute the request asynchronously.

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

buildUrl, createHeaderMap, createHttpRequest, createQuery, equals, getIfMatchEtag, getIfNoneMatchEtag, getRequestHandler, getSession, getSocket, getStringBody, handleSendForCachedResult, handleToTaskForCachedResult, handleUpdateCache, hashCode, importRequestContentMapsFrom, logDebug, logRequest, onSend, parseHashMapEntry, parseJsonObject, send, sendRequest, setBody, setContentType, setHeaders, setIfMatchEtag, setIfNoneMatchEtag, setRequestHandler, setTimeOut, toTask

Methods inherited from class java.lang.Object

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

Constructor Detail

GetCollaborationInfo

public GetCollaborationInfo(java.lang.String collaborationId,
                            java.lang.String requestUrl,
                            BoxSession session)

Creates a request to get a collaboration with the default parameters

Parameters:

collaborationId - id of the collaboration to retrieve information of

requestUrl - URL of the collaboration endpoint

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

Method Detail

getId

public java.lang.String getId()

Returns the id of the collaboration being retrieved.

Returns:

the id of the collaboration that this request is attempting to retrieve.

onSendCompleted

protected void onSendCompleted(BoxResponse<BoxCollaboration> response)
                        throws BoxException

Description copied from class: BoxRequest

Post action that will be performed after a successful send occurs. Example useage would include updating the cache after a request is made

Overrides:

onSendCompleted in class BoxRequest<BoxCollaboration,BoxRequestsShare.GetCollaborationInfo>

Parameters:

response - response of the BoxRequest

Throws:

BoxException - thrown if there was a problem with handling the request.

sendForCachedResult

public BoxCollaboration sendForCachedResult()
                                     throws BoxException

Description copied from interface: BoxCacheableRequest

Sends the request to fetch results from cache synchronously.

Specified by:

sendForCachedResult in interface BoxCacheableRequest<BoxCollaboration>

Returns:

the cached results of the request

Throws:

BoxException - thrown if there is no implementation of BoxCache set in BoxConfig, or if there was another issue getting cached results.

toTaskForCachedResult

public BoxFutureTask<BoxCollaboration> toTaskForCachedResult()
                                                      throws BoxException

Description copied from interface: BoxCacheableRequest

Converts the request to a BoxCacheFutureTask that can be used to execute the request asynchronously.

Specified by:

toTaskForCachedResult in interface BoxCacheableRequest<BoxCollaboration>

Returns:

a task that will fetch the results from the cache

Throws:

BoxException - thrown if there is no implementation of BoxCache set in BoxConfig.