com.box.boxjavalibv2.resourcemanagers

Interface IBoxCollaborationsManager

All Superinterfaces:

IBoxResourceManager

All Known Implementing Classes:

BoxCollaborationsManagerImpl

public interface IBoxCollaborationsManager
extends IBoxResourceManager

Method Summary

Methods

Modifier and Type	Method and Description
BoxCollaboration	createCollaboration(java.lang.String folderId, BoxCollabRequestObject collabObject) Add a collaboration for a single user to a folder.
void	deleteCollaboration(java.lang.String collabId, BoxDefaultRequestObject requestObject) Delete a collaboration.
java.util.List<BoxCollaboration>	getAllCollaborations(BoxGetAllCollabsRequestObject collabObject) Get all collaborations.
BoxCollaboration	getCollaboration(java.lang.String collabId, BoxDefaultRequestObject requestObject) Get a collaboration.
BoxCollaboration	updateCollaboration(java.lang.String collabId, BoxCollabRequestObject requestObject) Update a collaboration.

Method Detail

getCollaboration

BoxCollaboration getCollaboration(java.lang.String collabId,
                                BoxDefaultRequestObject requestObject)
                                  throws BoxRestException,
                                         BoxServerException,
                                         AuthFatalFailureException

Get a collaboration.

Parameters:

collabId - id of the collaboration

requestObject - object that goes into request.

Returns:

collaboration (Errors may occur if the IDs are invalid or if the user does not have permissions to see the collaboration.)

Throws:

BoxRestException - See BoxRestException for more info.

BoxServerException - See com.box.restclientv2.exceptions.BoxServerException for more info.

AuthFatalFailureException - See com.box.restclientv2.exceptions.AuthFatalFailureException for more info.

createCollaboration

BoxCollaboration createCollaboration(java.lang.String folderId,
                                   BoxCollabRequestObject collabObject)
                                     throws BoxRestException,
                                            BoxServerException,
                                            AuthFatalFailureException

Add a collaboration for a single user to a folder.

Parameters:

folderId - id of the folder

collabObject - object that goes into request body.

Returns:

collaboration

Throws:

BoxRestException - See BoxRestException for more info.

BoxServerException - See com.box.restclientv2.exceptions.BoxServerException for more info.

AuthFatalFailureException - See com.box.restclientv2.exceptions.AuthFatalFailureException for more info.

getAllCollaborations

java.util.List<BoxCollaboration> getAllCollaborations(BoxGetAllCollabsRequestObject collabObject)
                                                      throws BoxRestException,
                                                             BoxServerException,
                                                             AuthFatalFailureException

Get all collaborations. (Currently only support getting all pending collaborations.)

Parameters:

collabObject - object that goes into request.

Returns:

collaborations

Throws:

BoxRestException - See BoxRestException for more info.

BoxServerException - See com.box.restclientv2.exceptions.BoxServerException for more info.

AuthFatalFailureException - See com.box.restclientv2.exceptions.AuthFatalFailureException for more info.

deleteCollaboration

void deleteCollaboration(java.lang.String collabId,
                       BoxDefaultRequestObject requestObject)
                         throws BoxServerException,
                                BoxRestException,
                                AuthFatalFailureException

Delete a collaboration.

Parameters:

collabId - id of the collaboration

requestObject - object that goes into request.

Throws:

BoxRestException - See BoxRestException for more info.

BoxServerException - See com.box.restclientv2.exceptions.BoxServerException for more info.

AuthFatalFailureException - See com.box.restclientv2.exceptions.AuthFatalFailureException for more info.

updateCollaboration

BoxCollaboration updateCollaboration(java.lang.String collabId,
                                   BoxCollabRequestObject requestObject)
                                     throws BoxRestException,
                                            AuthFatalFailureException,
                                            BoxServerException

Update a collaboration.

Parameters:

collabId - id of the collaboration

requestObject - request object. Note the you can set the status in this object to 'accepted' or 'rejected' if you are the 'accessible_by' user and the current status is 'pending'

Returns:

updated BoxCollaboration

Throws:

BoxRestException - See BoxRestException for more info.

BoxServerException - See com.box.restclientv2.exceptions.BoxServerException for more info.

AuthFatalFailureException - See com.box.restclientv2.exceptions.AuthFatalFailureException for more info.