com.box.sdkgen.managers.listcollaborations

Class ListCollaborationsManager

Object

ListCollaborationsManager

public class ListCollaborationsManager
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ListCollaborationsManager.Builder

Field Summary

Fields

Modifier and Type	Field and Description
Authentication	auth
NetworkSession	networkSession

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
Authentication	getAuth()
CollaborationsOffsetPaginated	getCollaborations(GetCollaborationsQueryParams queryParams) Retrieves all pending collaboration invites for this user.
CollaborationsOffsetPaginated	getCollaborations(GetCollaborationsQueryParams queryParams, GetCollaborationsHeaders headers) Retrieves all pending collaboration invites for this user.
Collaborations	getFileCollaborations(String fileId) Retrieves a list of pending and active collaborations for a file.
Collaborations	getFileCollaborations(String fileId, GetFileCollaborationsHeaders headers) Retrieves a list of pending and active collaborations for a file.
Collaborations	getFileCollaborations(String fileId, GetFileCollaborationsQueryParams queryParams) Retrieves a list of pending and active collaborations for a file.
Collaborations	getFileCollaborations(String fileId, GetFileCollaborationsQueryParams queryParams, GetFileCollaborationsHeaders headers) Retrieves a list of pending and active collaborations for a file.
Collaborations	getFolderCollaborations(String folderId) Retrieves a list of pending and active collaborations for a folder.
Collaborations	getFolderCollaborations(String folderId, GetFolderCollaborationsHeaders headers) Retrieves a list of pending and active collaborations for a folder.
Collaborations	getFolderCollaborations(String folderId, GetFolderCollaborationsQueryParams queryParams) Retrieves a list of pending and active collaborations for a folder.
Collaborations	getFolderCollaborations(String folderId, GetFolderCollaborationsQueryParams queryParams, GetFolderCollaborationsHeaders headers) Retrieves a list of pending and active collaborations for a folder.
CollaborationsOffsetPaginated	getGroupCollaborations(String groupId) Retrieves all the collaborations for a group.
CollaborationsOffsetPaginated	getGroupCollaborations(String groupId, GetGroupCollaborationsHeaders headers) Retrieves all the collaborations for a group.
CollaborationsOffsetPaginated	getGroupCollaborations(String groupId, GetGroupCollaborationsQueryParams queryParams) Retrieves all the collaborations for a group.
CollaborationsOffsetPaginated	getGroupCollaborations(String groupId, GetGroupCollaborationsQueryParams queryParams, GetGroupCollaborationsHeaders headers) Retrieves all the collaborations for a group.
NetworkSession	getNetworkSession()

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

ListCollaborationsManager

public ListCollaborationsManager()

ListCollaborationsManager

protected ListCollaborationsManager(ListCollaborationsManager.Builder builder)

Method Detail

getFileCollaborations

public Collaborations getFileCollaborations(String fileId)

Retrieves a list of pending and active collaborations for a file. This returns all the users that have access to the file or have been invited to the file.

Parameters:

fileId - The unique identifier that represents a file.

The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/files/123` the `file_id` is `123`. Example: "12345"

getFileCollaborations

public Collaborations getFileCollaborations(String fileId,
                                            GetFileCollaborationsQueryParams queryParams)

Retrieves a list of pending and active collaborations for a file. This returns all the users that have access to the file or have been invited to the file.

Parameters:

fileId - The unique identifier that represents a file.

The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/files/123` the `file_id` is `123`. Example: "12345"

queryParams - Query parameters of getFileCollaborations method

getFileCollaborations

public Collaborations getFileCollaborations(String fileId,
                                            GetFileCollaborationsHeaders headers)

Retrieves a list of pending and active collaborations for a file. This returns all the users that have access to the file or have been invited to the file.

Parameters:

fileId - The unique identifier that represents a file.

The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/files/123` the `file_id` is `123`. Example: "12345"

headers - Headers of getFileCollaborations method

getFileCollaborations

public Collaborations getFileCollaborations(String fileId,
                                            GetFileCollaborationsQueryParams queryParams,
                                            GetFileCollaborationsHeaders headers)

Retrieves a list of pending and active collaborations for a file. This returns all the users that have access to the file or have been invited to the file.

Parameters:

fileId - The unique identifier that represents a file.

The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/files/123` the `file_id` is `123`. Example: "12345"

