com.box.androidsdk.content

Class BoxApiMetadata

java.lang.Object

com.box.androidsdk.content.BoxApi

com.box.androidsdk.content.BoxApiMetadata

public class BoxApiMetadata
extends BoxApi

Represents the API of the metadata endpoint on Box. This class can be used to generate request objects for each of the APIs exposed endpoints

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	BOX_API_METADATA
static java.lang.String	BOX_API_METADATA_SCHEMA
static java.lang.String	BOX_API_METADATA_TEMPLATES
static java.lang.String	BOX_API_SCOPE_ENTERPRISE
static java.lang.String	BOX_API_SCOPE_GLOBAL

Fields inherited from class com.box.androidsdk.content.BoxApi

mBaseUploadUri, mBaseUri, mSession

Constructor Summary

Constructors

Constructor and Description
BoxApiMetadata(BoxSession session) Constructs a BoxApiMetadata with the provided BoxSession

Method Summary

Modifier and Type	Method and Description
BoxRequestsMetadata.AddFileMetadata	getAddFileMetadataRequest(java.lang.String id, java.util.LinkedHashMap<java.lang.String,java.lang.Object> values, java.lang.String scope, java.lang.String template) Gets a request that adds metadata to a file
BoxRequestsMetadata.AddItemMetadata	getAddFolderMetadataRequest(java.lang.String id, java.util.LinkedHashMap<java.lang.String,java.lang.Object> values, java.lang.String scope, java.lang.String template) Gets a request that adds metadata to a folder
BoxRequestsMetadata.AddFileMetadata	getAddMetadataRequest(java.lang.String id, java.util.LinkedHashMap<java.lang.String,java.lang.Object> values, java.lang.String scope, java.lang.String template) Deprecated.
BoxRequestsMetadata.DeleteFileMetadata	getDeleteFileMetadataTemplateRequest(java.lang.String id, java.lang.String template) Gets a request that deletes the metadata for a specific template on a file
BoxRequestsMetadata.DeleteItemMetadata	getDeleteFolderMetadataTemplateRequest(java.lang.String id, java.lang.String template) Gets a request that deletes the metadata for a specific template on a folder
BoxRequestsMetadata.DeleteFileMetadata	getDeleteMetadataTemplateRequest(java.lang.String id, java.lang.String template) Deprecated.
protected java.lang.String	getFileInfoUrl(java.lang.String id) Gets the URL for file information
BoxRequestsMetadata.GetFileMetadata	getFileMetadataRequest(java.lang.String id) Gets a request that retrieves all the metadata on a file
BoxRequestsMetadata.GetFileMetadata	getFileMetadataRequest(java.lang.String id, java.lang.String template) Gets a request that retrieves the metadata for a specific template on a file
protected java.lang.String	getFileMetadataUrl(java.lang.String id) Gets the URL for all metadata on a file
protected java.lang.String	getFileMetadataUrl(java.lang.String id, java.lang.String template)
protected java.lang.String	getFileMetadataUrl(java.lang.String id, java.lang.String scope, java.lang.String template) Gets the URL for a specific metadata template on a file (scope defaults to BOX_API_SCOPE_ENTERPRISE)
protected java.lang.String	getFilesUrl() Gets the URL for files
protected java.lang.String	getFolderInfoUrl(java.lang.String id)
BoxRequestsMetadata.GetItemMetadata	getFolderMetadataRequest(java.lang.String id) Gets a request that retrieves all the metadata on a folder
BoxRequestsMetadata.GetItemMetadata	getFolderMetadataRequest(java.lang.String id, java.lang.String template) Gets a request that retrieves the metadata for a specific template on a folder
protected java.lang.String	getFolderMetadataUrl(java.lang.String id)
protected java.lang.String	getFolderMetadataUrl(java.lang.String id, java.lang.String template)
protected java.lang.String	getFolderMetadataUrl(java.lang.String id, java.lang.String scope, java.lang.String template)
protected java.lang.String	getFoldersUrl()
BoxRequestsMetadata.GetFileMetadata	getMetadataRequest(java.lang.String id) Gets a request that retrieves all the metadata on a file
BoxRequestsMetadata.GetFileMetadata	getMetadataRequest(java.lang.String id, java.lang.String template) Deprecated.
BoxRequestsMetadata.GetMetadataTemplateSchema	getMetadataTemplateSchemaRequest(java.lang.String template)
BoxRequestsMetadata.GetMetadataTemplateSchema	getMetadataTemplateSchemaRequest(java.lang.String scope, java.lang.String template) Gets a request that retrieves a metadata template schema (scope defaults to BOX_API_SCOPE_ENTERPRISE)
BoxRequestsMetadata.GetMetadataTemplates	getMetadataTemplatesRequest() Gets a request that retrieves available metadata templates under the enterprise scope
protected java.lang.String	getMetadataTemplatesUrl()
protected java.lang.String	getMetadataTemplatesUrl(java.lang.String scope) Gets the URL for metadata templates (scope defaults to BOX_API_SCOPE_ENTERPRISE)
protected java.lang.String	getMetadataTemplatesUrl(java.lang.String scope, java.lang.String template) Gets the URL for a metadata template schema
BoxRequestsMetadata.UpdateFileMetadata	getUpdateFileMetadataRequest(java.lang.String id, java.lang.String scope, java.lang.String template) Gets a request that updates the metadata for a specific template on a file
BoxRequestsMetadata.UpdateItemMetadata	getUpdateFolderMetadataRequest(java.lang.String id, java.lang.String scope, java.lang.String template) Gets a request that updates the metadata for a specific template on a folder
BoxRequestsMetadata.UpdateFileMetadata	getUpdateMetadataRequest(java.lang.String id, java.lang.String scope, java.lang.String template) Deprecated.

