com.box.boxjavalibv2.resourcemanagers

Class BoxCollaborationsManagerImpl

java.lang.Object

com.box.boxjavalibv2.resourcemanagers.AbstractBoxResourceManager

com.box.boxjavalibv2.resourcemanagers.BoxCollaborationsManagerImpl

All Implemented Interfaces:

IBoxCollaborationsManager, IBoxResourceManager

public final class BoxCollaborationsManagerImpl
extends AbstractBoxResourceManager
implements IBoxCollaborationsManager

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
BoxCollaborationsManagerImpl(IBoxConfig config, IBoxResourceHub resourceHub, IBoxJSONParser parser, IBoxRequestAuth auth, IBoxRESTClient restClient) Constructor.

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.
static java.util.List<BoxCollaboration>	getCollaborations(BoxCollection collection) Deprecated.
BoxCollaboration	updateCollaboration(java.lang.String collabId, BoxCollabRequestObject requestObject) Update a collaboration.

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

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

BoxCollaborationsManagerImpl

public BoxCollaborationsManagerImpl(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(java.lang.String collabId,
                                BoxDefaultRequestObject requestObject)
                                  throws BoxRestException,
                                         BoxServerException,
                                         AuthFatalFailureException

Description copied from interface: IBoxCollaborationsManager

Get a collaboration.

Specified by:

getCollaboration in interface IBoxCollaborationsManager

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

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

Description copied from interface: IBoxCollaborationsManager

Add a collaboration for a single user to a folder.

Specified by:

createCollaboration in interface IBoxCollaborationsManager

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

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

Description copied from interface: IBoxCollaborationsManager

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

Specified by:

getAllCollaborations in interface IBoxCollaborationsManager

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

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

Description copied from interface: IBoxCollaborationsManager

Delete a collaboration.

Specified by:

deleteCollaboration in interface IBoxCollaborationsManager

Parameters:

collabId - id of the collaboration

requestObject - object that goes into request.

Throws:

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

BoxRestException - See BoxRestException for more info.

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

updateCollaboration

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

Description copied from interface: IBoxCollaborationsManager

Update a collaboration.

Specified by:

updateCollaboration in interface IBoxCollaborationsManager

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.

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

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

getCollaborations

@Deprecated
public static java.util.List<BoxCollaboration> getCollaborations(BoxCollection collection)

Deprecated.

Get collaborations from a collection.Deprecated, use Utils.getTypedObjects instead.

Parameters:

collection - collection

Returns:

collaborations