com.box.sdkgen.managers.foldermetadata

Class FolderMetadataManager

Object

FolderMetadataManager

public class FolderMetadataManager
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FolderMetadataManager.Builder

Field Summary

Fields

Modifier and Type	Field and Description
Authentication	auth
NetworkSession	networkSession

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
MetadataFull	createFolderMetadataById(String folderId, CreateFolderMetadataByIdScope scope, String templateKey, Map<String,Object> requestBody) Applies an instance of a metadata template to a folder.
MetadataFull	createFolderMetadataById(String folderId, CreateFolderMetadataByIdScope scope, String templateKey, Map<String,Object> requestBody, CreateFolderMetadataByIdHeaders headers) Applies an instance of a metadata template to a folder.
void	deleteFolderMetadataById(String folderId, DeleteFolderMetadataByIdScope scope, String templateKey) Deletes a piece of folder metadata.
void	deleteFolderMetadataById(String folderId, DeleteFolderMetadataByIdScope scope, String templateKey, DeleteFolderMetadataByIdHeaders headers) Deletes a piece of folder metadata.
Authentication	getAuth()
Metadatas	getFolderMetadata(String folderId) Retrieves all metadata for a given folder.
Metadatas	getFolderMetadata(String folderId, GetFolderMetadataHeaders headers) Retrieves all metadata for a given folder.
Metadatas	getFolderMetadata(String folderId, GetFolderMetadataQueryParams queryParams) Retrieves all metadata for a given folder.
Metadatas	getFolderMetadata(String folderId, GetFolderMetadataQueryParams queryParams, GetFolderMetadataHeaders headers) Retrieves all metadata for a given folder.
MetadataFull	getFolderMetadataById(String folderId, GetFolderMetadataByIdScope scope, String templateKey) Retrieves the instance of a metadata template that has been applied to a folder.
MetadataFull	getFolderMetadataById(String folderId, GetFolderMetadataByIdScope scope, String templateKey, GetFolderMetadataByIdHeaders headers) Retrieves the instance of a metadata template that has been applied to a folder.
NetworkSession	getNetworkSession()
MetadataFull	updateFolderMetadataById(String folderId, UpdateFolderMetadataByIdScope scope, String templateKey, List<UpdateFolderMetadataByIdRequestBody> requestBody) Updates a piece of metadata on a folder.
MetadataFull	updateFolderMetadataById(String folderId, UpdateFolderMetadataByIdScope scope, String templateKey, List<UpdateFolderMetadataByIdRequestBody> requestBody, UpdateFolderMetadataByIdHeaders headers) Updates a piece of metadata 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

FolderMetadataManager

public FolderMetadataManager()

FolderMetadataManager

protected FolderMetadataManager(FolderMetadataManager.Builder builder)

Method Detail

getFolderMetadata

public Metadatas getFolderMetadata(String folderId)

Retrieves all metadata for a given folder. This can not be used on the root folder with ID `0`.

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"

getFolderMetadata

public Metadatas getFolderMetadata(String folderId,
                                   GetFolderMetadataQueryParams queryParams)

Retrieves all metadata for a given folder. This can not be used on the root folder with ID `0`.

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"

queryParams - Query parameters of getFolderMetadata method

getFolderMetadata

public Metadatas getFolderMetadata(String folderId,
                                   GetFolderMetadataHeaders headers)

Retrieves all metadata for a given folder. This can not be used on the root folder with ID `0`.

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

getFolderMetadata

public Metadatas getFolderMetadata(String folderId,
                                   GetFolderMetadataQueryParams queryParams,
                                   GetFolderMetadataHeaders headers)

Retrieves all metadata for a given folder. This can not be used on the root folder with ID `0`.

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"

queryParams - Query parameters of getFolderMetadata method

headers - Headers of getFolderMetadata method

getFolderMetadataById

public MetadataFull getFolderMetadataById(String folderId,
                                          GetFolderMetadataByIdScope scope,
                                          String templateKey)

Retrieves the instance of a metadata template that has been applied to a folder. This can not be used on the root folder with ID `0`.

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"

scope - The scope of the metadata template. Example: "global"

templateKey - The name of the metadata template. Example: "properties"