Methods inherited from class com.box.androidsdk.content.BoxApi

getBaseUploadUri, getBaseUri

Methods inherited from class java.lang.Object

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

Field Detail

BOX_API_SCOPE_ENTERPRISE

public static final java.lang.String BOX_API_SCOPE_ENTERPRISE

See Also:

Constant Field Values

BOX_API_SCOPE_GLOBAL

public static final java.lang.String BOX_API_SCOPE_GLOBAL

See Also:

Constant Field Values

BOX_API_METADATA

public static final java.lang.String BOX_API_METADATA

See Also:

Constant Field Values

BOX_API_METADATA_TEMPLATES

public static final java.lang.String BOX_API_METADATA_TEMPLATES

See Also:

Constant Field Values

BOX_API_METADATA_SCHEMA

public static final java.lang.String BOX_API_METADATA_SCHEMA

See Also:

Constant Field Values

Constructor Detail

BoxApiMetadata

public BoxApiMetadata(BoxSession session)

Constructs a BoxApiMetadata with the provided BoxSession

Parameters:

session - authenticated session to use with the BoxApiMetadata

Method Detail

getFilesUrl

protected java.lang.String getFilesUrl()

Gets the URL for files

Returns:

the file URL

getFoldersUrl

protected java.lang.String getFoldersUrl()

getFileInfoUrl

protected java.lang.String getFileInfoUrl(java.lang.String id)

Gets the URL for file information

Parameters:

id - id of the file

Returns:

the file information URL

getFileMetadataUrl

protected java.lang.String getFileMetadataUrl(java.lang.String id)

Gets the URL for all metadata on a file

Parameters:

id - id of the file

Returns:

the file metadata URL

getFileMetadataUrl

protected java.lang.String getFileMetadataUrl(java.lang.String id,
                                              java.lang.String scope,
                                              java.lang.String template)

Gets the URL for a specific metadata template on a file (scope defaults to BOX_API_SCOPE_ENTERPRISE)

Parameters:

id - id of the file

scope - The scope of the object. Global and enterprise scopes are currently supported. The Global scope represent the properties template currently, while the enterprise scope pertains to custom template within the enterprise. The id of the enterprise will be appended to the enterprise scope in this format: {scope}_{ENTERPRISE_ID}

template - The key of the template. Together with "$parent" and "$scope", this forms a unique identifier for the metadata instance.

Returns:

the file metadata URL

getFileMetadataUrl

protected java.lang.String getFileMetadataUrl(java.lang.String id,
                                              java.lang.String template)

getMetadataTemplatesUrl

protected java.lang.String getMetadataTemplatesUrl(java.lang.String scope)

Gets the URL for metadata templates (scope defaults to BOX_API_SCOPE_ENTERPRISE)

Parameters:

