com.box.androidsdk.content

Class BoxApiCollaboration

java.lang.Object

com.box.androidsdk.content.BoxApi

com.box.androidsdk.content.BoxApiCollaboration

public class BoxApiCollaboration
extends BoxApi

Represents the API of the collaboration 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
BoxApiCollaboration(BoxSession session) Constructs a BoxApiCollaboration with the provided BoxSession

Method Summary

Modifier and Type	Method and Description
protected BoxCollaborationItem	createStubItem(BoxCollaborationItem collaborationItem)
BoxRequestsShare.AddCollaboration	getAddRequest(BoxCollaborationItem collaborationItem, BoxCollaboration.Role role, BoxCollaborator collaborator) A request that adds a user or group as a collaborator to an item.
BoxRequestsShare.AddCollaboration	getAddRequest(BoxCollaborationItem collaborationItem, BoxCollaboration.Role role, java.lang.String login) A request that adds a user as a collaborator to an item by using their login.
BoxRequestsShare.AddCollaboration	getAddRequest(java.lang.String folderId, BoxCollaboration.Role role, BoxCollaborator collaborator) Deprecated.
BoxRequestsShare.AddCollaboration	getAddRequest(java.lang.String folderId, BoxCollaboration.Role role, java.lang.String login) Deprecated.
BoxRequestsShare.AddCollaboration	getAddToFileRequest(java.lang.String fileId, BoxCollaboration.Role role, BoxCollaborator collaborator) A request that adds a user or group as a collaborator to a file.
BoxRequestsShare.AddCollaboration	getAddToFileRequest(java.lang.String fileId, BoxCollaboration.Role role, java.lang.String login) A request that adds a user as a collaborator to a file by using their login.
BoxRequestsShare.AddCollaboration	getAddToFolderRequest(java.lang.String folderId, BoxCollaboration.Role role, BoxCollaborator collaborator) A request that adds a user or group as a collaborator to a folder.
BoxRequestsShare.AddCollaboration	getAddToFolderRequest(java.lang.String folderId, BoxCollaboration.Role role, java.lang.String login) A request that adds a user as a collaborator to a folder by using their login.
protected java.lang.String	getCollaborationInfoUrl(java.lang.String id) Gets the URL for collaboration information
protected java.lang.String	getCollaborationsUrl() Gets the URL for collaborations
BoxRequestsShare.DeleteCollaboration	getDeleteRequest(java.lang.String collaborationId) A request to delete a collaboration with given collaboration id.
BoxRequestsShare.GetCollaborationInfo	getInfoRequest(java.lang.String collaborationId) A request to retrieve a collaboration of a given id.
BoxRequestsShare.GetPendingCollaborations	getPendingCollaborationsRequest() A request to retrieve a list of pending collaborations for the user.
BoxRequestsShare.UpdateOwner	getUpdateOwnerRequest(java.lang.String collaborationId) A request to change role to owner given a collaboration id.
BoxRequestsShare.UpdateCollaboration	getUpdateRequest(java.lang.String collaborationId) A request to update a collaboration given a collaboration id.

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

BoxApiCollaboration

public BoxApiCollaboration(BoxSession session)

Constructs a BoxApiCollaboration with the provided BoxSession

Parameters:

session - authenticated session to use with the BoxApiCollaboration

Method Detail

getCollaborationsUrl

protected java.lang.String getCollaborationsUrl()

Gets the URL for collaborations

Returns:

the collaboration URL

getCollaborationInfoUrl

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

Gets the URL for collaboration information

Parameters:

id - id of the collaboration

Returns:

the collaboration information URL

getInfoRequest

public BoxRequestsShare.GetCollaborationInfo getInfoRequest(java.lang.String collaborationId)

A request to retrieve a collaboration of a given id.

Parameters:

collaborationId - id of the collaboration to retrieve

Returns:

request to retrieve information about a collaboration

getAddRequest

@Deprecated
public BoxRequestsShare.AddCollaboration getAddRequest(java.lang.String folderId,
                                                                   BoxCollaboration.Role role,
                                                                   BoxCollaborator collaborator)

Deprecated.

A request that adds a user or group as a collaborator to a folder. Deprecated use getAddToFolderRequest(BoxCollaborationItem collaborationItem, BoxCollaboration.Role role, String login)

Parameters:

folderId - id of the folder to be collaborated.

role - role of the collaboration

collaborator - the user or group to add as a collaborator

Returns:

