com.box.sdkgen.managers.fileclassifications

Class FileClassificationsManager

Object

FileClassificationsManager

public class FileClassificationsManager
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FileClassificationsManager.Builder

Field Summary

Fields

Modifier and Type	Field and Description
Authentication	auth
NetworkSession	networkSession

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
Classification	addClassificationToFile(String fileId) Adds a classification to a file by specifying the label of the classification to add.
Classification	addClassificationToFile(String fileId, AddClassificationToFileHeaders headers) Adds a classification to a file by specifying the label of the classification to add.
Classification	addClassificationToFile(String fileId, AddClassificationToFileRequestBody requestBody) Adds a classification to a file by specifying the label of the classification to add.
Classification	addClassificationToFile(String fileId, AddClassificationToFileRequestBody requestBody, AddClassificationToFileHeaders headers) Adds a classification to a file by specifying the label of the classification to add.
void	deleteClassificationFromFile(String fileId) Removes any classifications from a file.
void	deleteClassificationFromFile(String fileId, DeleteClassificationFromFileHeaders headers) Removes any classifications from a file.
Authentication	getAuth()
Classification	getClassificationOnFile(String fileId) Retrieves the classification metadata instance that has been applied to a file.
Classification	getClassificationOnFile(String fileId, GetClassificationOnFileHeaders headers) Retrieves the classification metadata instance that has been applied to a file.
NetworkSession	getNetworkSession()
Classification	updateClassificationOnFile(String fileId, List<UpdateClassificationOnFileRequestBody> requestBody) Updates a classification on a file.
Classification	updateClassificationOnFile(String fileId, List<UpdateClassificationOnFileRequestBody> requestBody, UpdateClassificationOnFileHeaders headers) Updates a classification on a file.

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

FileClassificationsManager

public FileClassificationsManager()

FileClassificationsManager

protected FileClassificationsManager(FileClassificationsManager.Builder builder)

Method Detail

getClassificationOnFile

public Classification getClassificationOnFile(String fileId)

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

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

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"

getClassificationOnFile

public Classification getClassificationOnFile(String fileId,
                                              GetClassificationOnFileHeaders headers)

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

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

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 getClassificationOnFile method

addClassificationToFile

public Classification addClassificationToFile(String fileId)

Adds a classification to a file 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 `/files/:id//enterprise_12345/securityClassification-6VMVochwUWo`.

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"

addClassificationToFile

public Classification addClassificationToFile(String fileId,
                                              AddClassificationToFileRequestBody requestBody)

Adds a classification to a file 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 `/files/:id//enterprise_12345/securityClassification-6VMVochwUWo`.

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"

requestBody - Request body of addClassificationToFile method

addClassificationToFile

public Classification addClassificationToFile(String fileId,
                                              AddClassificationToFileHeaders headers)

Adds a classification to a file 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 `/files/:id//enterprise_12345/securityClassification-6VMVochwUWo`.

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 addClassificationToFile method

addClassificationToFile

public Classification addClassificationToFile(String fileId,
                                              AddClassificationToFileRequestBody requestBody,
                                              AddClassificationToFileHeaders headers)

Adds a classification to a file 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 `/files/:id//enterprise_12345/securityClassification-6VMVochwUWo`.

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"

requestBody - Request body of addClassificationToFile method

headers - Headers of addClassificationToFile method

updateClassificationOnFile

public Classification updateClassificationOnFile(String fileId,
                                                 List<UpdateClassificationOnFileRequestBody> requestBody)

Updates a classification on a file.

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

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"

requestBody - Request body of updateClassificationOnFile method

updateClassificationOnFile

public Classification updateClassificationOnFile(String fileId,
                                                 List<UpdateClassificationOnFileRequestBody> requestBody,
                                                 UpdateClassificationOnFileHeaders headers)

Updates a classification on a file.

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

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"

requestBody - Request body of updateClassificationOnFile method

headers - Headers of updateClassificationOnFile method

deleteClassificationFromFile

public void deleteClassificationFromFile(String fileId)

Removes any classifications from a file.

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

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"

deleteClassificationFromFile

public void deleteClassificationFromFile(String fileId,
                                         DeleteClassificationFromFileHeaders headers)

Removes any classifications from a file.

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

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 deleteClassificationFromFile method

getAuth

public Authentication getAuth()

getNetworkSession

public NetworkSession getNetworkSession()