scope - The scope of the object. Global and enterprise scopes are currently supported. The Global scope represent the properties template currently, while the enterprise scope pertains to custom template within the enterprise. The id of the enterprise will be appended to the enterprise scope in this format: {scope}_{ENTERPRISE_ID}

Returns:

the file metadata URL

getMetadataTemplatesUrl

protected java.lang.String getMetadataTemplatesUrl()

getMetadataTemplatesUrl

protected java.lang.String getMetadataTemplatesUrl(java.lang.String scope,
                                                   java.lang.String template)

Gets the URL for a metadata template schema

Parameters:

scope - The scope of the object. Global and enterprise scopes are currently supported. The Global scope represent the properties template currently, while the enterprise scope pertains to custom template within the enterprise. The id of the enterprise will be appended to the enterprise scope in this format: {scope}_{ENTERPRISE_ID}

template - The key of the template. Together with "$parent" and "$scope", this forms a unique identifier for the metadata instance.

Returns:

the metadata templates url

getFolderInfoUrl

protected java.lang.String getFolderInfoUrl(java.lang.String id)

getFolderMetadataUrl

protected java.lang.String getFolderMetadataUrl(java.lang.String id)

getFolderMetadataUrl

protected java.lang.String getFolderMetadataUrl(java.lang.String id,
                                                java.lang.String scope,
                                                java.lang.String template)

getFolderMetadataUrl

protected java.lang.String getFolderMetadataUrl(java.lang.String id,
                                                java.lang.String template)

getAddMetadataRequest

@Deprecated
public BoxRequestsMetadata.AddFileMetadata getAddMetadataRequest(java.lang.String id,
                                                                             java.util.LinkedHashMap<java.lang.String,java.lang.Object> values,
                                                                             java.lang.String scope,
                                                                             java.lang.String template)

Deprecated.

Gets a request that adds metadata to a file

Parameters:

id - id of the file to add metadata to

values - mapping of the template keys to their values

scope - currently only global and enterprise scopes are supported

template - metadata template to use

Returns:

request to add metadata to a file

getAddFileMetadataRequest

public BoxRequestsMetadata.AddFileMetadata getAddFileMetadataRequest(java.lang.String id,
                                                                     java.util.LinkedHashMap<java.lang.String,java.lang.Object> values,
                                                                     java.lang.String scope,
                                                                     java.lang.String template)

Gets a request that adds metadata to a file

Parameters:

id - id of the file to add metadata to

values - mapping of the template keys to their values

scope - currently only global and enterprise scopes are supported

template - metadata template to use

Returns:

request to add metadata to a file

getAddFolderMetadataRequest

public BoxRequestsMetadata.AddItemMetadata getAddFolderMetadataRequest(java.lang.String id,
                                                                       java.util.LinkedHashMap<java.lang.String,java.lang.Object> values,
                                                                       java.lang.String scope,
                                                                       java.lang.String template)

Gets a request that adds metadata to a folder

Parameters:

id - id of the folder to add metadata to

values - mapping of the template keys to their values

scope - currently only global and enterprise scopes are supported

template - metadata template to use

Returns:

request to add metadata to a folder

getMetadataRequest

public BoxRequestsMetadata.GetFileMetadata getMetadataRequest(java.lang.String id)

Gets a request that retrieves all the metadata on a file

Parameters:

id - id of the file to retrieve metadata for

Returns:

request to retrieve metadata on a file

getFileMetadataRequest

public BoxRequestsMetadata.GetFileMetadata getFileMetadataRequest(java.lang.String id)

Gets a request that retrieves all the metadata on a file

Parameters:

id - id of the file to retrieve metadata for

Returns:

request to retrieve metadata on a file

getFolderMetadataRequest

public BoxRequestsMetadata.GetItemMetadata getFolderMetadataRequest(java.lang.String id)

Gets a request that retrieves all the metadata on a folder

Parameters:

id - id of the folder to retrieve metadata for

Returns:

request to retrieve metadata on a folder

getMetadataRequest

@Deprecated
public BoxRequestsMetadata.GetFileMetadata getMetadataRequest(java.lang.String id,
                                                                          java.lang.String template)

Deprecated.

Gets a request that retrieves the metadata for a specific template on a file

Parameters:

id - id of the file to retrieve metadata for

template - metadata template requested

Returns:

request to retrieve metadata on a file

getFileMetadataRequest

