com.box.sdkgen.managers.usercollaborations

Class UserCollaborationsManager

Object

UserCollaborationsManager

public class UserCollaborationsManager
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	UserCollaborationsManager.Builder

Field Summary

Fields

Modifier and Type	Field and Description
Authentication	auth
NetworkSession	networkSession

Constructor Summary

Constructors

Modifier	Constructor and Description
	UserCollaborationsManager()
protected	UserCollaborationsManager(UserCollaborationsManager.Builder builder)

Method Summary

Modifier and Type	Method and Description
Collaboration	createCollaboration(CreateCollaborationRequestBody requestBody) Adds a collaboration for a single user or a single group to a file or folder.
Collaboration	createCollaboration(CreateCollaborationRequestBody requestBody, CreateCollaborationHeaders headers) Adds a collaboration for a single user or a single group to a file or folder.
Collaboration	createCollaboration(CreateCollaborationRequestBody requestBody, CreateCollaborationQueryParams queryParams) Adds a collaboration for a single user or a single group to a file or folder.
Collaboration	createCollaboration(CreateCollaborationRequestBody requestBody, CreateCollaborationQueryParams queryParams, CreateCollaborationHeaders headers) Adds a collaboration for a single user or a single group to a file or folder.
void	deleteCollaborationById(String collaborationId) Deletes a single collaboration.
void	deleteCollaborationById(String collaborationId, DeleteCollaborationByIdHeaders headers) Deletes a single collaboration.
Authentication	getAuth()
Collaboration	getCollaborationById(String collaborationId) Retrieves a single collaboration.
Collaboration	getCollaborationById(String collaborationId, GetCollaborationByIdHeaders headers) Retrieves a single collaboration.
Collaboration	getCollaborationById(String collaborationId, GetCollaborationByIdQueryParams queryParams) Retrieves a single collaboration.
Collaboration	getCollaborationById(String collaborationId, GetCollaborationByIdQueryParams queryParams, GetCollaborationByIdHeaders headers) Retrieves a single collaboration.
NetworkSession	getNetworkSession()
Collaboration	updateCollaborationById(String collaborationId) Updates a collaboration.
Collaboration	updateCollaborationById(String collaborationId, UpdateCollaborationByIdHeaders headers) Updates a collaboration.
Collaboration	updateCollaborationById(String collaborationId, UpdateCollaborationByIdRequestBody requestBody) Updates a collaboration.
Collaboration	updateCollaborationById(String collaborationId, UpdateCollaborationByIdRequestBody requestBody, UpdateCollaborationByIdHeaders headers) Updates a collaboration.

Methods inherited from class Object

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

Field Detail

auth

public Authentication auth

networkSession

public NetworkSession networkSession

Constructor Detail

UserCollaborationsManager

public UserCollaborationsManager()

UserCollaborationsManager

protected UserCollaborationsManager(UserCollaborationsManager.Builder builder)

Method Detail

getCollaborationById

public Collaboration getCollaborationById(String collaborationId)

Retrieves a single collaboration.

Parameters:

collaborationId - The ID of the collaboration. Example: "1234"

getCollaborationById

public Collaboration getCollaborationById(String collaborationId,
                                          GetCollaborationByIdQueryParams queryParams)

Retrieves a single collaboration.

Parameters:

collaborationId - The ID of the collaboration. Example: "1234"

queryParams - Query parameters of getCollaborationById method

getCollaborationById

public Collaboration getCollaborationById(String collaborationId,
                                          GetCollaborationByIdHeaders headers)

Retrieves a single collaboration.

Parameters:

collaborationId - The ID of the collaboration. Example: "1234"

headers - Headers of getCollaborationById method

getCollaborationById

public Collaboration getCollaborationById(String collaborationId,
                                          GetCollaborationByIdQueryParams queryParams,
                                          GetCollaborationByIdHeaders headers)

Retrieves a single collaboration.

Parameters:

collaborationId - The ID of the collaboration. Example: "1234"

queryParams - Query parameters of getCollaborationById method

headers - Headers of getCollaborationById method

updateCollaborationById

public Collaboration updateCollaborationById(String collaborationId)

Updates a collaboration. Can be used to change the owner of an item, or to accept collaboration invites. In case of accepting collaboration invite, role is not required.

Parameters:

collaborationId - The ID of the collaboration. Example: "1234"

updateCollaborationById

