com.box.androidsdk.content.requests

Class BoxRequestsShare.UpdateCollaboration

java.lang.Object

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

com.box.androidsdk.content.requests.BoxRequestsShare.UpdateCollaboration

All Implemented Interfaces:

java.io.Serializable

Enclosing class:

BoxRequestsShare

public static class BoxRequestsShare.UpdateCollaboration
extends BoxRequest<BoxCollaboration,BoxRequestsShare.UpdateCollaboration>

Request for updating 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
UpdateCollaboration(java.lang.String collaborationId, java.lang.String requestUrl, BoxSession session) Creates a request to update the collaboration with the default parameters

Method Summary

Modifier and Type	Method and Description
java.lang.String	getId() Returns the id of the collaboration being modified.
protected void	onSendCompleted(BoxResponse<BoxCollaboration> response) Post action that will be performed after a successful send occurs.
BoxRequestsShare.UpdateCollaboration	setNewRole(BoxCollaboration.Role newRole) Sets the new role for the collaboration to be updated in the request
BoxRequestsShare.UpdateCollaboration	setNewStatus(java.lang.String status) Sets the status of the collaboration to be updated in the request

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

UpdateCollaboration

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

Creates a request to update the collaboration with the default parameters

Parameters:

collaborationId - id of the collaboration to update

requestUrl - URL of the update 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 modified.

Returns:

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

setNewRole

public BoxRequestsShare.UpdateCollaboration setNewRole(BoxCollaboration.Role newRole)

Sets the new role for the collaboration to be updated in the request

Parameters:

newRole - role to update the collaboration to

Returns:

request with the updated collaboration role

setNewStatus

public BoxRequestsShare.UpdateCollaboration setNewStatus(java.lang.String status)

Sets the status of the collaboration to be updated in the request

Parameters:

status - new status for the collaboration. This can be set to 'accepted' or 'rejected' by the 'accessible_by' user if the status is 'pending'

Returns:

request with the updated collaboration status

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.UpdateCollaboration>

Parameters:

response - response of the BoxRequest

Throws:

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