public BoxRequestsMetadata.GetFileMetadata getFileMetadataRequest(java.lang.String id,
                                                                  java.lang.String template)

Gets a request that retrieves the metadata for a specific template on a file

Parameters:

id - id of the file to retrieve metadata for

template - metadata template requested

Returns:

request to retrieve metadata on a file

getFolderMetadataRequest

public BoxRequestsMetadata.GetItemMetadata getFolderMetadataRequest(java.lang.String id,
                                                                    java.lang.String template)

Gets a request that retrieves the metadata for a specific template on a folder

Parameters:

id - id of the folder to retrieve metadata for

template - metadata template requested

Returns:

request to retrieve metadata on a folder

getUpdateMetadataRequest

@Deprecated
public BoxRequestsMetadata.UpdateFileMetadata getUpdateMetadataRequest(java.lang.String id,
                                                                                   java.lang.String scope,
                                                                                   java.lang.String template)

Deprecated.

Gets a request that updates the metadata for a specific template on a file Deprecated: Use getUpdateFileMetadataRequest or getUpdateFolderMetadataRequest instead.

Parameters:

id - id of the file to retrieve metadata for

scope - currently only global and enterprise scopes are supported

template - metadata template to use

Returns:

request to update metadata on a file

getUpdateFileMetadataRequest

public BoxRequestsMetadata.UpdateFileMetadata getUpdateFileMetadataRequest(java.lang.String id,
                                                                           java.lang.String scope,
                                                                           java.lang.String template)

Gets a request that updates the metadata for a specific template on a file

Parameters:

id - id of the file to retrieve metadata for

scope - currently only global and enterprise scopes are supported

template - metadata template to use

Returns:

request to update metadata on a file

getUpdateFolderMetadataRequest

public BoxRequestsMetadata.UpdateItemMetadata getUpdateFolderMetadataRequest(java.lang.String id,
                                                                             java.lang.String scope,
                                                                             java.lang.String template)

Gets a request that updates the metadata for a specific template on a folder

Parameters:

id - id of the folder to retrieve metadata for

scope - currently only global and enterprise scopes are supported

template - metadata template to use

Returns:

request to update metadata on a folder

getDeleteMetadataTemplateRequest

@Deprecated
public BoxRequestsMetadata.DeleteFileMetadata getDeleteMetadataTemplateRequest(java.lang.String id,
                                                                                           java.lang.String template)

Deprecated.

Gets a request that deletes the metadata for a specific template on a file Deprecated: use getDeleteFileMetadataTemplateRequest or getDeleteFolderMetadataTemplateRequest instead.

Parameters:

id - id of the file to retrieve metadata for

template - metadata template to use

Returns:

request to delete metadata on a file

getDeleteFileMetadataTemplateRequest

public BoxRequestsMetadata.DeleteFileMetadata getDeleteFileMetadataTemplateRequest(java.lang.String id,
                                                                                   java.lang.String template)

Gets a request that deletes the metadata for a specific template on a file

Parameters:

id - id of the file to retrieve metadata for

template - metadata template to use

Returns:

request to delete metadata on a file

getDeleteFolderMetadataTemplateRequest

public BoxRequestsMetadata.DeleteItemMetadata getDeleteFolderMetadataTemplateRequest(java.lang.String id,
                                                                                     java.lang.String template)

Gets a request that deletes the metadata for a specific template on a folder

Parameters:

id - id of the folder to retrieve metadata for

template - metadata template to use

Returns:

request to delete metadata on a folder

getMetadataTemplatesRequest

public BoxRequestsMetadata.GetMetadataTemplates getMetadataTemplatesRequest()

Gets a request that retrieves available metadata templates under the enterprise scope

Returns:

request to retrieve available metadata templates

getMetadataTemplateSchemaRequest

public BoxRequestsMetadata.GetMetadataTemplateSchema getMetadataTemplateSchemaRequest(java.lang.String scope,
                                                                                      java.lang.String template)

Gets a request that retrieves a metadata template schema (scope defaults to BOX_API_SCOPE_ENTERPRISE)

Parameters:

scope - currently only global and enterprise scopes are supported

template - metadata template to use

Returns:

request to retrieve a metadata template schema

getMetadataTemplateSchemaRequest

public BoxRequestsMetadata.GetMetadataTemplateSchema getMetadataTemplateSchemaRequest(java.lang.String template)