Class BoxCollaborationsManager


  • public class BoxCollaborationsManager
    extends Object
    Provides operations to manage Box collaborations.
    • 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 id of folder to get collaborations information on.
        Returns:
        The collection of collaboration information for folder.
      • 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 id of folder to add collaboration to.
        collaborator - - the collaborator to add.
        role - - the role of the collaborator.
        Returns:
        The new collaboration.
      • 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 id of folder to add collaboration to.
        email - - the email address of the collaborator to add.
        role - - the role of the collaborator.
        Returns:
        The new collaboration.
      • getCollaborationInfo

        public com.box.sdk.BoxCollaboration.Info getCollaborationInfo​(String collaborationId)
        Get collaboration information.
        Parameters:
        collaborationId - - the id of collaboration.
        Returns:
        The collaboration information.
      • updateCollaborationInfo

        public com.box.sdk.BoxCollaboration updateCollaborationInfo​(String collaborationId,
                                                                    com.box.sdk.BoxCollaboration.Info info)
        Update collaboration information.
        Parameters:
        collaborationId - - the id of collaboration.
        info - collaboration information to update.
        Returns:
        The collaboration with updated information.
      • deleteCollaboration

        public void deleteCollaboration​(String collaborationId)
        Delete collaboration.
        Parameters:
        collaborationId - - the id of comment to change.
      • getPendingCollaborations

        public Collection<com.box.sdk.BoxCollaboration.Info> getPendingCollaborations()
        Get all pending collaboration invites for the current user.
        Returns:
        A collection of pending collaboration information.