getFolderMetadataById

public MetadataFull getFolderMetadataById(String folderId,
                                          GetFolderMetadataByIdScope scope,
                                          String templateKey,
                                          GetFolderMetadataByIdHeaders headers)

Retrieves the instance of a metadata template that has been applied to a folder. This can not be used on the root folder with ID `0`.

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"

scope - The scope of the metadata template. Example: "global"

templateKey - The name of the metadata template. Example: "properties"

headers - Headers of getFolderMetadataById method

createFolderMetadataById

public MetadataFull createFolderMetadataById(String folderId,
                                             CreateFolderMetadataByIdScope scope,
                                             String templateKey,
                                             Map<String,Object> requestBody)

Applies an instance of a metadata template to a folder.

In most cases only values that are present in the metadata template will be accepted, except for the `global.properties` template which accepts any key-value pair.

To display the metadata template in the Box web app the enterprise needs to be configured to enable **Cascading Folder Level Metadata** for the user in the admin console.

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"

scope - The scope of the metadata template. Example: "global"

templateKey - The name of the metadata template. Example: "properties"

requestBody - Request body of createFolderMetadataById method

createFolderMetadataById

public MetadataFull createFolderMetadataById(String folderId,
                                             CreateFolderMetadataByIdScope scope,
                                             String templateKey,
                                             Map<String,Object> requestBody,
                                             CreateFolderMetadataByIdHeaders headers)

Applies an instance of a metadata template to a folder.

In most cases only values that are present in the metadata template will be accepted, except for the `global.properties` template which accepts any key-value pair.

To display the metadata template in the Box web app the enterprise needs to be configured to enable **Cascading Folder Level Metadata** for the user in the admin console.

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"

scope - The scope of the metadata template. Example: "global"

templateKey - The name of the metadata template. Example: "properties"

requestBody - Request body of createFolderMetadataById method

headers - Headers of createFolderMetadataById method

updateFolderMetadataById

public MetadataFull updateFolderMetadataById(String folderId,
                                             UpdateFolderMetadataByIdScope scope,
                                             String templateKey,
                                             List<UpdateFolderMetadataByIdRequestBody> requestBody)

Updates a piece of metadata on a folder.

The metadata instance can only be updated if the template has already been applied to the folder before. When editing metadata, only values that match the metadata template schema will be accepted.

The update is applied atomically. If any errors occur during the application of the operations, the metadata instance will not be changed.

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"

scope - The scope of the metadata template. Example: "global"

templateKey - The name of the metadata template. Example: "properties"

requestBody - Request body of updateFolderMetadataById method

updateFolderMetadataById

public MetadataFull updateFolderMetadataById(String folderId,
                                             UpdateFolderMetadataByIdScope scope,
                                             String templateKey,
                                             List<UpdateFolderMetadataByIdRequestBody> requestBody,
                                             UpdateFolderMetadataByIdHeaders headers)

Updates a piece of metadata on a folder.

The metadata instance can only be updated if the template has already been applied to the folder before. When editing metadata, only values that match the metadata template schema will be accepted.

The update is applied atomically. If any errors occur during the application of the operations, the metadata instance will not be changed.

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"

scope - The scope of the metadata template. Example: "global"

templateKey - The name of the metadata template. Example: "properties"

requestBody - Request body of updateFolderMetadataById method

headers - Headers of updateFolderMetadataById method

deleteFolderMetadataById

public void deleteFolderMetadataById(String folderId,
                                     DeleteFolderMetadataByIdScope scope,
                                     String templateKey)

Deletes a piece of folder metadata.

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"

scope - The scope of the metadata template. Example: "global"

templateKey - The name of the metadata template. Example: "properties"

deleteFolderMetadataById

public void deleteFolderMetadataById(String folderId,
                                     DeleteFolderMetadataByIdScope scope,
                                     String templateKey,
                                     DeleteFolderMetadataByIdHeaders headers)

Deletes a piece of folder metadata.

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"

scope - The scope of the metadata template. Example: "global"

templateKey - The name of the metadata template. Example: "properties"

headers - Headers of deleteFolderMetadataById method

getAuth

public Authentication getAuth()

getNetworkSession

public NetworkSession getNetworkSession()