com.box.boxjavalibv2.resourcemanagers

Class BoxCollaborationsManager

java.lang.Object

com.box.boxjavalibv2.resourcemanagers.BoxResourceManager

com.box.boxjavalibv2.resourcemanagers.BoxCollaborationsManager

public final class BoxCollaborationsManager
extends BoxResourceManager

Use this class to execute requests synchronously against the Box REST API(V2), collaborations endpints. Full details about the Box API can be found at http://developers.box.com/docs . You must have an OpenBox application with a valid API key to use the Box API. All methods in this class are executed in the invoking thread, and therefore are NOT safe to execute in the UI thread of your application. You should only use this class if you already have worker threads or AsyncTasks that you want to incorporate the Box API into.

Constructor Summary

Constructors

Constructor and Description
BoxCollaborationsManager(IBoxConfig config, IBoxResourceHub resourceHub, IBoxJSONParser parser, IBoxRequestAuth auth, IBoxRESTClient restClient) Constructor.

Method Summary

Methods

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

Methods inherited from class com.box.boxjavalibv2.resourcemanagers.BoxResourceManager

executeRequestWithNoResponseBody, getAuth, getClassFromType, getConfig, getJSONParser, getResourceHub, getResponseAndParse, getResponseAndParseAndTryCast, getRestClient, tryCastBoxItem, tryCastObject

Methods inherited from class java.lang.Object

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

Constructor Detail

BoxCollaborationsManager

public BoxCollaborationsManager(IBoxConfig config,
                        IBoxResourceHub resourceHub,
                        IBoxJSONParser parser,
                        IBoxRequestAuth auth,
                        IBoxRESTClient restClient)

Constructor.

Parameters:

config - Config

resourceHub - IResourceHub

parser - json parser

auth - auth for api calls

restClient - REST client to make api calls.

Method Detail

getCollaboration

public BoxCollaboration getCollaboration(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 - exception

BoxServerException - exception

AuthFatalFailureException - exception indicating authentication totally failed

createCollaboration

public BoxCollaboration createCollaboration(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 - exception

BoxServerException - exception

AuthFatalFailureException - exception indicating authentication totally failed

getAllCollaborations

public List<BoxCollaboration> getAllCollaborations(BoxCollabRequestObject 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 - exception

BoxServerException - exception

AuthFatalFailureException - exception indicating authentication totally failed

deleteCollaboration

public void deleteCollaboration(String collabId,
                       BoxDefaultRequestObject requestObject)
                         throws BoxServerException,
                                BoxRestException,
                                AuthFatalFailureException

Delete a collaboration.

Parameters:

collabId - id of the collaboration

collabObject - object that goes into request.

Throws:

BoxRestException - exception

BoxServerException - exception

AuthFatalFailureException - exception

updateCollaboration

public BoxCollaboration updateCollaboration(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

AuthFatalFailureException

BoxServerException

getCollaborations

public static List<BoxCollaboration> getCollaborations(BoxCollection collection)

Get collaborations from a collection.

Parameters:

collection - collection

Returns:

collaborations