Package org.apache.camel.component.box.api

Class BoxCollaborationsManager

java.lang.Object

org.apache.camel.component.box.api.BoxCollaborationsManager

public class BoxCollaborationsManager
extends Object

Box Collaborations Manager

Provides operations to manage Box collaborations.

Constructor Summary

Constructors

Constructor	Description
BoxCollaborationsManager(com.box.sdk.BoxAPIConnection boxConnection)	Create collaborations manager to manage the comments of Box connection's authenticated user.

Method Summary

Modifier and Type	Method	Description
com.box.sdk.BoxCollaboration	addFolderCollaboration(String folderId, com.box.sdk.BoxCollaborator collaborator, com.box.sdk.BoxCollaboration.Role role)	Add a collaboration to this folder.
com.box.sdk.BoxCollaboration	addFolderCollaborationByEmail(String folderId, String email, com.box.sdk.BoxCollaboration.Role role)	Add a collaboration to this folder.
void	deleteCollaboration(String collaborationId)	Delete collaboration.
com.box.sdk.BoxCollaboration.Info	getCollaborationInfo(String collaborationId)	Get collaboration information.
Collection<com.box.sdk.BoxCollaboration.Info>	getFolderCollaborations(String folderId)	Get information about all of the collaborations for folder.
Collection<com.box.sdk.BoxCollaboration.Info>	getPendingCollaborations()	Get all pending collaboration invites for the current user.
com.box.sdk.BoxCollaboration	updateCollaborationInfo(String collaborationId, com.box.sdk.BoxCollaboration.Info info)	Update collaboration information.

Methods inherited from class java.lang.Object

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

Constructor Detail

BoxCollaborationsManager

public BoxCollaborationsManager(com.box.sdk.BoxAPIConnection boxConnection)

Create collaborations manager to manage the comments of Box connection's authenticated user.

Parameters:

boxConnection - - Box connection to authenticated user account.

Method Detail

getFolderCollaborations

public Collection<com.box.sdk.BoxCollaboration.Info> getFolderCollaborations(String folderId)

Get information about all of the collaborations for folder.

Parameters:

folderId - the folder id.

addFolderCollaboration

public com.box.sdk.BoxCollaboration addFolderCollaboration(String folderId,
                                                           com.box.sdk.BoxCollaborator collaborator,
                                                           com.box.sdk.BoxCollaboration.Role role)

Add a collaboration to this folder.

Parameters:

folderId - the folder id.

collaborator - the collaborator, which is blah 123 and - something more.

role - the role of the collaborator.

addFolderCollaborationByEmail

public com.box.sdk.BoxCollaboration addFolderCollaborationByEmail(String folderId,
                                                                  String email,
                                                                  com.box.sdk.BoxCollaboration.Role role)

Add a collaboration to this folder. An email will be sent to the collaborator if they don't already have a Box account.

Parameters:

folderId - the folder id

email - the email address of the collaborator

role - the role of the collaborator

getCollaborationInfo

public com.box.sdk.BoxCollaboration.Info getCollaborationInfo(String collaborationId)

Get collaboration information.

Parameters:

collaborationId - the id of collaboration

updateCollaborationInfo

public com.box.sdk.BoxCollaboration updateCollaborationInfo(String collaborationId,
                                                            com.box.sdk.BoxCollaboration.Info info)

Update collaboration information.

Parameters:

collaborationId - the id of collaboration

deleteCollaboration

public void deleteCollaboration(String collaborationId)

Delete collaboration.

Parameters:

collaborationId - the id of collaboration

getPendingCollaborations

public Collection<com.box.sdk.BoxCollaboration.Info> getPendingCollaborations()

Get all pending collaboration invites for the current user.