public Collaboration updateCollaborationById(String collaborationId,
                                             UpdateCollaborationByIdRequestBody requestBody)

Updates a collaboration. Can be used to change the owner of an item, or to accept collaboration invites. In case of accepting collaboration invite, role is not required.

Parameters:

collaborationId - The ID of the collaboration. Example: "1234"

requestBody - Request body of updateCollaborationById method

updateCollaborationById

public Collaboration updateCollaborationById(String collaborationId,
                                             UpdateCollaborationByIdHeaders headers)

Updates a collaboration. Can be used to change the owner of an item, or to accept collaboration invites. In case of accepting collaboration invite, role is not required.

Parameters:

collaborationId - The ID of the collaboration. Example: "1234"

headers - Headers of updateCollaborationById method

updateCollaborationById

public Collaboration updateCollaborationById(String collaborationId,
                                             UpdateCollaborationByIdRequestBody requestBody,
                                             UpdateCollaborationByIdHeaders headers)

Updates a collaboration. Can be used to change the owner of an item, or to accept collaboration invites. In case of accepting collaboration invite, role is not required.

Parameters:

collaborationId - The ID of the collaboration. Example: "1234"

requestBody - Request body of updateCollaborationById method

headers - Headers of updateCollaborationById method

deleteCollaborationById

public void deleteCollaborationById(String collaborationId)

Deletes a single collaboration.

Parameters:

collaborationId - The ID of the collaboration. Example: "1234"

deleteCollaborationById

public void deleteCollaborationById(String collaborationId,
                                    DeleteCollaborationByIdHeaders headers)

Deletes a single collaboration.

Parameters:

collaborationId - The ID of the collaboration. Example: "1234"

headers - Headers of deleteCollaborationById method

createCollaboration

public Collaboration createCollaboration(CreateCollaborationRequestBody requestBody)

Adds a collaboration for a single user or a single group to a file or folder.

Collaborations can be created using email address, user IDs, or a group IDs.

If a collaboration is being created with a group, access to this endpoint is dependent on the group's ability to be invited.

If collaboration is in `pending` status, the following fields are redacted: - `login` and `name` are hidden if a collaboration was created using `user_id`, - `name` is hidden if a collaboration was created using `login`.

Parameters:

requestBody - Request body of createCollaboration method

createCollaboration

public Collaboration createCollaboration(CreateCollaborationRequestBody requestBody,
                                         CreateCollaborationQueryParams queryParams)

Adds a collaboration for a single user or a single group to a file or folder.

Collaborations can be created using email address, user IDs, or a group IDs.

If a collaboration is being created with a group, access to this endpoint is dependent on the group's ability to be invited.

If collaboration is in `pending` status, the following fields are redacted: - `login` and `name` are hidden if a collaboration was created using `user_id`, - `name` is hidden if a collaboration was created using `login`.

Parameters:

requestBody - Request body of createCollaboration method

queryParams - Query parameters of createCollaboration method

createCollaboration

public Collaboration createCollaboration(CreateCollaborationRequestBody requestBody,
                                         CreateCollaborationHeaders headers)

Adds a collaboration for a single user or a single group to a file or folder.

Collaborations can be created using email address, user IDs, or a group IDs.

If a collaboration is being created with a group, access to this endpoint is dependent on the group's ability to be invited.

If collaboration is in `pending` status, the following fields are redacted: - `login` and `name` are hidden if a collaboration was created using `user_id`, - `name` is hidden if a collaboration was created using `login`.

Parameters:

requestBody - Request body of createCollaboration method

headers - Headers of createCollaboration method

createCollaboration

public Collaboration createCollaboration(CreateCollaborationRequestBody requestBody,
                                         CreateCollaborationQueryParams queryParams,
                                         CreateCollaborationHeaders headers)

Adds a collaboration for a single user or a single group to a file or folder.

Collaborations can be created using email address, user IDs, or a group IDs.

If a collaboration is being created with a group, access to this endpoint is dependent on the group's ability to be invited.

If collaboration is in `pending` status, the following fields are redacted: - `login` and `name` are hidden if a collaboration was created using `user_id`, - `name` is hidden if a collaboration was created using `login`.

Parameters:

requestBody - Request body of createCollaboration method

queryParams - Query parameters of createCollaboration method

headers - Headers of createCollaboration method

getAuth

public Authentication getAuth()

getNetworkSession

public NetworkSession getNetworkSession()