com.box.sdkgen.managers.folderclassifications

Class FolderClassificationsManager

Object

FolderClassificationsManager

public class FolderClassificationsManager
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FolderClassificationsManager.Builder

Field Summary

Fields

Modifier and Type	Field and Description
Authentication	auth
NetworkSession	networkSession

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
Classification	addClassificationToFolder(String folderId) Adds a classification to a folder by specifying the label of the classification to add.
Classification	addClassificationToFolder(String folderId, AddClassificationToFolderHeaders headers) Adds a classification to a folder by specifying the label of the classification to add.
Classification	addClassificationToFolder(String folderId, AddClassificationToFolderRequestBody requestBody) Adds a classification to a folder by specifying the label of the classification to add.
Classification	addClassificationToFolder(String folderId, AddClassificationToFolderRequestBody requestBody, AddClassificationToFolderHeaders headers) Adds a classification to a folder by specifying the label of the classification to add.
void	deleteClassificationFromFolder(String folderId) Removes any classifications from a folder.
void	deleteClassificationFromFolder(String folderId, DeleteClassificationFromFolderHeaders headers) Removes any classifications from a folder.
Authentication	getAuth()
Classification	getClassificationOnFolder(String folderId) Retrieves the classification metadata instance that has been applied to a folder.
Classification	getClassificationOnFolder(String folderId, GetClassificationOnFolderHeaders headers) Retrieves the classification metadata instance that has been applied to a folder.
NetworkSession	getNetworkSession()
Classification	updateClassificationOnFolder(String folderId, List<UpdateClassificationOnFolderRequestBody> requestBody) Updates a classification on a folder.
Classification	updateClassificationOnFolder(String folderId, List<UpdateClassificationOnFolderRequestBody> requestBody, UpdateClassificationOnFolderHeaders headers) Updates a classification on a folder.

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

FolderClassificationsManager

public FolderClassificationsManager()

FolderClassificationsManager

protected FolderClassificationsManager(FolderClassificationsManager.Builder builder)

Method Detail

getClassificationOnFolder

public Classification getClassificationOnFolder(String folderId)

Retrieves the classification metadata instance that has been applied to a folder.

This API can also be called by including the enterprise ID in the URL explicitly, for example `/folders/:id/enterprise_12345/securityClassification-6VMVochwUWo`.

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

The root folder of a Box account is always represented by the ID `0`. Example: "12345"

getClassificationOnFolder

public Classification getClassificationOnFolder(String folderId,
                                                GetClassificationOnFolderHeaders headers)

Retrieves the classification metadata instance that has been applied to a folder.

This API can also be called by including the enterprise ID in the URL explicitly, for example `/folders/:id/enterprise_12345/securityClassification-6VMVochwUWo`.

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

The root folder of a Box account is always represented by the ID `0`. Example: "12345"

headers - Headers of getClassificationOnFolder method

addClassificationToFolder

public Classification addClassificationToFolder(String folderId)

Adds a classification to a folder by specifying the label of the classification to add.

This API can also be called by including the enterprise ID in the URL explicitly, for example `/folders/:id/enterprise_12345/securityClassification-6VMVochwUWo`.

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

The root folder of a Box account is always represented by the ID `0`. Example: "12345"

addClassificationToFolder

public Classification addClassificationToFolder(String folderId,
                                                AddClassificationToFolderRequestBody requestBody)

Adds a classification to a folder by specifying the label of the classification to add.

This API can also be called by including the enterprise ID in the URL explicitly, for example `/folders/:id/enterprise_12345/securityClassification-6VMVochwUWo`.

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

The root folder of a Box account is always represented by the ID `0`. Example: "12345"

requestBody - Request body of addClassificationToFolder method

addClassificationToFolder

public Classification addClassificationToFolder(String folderId,
                                                AddClassificationToFolderHeaders headers)

Adds a classification to a folder by specifying the label of the classification to add.

This API can also be called by including the enterprise ID in the URL explicitly, for example `/folders/:id/enterprise_12345/securityClassification-6VMVochwUWo`.

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

The root folder of a Box account is always represented by the ID `0`. Example: "12345"

headers - Headers of addClassificationToFolder method

addClassificationToFolder

public Classification addClassificationToFolder(String folderId,
                                                AddClassificationToFolderRequestBody requestBody,
                                                AddClassificationToFolderHeaders headers)

Adds a classification to a folder by specifying the label of the classification to add.

This API can also be called by including the enterprise ID in the URL explicitly, for example `/folders/:id/enterprise_12345/securityClassification-6VMVochwUWo`.

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

The root folder of a Box account is always represented by the ID `0`. Example: "12345"

requestBody - Request body of addClassificationToFolder method

headers - Headers of addClassificationToFolder method

updateClassificationOnFolder

public Classification updateClassificationOnFolder(String folderId,
                                                   List<UpdateClassificationOnFolderRequestBody> requestBody)

Updates a classification on a folder.

The classification can only be updated if a classification has already been applied to the folder before. When editing classifications, only values are defined for the enterprise will be accepted.

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

The root folder of a Box account is always represented by the ID `0`. Example: "12345"

requestBody - Request body of updateClassificationOnFolder method

updateClassificationOnFolder

public Classification updateClassificationOnFolder(String folderId,
                                                   List<UpdateClassificationOnFolderRequestBody> requestBody,
                                                   UpdateClassificationOnFolderHeaders headers)

Updates a classification on a folder.

The classification can only be updated if a classification has already been applied to the folder before. When editing classifications, only values are defined for the enterprise will be accepted.

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

The root folder of a Box account is always represented by the ID `0`. Example: "12345"

requestBody - Request body of updateClassificationOnFolder method

headers - Headers of updateClassificationOnFolder method

deleteClassificationFromFolder

public void deleteClassificationFromFolder(String folderId)

Removes any classifications from a folder.

This API can also be called by including the enterprise ID in the URL explicitly, for example `/folders/:id/enterprise_12345/securityClassification-6VMVochwUWo`.

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

The root folder of a Box account is always represented by the ID `0`. Example: "12345"

deleteClassificationFromFolder

public void deleteClassificationFromFolder(String folderId,
                                           DeleteClassificationFromFolderHeaders headers)

Removes any classifications from a folder.

This API can also be called by including the enterprise ID in the URL explicitly, for example `/folders/:id/enterprise_12345/securityClassification-6VMVochwUWo`.

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

The root folder of a Box account is always represented by the ID `0`. Example: "12345"

headers - Headers of deleteClassificationFromFolder method

getAuth

public Authentication getAuth()

getNetworkSession

public NetworkSession getNetworkSession()