com.box.sdk

Class BoxCollaboration

Object

BoxResource

BoxCollaboration

@BoxResourceType(value="collaboration")
public class BoxCollaboration
extends BoxResource

Represents a collaboration between a user and another user or group. Collaborations are Box's equivalent of access control lists. They can be used to set and apply permissions for users or groups to folders.

Unless otherwise noted, the methods in this class can throw an unchecked BoxAPIException (unchecked meaning that the compiler won't force you to handle it) if an error occurs. If you wish to implement custom error handling for errors related to the Box REST API, you should capture this exception explicitly.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	BoxCollaboration.Info Contains information about a BoxCollaboration.
static class	BoxCollaboration.Role Enumerates the possible access levels that a collaborator can have.
static class	BoxCollaboration.Status Enumerates the possible statuses that a collaboration can have.

Field Summary

Fields

Modifier and Type	Field and Description
static String[]	ALL_FIELDS All possible fields on a collaboration object.
static URLTemplate	COLLABORATION_URL_TEMPLATE Collaboration URL Template.
static URLTemplate	COLLABORATIONS_URL_TEMPLATE Collaborations URL Template.
static URLTemplate	GET_ALL_FILE_COLLABORATIONS_URL Get All File Collaboations URL.
static URLTemplate	PENDING_COLLABORATIONS_URL Pending Collaborations URL.

Constructor Summary

Constructors

Constructor and Description
BoxCollaboration(BoxAPIConnection api, String id) Constructs a BoxCollaboration for a collaboration with a given ID.

Method Summary

Modifier and Type	Method and Description
protected static BoxCollaboration.Info	create(BoxAPIConnection api, JsonObject accessibleBy, JsonObject item, BoxCollaboration.Role role, Boolean notify, Boolean canViewPath) Create a new collaboration object.
protected static BoxCollaboration.Info	create(BoxAPIConnection api, JsonObject accessibleBy, JsonObject item, BoxCollaboration.Role role, Boolean notify, Boolean canViewPath, Date expiresAt) Create a new collaboration object.
protected static BoxCollaboration.Info	create(BoxAPIConnection api, JsonObject accessibleBy, JsonObject item, BoxCollaboration.Role role, Boolean notify, Boolean canViewPath, Date expiresAt, Boolean isAccessOnly) Create a new collaboration object.
void	delete() Deletes this collaboration.
static BoxResourceIterable<BoxCollaboration.Info>	getAllFileCollaborations(BoxAPIConnection api, String fileID, int pageSize, String... fields) Used to retrieve all collaborations associated with the item.
BoxCollaboration.Info	getInfo(String... fields) Gets information about this collection with a custom set of fields.
static Collection<BoxCollaboration.Info>	getPendingCollaborations(BoxAPIConnection api, String... fields) Gets all pending collaboration invites for the current user.
void	updateInfo(BoxCollaboration.Info info) Updates the information about this collaboration with any info fields that have been modified locally.

Methods inherited from class BoxResource

equals, getAPI, getID, getResourceType, hashCode

Methods inherited from class Object

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

Field Detail

ALL_FIELDS

public static final String[] ALL_FIELDS

All possible fields on a collaboration object.

COLLABORATIONS_URL_TEMPLATE

public static final URLTemplate COLLABORATIONS_URL_TEMPLATE

Collaborations URL Template.

PENDING_COLLABORATIONS_URL

public static final URLTemplate PENDING_COLLABORATIONS_URL

Pending Collaborations URL.

COLLABORATION_URL_TEMPLATE

public static final URLTemplate COLLABORATION_URL_TEMPLATE

Collaboration URL Template.

GET_ALL_FILE_COLLABORATIONS_URL

public static final URLTemplate GET_ALL_FILE_COLLABORATIONS_URL

Get All File Collaboations URL.

Constructor Detail

BoxCollaboration

public BoxCollaboration(BoxAPIConnection api,
                        String id)

Constructs a BoxCollaboration for a collaboration with a given ID.

Parameters:

api - the API connection to be used by the collaboration.

id - the ID of the collaboration.

Method Detail

create

protected static BoxCollaboration.Info create(BoxAPIConnection api,
                                              JsonObject accessibleBy,
                                              JsonObject item,
                                              BoxCollaboration.Role role,
                                              Boolean notify,
                                              Boolean canViewPath)

Create a new collaboration object.

Parameters:

api - the API connection used to make the request.

accessibleBy - the JSON object describing who should be collaborated.

item - the JSON object describing which item to collaborate.

role - the role to give the collaborators.

notify - the user/group should receive email notification of the collaboration or not.

canViewPath - the view path collaboration feature is enabled or not.

Returns:

info about the new collaboration.

create

protected static BoxCollaboration.Info create(BoxAPIConnection api,
                                              JsonObject accessibleBy,
                                              JsonObject item,
                                              BoxCollaboration.Role role,
                                              Boolean notify,
                                              Boolean canViewPath,
                                              Date expiresAt)

Create a new collaboration object.

Parameters:

api - the API connection used to make the request.

accessibleBy - the JSON object describing who should be collaborated.

item - the JSON object describing which item to collaborate.

role - the role to give the collaborators.

notify - the user/group should receive email notification of the collaboration or not.

canViewPath - the view path collaboration feature is enabled or not.

expiresAt - the date the collaboration expires

Returns:

info about the new collaboration.

create

protected static BoxCollaboration.Info create(BoxAPIConnection api,
                                              JsonObject accessibleBy,
                                              JsonObject item,
                                              BoxCollaboration.Role role,
                                              Boolean notify,
                                              Boolean canViewPath,
                                              Date expiresAt,
                                              Boolean isAccessOnly)

Create a new collaboration object.

Parameters:

api - the API connection used to make the request.

accessibleBy - the JSON object describing who should be collaborated.

item - the JSON object describing which item to collaborate.

role - the role to give the collaborators.

notify - the user/group should receive email notification of the collaboration or not.

canViewPath - the view path collaboration feature is enabled or not.

expiresAt - the date the collaboration expires

isAccessOnly - the collaboration is an access only collaboration or not.

Returns:

info about the new collaboration.

getPendingCollaborations

public static Collection<BoxCollaboration.Info> getPendingCollaborations(BoxAPIConnection api,
                                                                         String... fields)

Gets all pending collaboration invites for the current user.

Parameters:

api - the API connection to use.

Returns:

a collection of pending collaboration infos.

getAllFileCollaborations

public static BoxResourceIterable<BoxCollaboration.Info> getAllFileCollaborations(BoxAPIConnection api,
                                                                                  String fileID,
                                                                                  int pageSize,
                                                                                  String... fields)

Used to retrieve all collaborations associated with the item.

Parameters:

api - BoxAPIConnection from the associated file.

fileID - FileID of the associated file

pageSize - page size for server pages of the Iterable

fields - the optional fields to retrieve.

Returns:

An iterable of BoxCollaboration.Info instances associated with the item.

getInfo

public BoxCollaboration.Info getInfo(String... fields)

Gets information about this collection with a custom set of fields.

Parameters:

fields - the fields to retrieve.

Returns:

info about the collaboration.

updateInfo

public void updateInfo(BoxCollaboration.Info info)

Updates the information about this collaboration with any info fields that have been modified locally.

Parameters:

info - the updated info.

delete

public void delete()

Deletes this collaboration.