com.box.androidsdk.content.requests

Class BoxRequestsShare.AddCollaboration

java.lang.Object

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

com.box.androidsdk.content.requests.BoxRequestsShare.AddCollaboration

All Implemented Interfaces:

java.io.Serializable

Enclosing class:

BoxRequestsShare

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

Request for adding 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

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ERROR_CODE_USER_ALREADY_COLLABORATOR

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
AddCollaboration(java.lang.String url, java.lang.String folderId, BoxCollaboration.Role role, BoxCollaborator collaborator, BoxSession session) Adds a user or group to a folder as a collaborator.
AddCollaboration(java.lang.String url, java.lang.String folderId, BoxCollaboration.Role role, java.lang.String userEmail, BoxSession session) Adds a user by email to a folder as a collaborator.

Method Summary

Modifier and Type	Method and Description
BoxCollaborator	getAccessibleBy() Gets the collaborator that the folder will be accessible by
java.lang.String	getFolderId() Returns the id of the folder collaborations are being added to.
BoxRequestsShare.AddCollaboration	notifyCollaborators(boolean notify) Determines if the user, (or all the users in the group) should receive email notification of the collaboration.
protected void	onSendCompleted(BoxResponse<BoxCollaboration> response) Post action that will be performed after a successful send occurs.

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

Field Detail

ERROR_CODE_USER_ALREADY_COLLABORATOR

public static final java.lang.String ERROR_CODE_USER_ALREADY_COLLABORATOR

See Also:

Constant Field Values

Constructor Detail

AddCollaboration

public AddCollaboration(java.lang.String url,
                        java.lang.String folderId,
                        BoxCollaboration.Role role,
                        java.lang.String userEmail,
                        BoxSession session)

Adds a user by email to a folder as a collaborator.

Parameters:

url - the url for the add collaboration request

folderId - id of the folder to be collaborated.

role - role of the collaboration

userEmail - login email of the user who this collaboration applies to, use null if this is a group or you already supplied a accessibleById.

session - session to use for the add collaboration request

AddCollaboration

public AddCollaboration(java.lang.String url,
                        java.lang.String folderId,
                        BoxCollaboration.Role role,
                        BoxCollaborator collaborator,
                        BoxSession session)

Adds a user or group to a folder as a collaborator.

Parameters:

url - the url for the add collaboration request

folderId - id of the folder to be collaborated.

role - role of the collaboration

collaborator - the user or group to add to the folder as a collaborator

session - session to use for the add collaboration request

Method Detail

notifyCollaborators

public BoxRequestsShare.AddCollaboration notifyCollaborators(boolean notify)

Determines if the user, (or all the users in the group) should receive email notification of the collaboration.

Parameters:

notify - whether or not to notify the collaborators via email about the collaboration.

Returns:

an updated request

getFolderId

public java.lang.String getFolderId()

Returns the id of the folder collaborations are being added to.

Returns:

the id of the folder that this request is attempting to add collaborations to.

getAccessibleBy

public BoxCollaborator getAccessibleBy()

Gets the collaborator that the folder will be accessible by

Returns:

collaborator that can access the folder

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

Parameters:

response - response of the BoxRequest

Throws:

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