com.box.sdk

Class Representation

Object

Representation

public class Representation
extends Object

The class represents one instance of a file representation.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	Representation.Content Representation's content.
class	Representation.Info Representation's info URL.
class	Representation.Metadata Representation's metadata which is a set of dynamic properties about this specific representation of this specific file.
class	Representation.Properties A set of static properties to distinguish between subtypes of a given representation, for example, different sizes of jpg's.
class	Representation.Status Representation's status.

Constructor Summary

Constructors

Constructor and Description
Representation(JsonObject representationJson) Construct a representation from JsonObject.

Method Summary

Modifier and Type	Method and Description
String	getAssetPath() Get representation's asset path.
Representation.Content	getContent() Get representation's content which includes a url template.
Representation.Info	getInfo() Get Info which has an opaque URL which will return status information about the file.
Representation.Metadata	getMetadata() Get representation's metadata.
Representation.Properties	getProperties() Get representation's set of static properties to distinguish between subtypes of a given representation, for example, different sizes of jpg's.
String	getRepresentation() Get the extension of the format, but occasionally a name of a standard (potentially de facto) format or a proprietary format that Box supports.
Representation.Status	getStatus() A string with one of the following values: 'none', 'pending', 'viewable', 'error' and 'success'.

Methods inherited from class Object

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

Constructor Detail

Representation

public Representation(JsonObject representationJson)

Construct a representation from JsonObject.

Parameters:

representationJson - representaion entry

Method Detail

getRepresentation

public String getRepresentation()

Get the extension of the format, but occasionally a name of a standard (potentially de facto) format or a proprietary format that Box supports.

Returns:

representation name

getProperties

public Representation.Properties getProperties()

Get representation's set of static properties to distinguish between subtypes of a given representation, for example, different sizes of jpg's. Each representation has its own set of properties.

Returns:

properties of representation

getMetadata

public Representation.Metadata getMetadata()

Get representation's metadata.

Returns:

metadata

getAssetPath

public String getAssetPath()

Get representation's asset path.

Returns:

The values used to substitute for asset_path in the content.url_template.

getInfo

public Representation.Info getInfo()

Get Info which has an opaque URL which will return status information about the file. It may change over time and should not be hard-coded or cached.

Returns:

info

getContent

public Representation.Content getContent()

Get representation's content which includes a url template.

Returns:

content

getStatus

public Representation.Status getStatus()

A string with one of the following values: 'none', 'pending', 'viewable', 'error' and 'success'.

Returns:

status