queryParams - Query parameters of getFileCollaborations method

headers - Headers of getFileCollaborations method

getFolderCollaborations

public Collaborations getFolderCollaborations(String folderId)

Retrieves a list of pending and active collaborations for a folder. This returns all the users that have access to the folder or have been invited to the folder.

Parameters:

folderId - The unique identifier that represent a folder.

The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/folder/123` the `folder_id` is `123`. Example: "12345"

getFolderCollaborations

public Collaborations getFolderCollaborations(String folderId,
                                              GetFolderCollaborationsQueryParams queryParams)

Retrieves a list of pending and active collaborations for a folder. This returns all the users that have access to the folder or have been invited to the folder.

Parameters:

folderId - The unique identifier that represent a folder.

The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/folder/123` the `folder_id` is `123`. Example: "12345"

queryParams - Query parameters of getFolderCollaborations method

getFolderCollaborations

public Collaborations getFolderCollaborations(String folderId,
                                              GetFolderCollaborationsHeaders headers)

Retrieves a list of pending and active collaborations for a folder. This returns all the users that have access to the folder or have been invited to the folder.

Parameters:

folderId - The unique identifier that represent a folder.

The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/folder/123` the `folder_id` is `123`. Example: "12345"

headers - Headers of getFolderCollaborations method

getFolderCollaborations

public Collaborations getFolderCollaborations(String folderId,
                                              GetFolderCollaborationsQueryParams queryParams,
                                              GetFolderCollaborationsHeaders headers)

Retrieves a list of pending and active collaborations for a folder. This returns all the users that have access to the folder or have been invited to the folder.

Parameters:

folderId - The unique identifier that represent a folder.

The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/folder/123` the `folder_id` is `123`. Example: "12345"

queryParams - Query parameters of getFolderCollaborations method

headers - Headers of getFolderCollaborations method

getCollaborations

public CollaborationsOffsetPaginated getCollaborations(GetCollaborationsQueryParams queryParams)

Retrieves all pending collaboration invites for this user.

Parameters:

queryParams - Query parameters of getCollaborations method

getCollaborations

public CollaborationsOffsetPaginated getCollaborations(GetCollaborationsQueryParams queryParams,
                                                       GetCollaborationsHeaders headers)

Retrieves all pending collaboration invites for this user.

Parameters:

queryParams - Query parameters of getCollaborations method

headers - Headers of getCollaborations method

getGroupCollaborations

public CollaborationsOffsetPaginated getGroupCollaborations(String groupId)

Retrieves all the collaborations for a group. The user must have admin permissions to inspect enterprise's groups.

Each collaboration object has details on which files or folders the group has access to and with what role.

Parameters:

groupId - The ID of the group. Example: "57645"

getGroupCollaborations

public CollaborationsOffsetPaginated getGroupCollaborations(String groupId,
                                                            GetGroupCollaborationsQueryParams queryParams)

Retrieves all the collaborations for a group. The user must have admin permissions to inspect enterprise's groups.

Each collaboration object has details on which files or folders the group has access to and with what role.

Parameters:

groupId - The ID of the group. Example: "57645"

queryParams - Query parameters of getGroupCollaborations method

getGroupCollaborations

public CollaborationsOffsetPaginated getGroupCollaborations(String groupId,
                                                            GetGroupCollaborationsHeaders headers)

Retrieves all the collaborations for a group. The user must have admin permissions to inspect enterprise's groups.

Each collaboration object has details on which files or folders the group has access to and with what role.

Parameters:

groupId - The ID of the group. Example: "57645"

headers - Headers of getGroupCollaborations method

getGroupCollaborations

public CollaborationsOffsetPaginated getGroupCollaborations(String groupId,
                                                            GetGroupCollaborationsQueryParams queryParams,
                                                            GetGroupCollaborationsHeaders headers)

Retrieves all the collaborations for a group. The user must have admin permissions to inspect enterprise's groups.

Each collaboration object has details on which files or folders the group has access to and with what role.

Parameters:

groupId - The ID of the group. Example: "57645"

queryParams - Query parameters of getGroupCollaborations method

headers - Headers of getGroupCollaborations method

getAuth

public Authentication getAuth()

getNetworkSession

public NetworkSession getNetworkSession()