request to add/create a collaboration

getAddToFolderRequest

public BoxRequestsShare.AddCollaboration getAddToFolderRequest(java.lang.String folderId,
                                                               BoxCollaboration.Role role,
                                                               BoxCollaborator collaborator)

A request that adds a user or group as a collaborator to a folder.

Parameters:

folderId - id of the folder to be collaborated.

role - role of the collaboration

collaborator - the user or group to add as a collaborator

Returns:

request to add/create a collaboration

getAddToFileRequest

public BoxRequestsShare.AddCollaboration getAddToFileRequest(java.lang.String fileId,
                                                             BoxCollaboration.Role role,
                                                             BoxCollaborator collaborator)

A request that adds a user or group as a collaborator to a file.

Parameters:

fileId - id of the file to be collaborated.

role - role of the collaboration

collaborator - the user or group to add as a collaborator

Returns:

request to add/create a collaboration

getAddRequest

public BoxRequestsShare.AddCollaboration getAddRequest(BoxCollaborationItem collaborationItem,
                                                       BoxCollaboration.Role role,
                                                       BoxCollaborator collaborator)

A request that adds a user or group as a collaborator to an item.

Parameters:

collaborationItem - item to be collaborated.

role - role of the collaboration

collaborator - the user or group to add as a collaborator

Returns:

request to add/create a collaboration

createStubItem

protected BoxCollaborationItem createStubItem(BoxCollaborationItem collaborationItem)

getAddRequest

@Deprecated
public BoxRequestsShare.AddCollaboration getAddRequest(java.lang.String folderId,
                                                                   BoxCollaboration.Role role,
                                                                   java.lang.String login)

Deprecated.

Deprecated use getAddToFolderRequest(BoxCollaborationItem collaborationItem, BoxCollaboration.Role role, String login)

Parameters:

folderId - id of the folder to be collaborated.

role - role of the collaboration

login - email address of the user to add

Returns:

request to add/create a collaboration

getAddToFolderRequest

public BoxRequestsShare.AddCollaboration getAddToFolderRequest(java.lang.String folderId,
                                                               BoxCollaboration.Role role,
                                                               java.lang.String login)

A request that adds a user as a collaborator to a folder by using their login.

Parameters:

folderId - id of the folder to be collaborated.

role - role of the collaboration

login - email address of the user to add

Returns:

request to add/create a collaboration

getAddToFileRequest

public BoxRequestsShare.AddCollaboration getAddToFileRequest(java.lang.String fileId,
                                                             BoxCollaboration.Role role,
                                                             java.lang.String login)

A request that adds a user as a collaborator to a file by using their login.

Parameters:

fileId - id of the file to be collaborated.

role - role of the collaboration

login - email address of the user to add

Returns:

request to add/create a collaboration

getAddRequest

public BoxRequestsShare.AddCollaboration getAddRequest(BoxCollaborationItem collaborationItem,
                                                       BoxCollaboration.Role role,
                                                       java.lang.String login)

A request that adds a user as a collaborator to an item by using their login.

Parameters:

collaborationItem - item to be collaborated.

role - role of the collaboration

login - email address of the user to add

Returns:

request to add/create a collaboration

getPendingCollaborationsRequest

public BoxRequestsShare.GetPendingCollaborations getPendingCollaborationsRequest()

A request to retrieve a list of pending collaborations for the user.

Returns:

request to retrieve pending collaborations.

getDeleteRequest

public BoxRequestsShare.DeleteCollaboration getDeleteRequest(java.lang.String collaborationId)

A request to delete a collaboration with given collaboration id.

Parameters:

collaborationId - id of the collaboration to delete

Returns:

request to delete a collaboration

getUpdateRequest

public BoxRequestsShare.UpdateCollaboration getUpdateRequest(java.lang.String collaborationId)

A request to update a collaboration given a collaboration id. Note this request itself will not update collaboration. In order to update you will need to call the methods in UpdateCollaboration class. e.g., to update the collaboration role, call setNewRole() method after getting the request; to update the collaboration status, call setNewStatus after getting the request.

Parameters:

collaborationId - id of the collaboration to update

Returns:

request to update a collaboration

getUpdateOwnerRequest

public BoxRequestsShare.UpdateOwner getUpdateOwnerRequest(java.lang.String collaborationId)

A request to change role to owner given a collaboration id.

Parameters:

collaborationId - id of the collaboration to update

Returns:

request to update role to owner for a collaboration