BoxCollaboration (Box Java SDK)

Object
- BoxResource
- - BoxCollaboration

```
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.

Constructor Summary

Constructors
Constructor and Description

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`delete()` Deletes this collaboration.
`BoxCollaboration.Info`	`getInfo()` Gets information about this collaboration.
`static Collection<BoxCollaboration.Info>`	`getPendingCollaborations(BoxAPIConnection api)` 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, hashCode

Methods inherited from class Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- 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
  - getPendingCollaborations
```
public static Collection<BoxCollaboration.Info> getPendingCollaborations(BoxAPIConnection api)
```
    Gets all pending collaboration invites for the current user.
    
    Parameters:
    
    api - the API connection to use.
    
    Returns:
    
    a collection of pending collaboration infos.
  - getInfo
```
public BoxCollaboration.Info getInfo()
```
    Gets information about this collaboration.
    
    Returns:
    
    info about this 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.