BoxRepresentation (box-content-sdk 4.2.3 API)

java.lang.Object
- com.box.androidsdk.content.models.BoxObject
- - com.box.androidsdk.content.models.BoxJsonObject
  - - com.box.androidsdk.content.models.BoxRepresentation

All Implemented Interfaces:

java.io.Serializable
```
public class BoxRepresentation
extends BoxJsonObject
```
Class that represents a file representation.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`BoxRepresentation.BoxRepContent`
`static class`	`BoxRepresentation.BoxRepPropertiesMap`
`static class`	`BoxRepresentation.BoxRepStatus`

Nested classes/interfaces inherited from class com.box.androidsdk.content.models.BoxJsonObject
BoxJsonObject.BoxJsonObjectCreator<E extends BoxJsonObject>

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`DIMENSION_1024`
`static java.lang.String`	`DIMENSION_160`
`static java.lang.String`	`DIMENSION_2048`
`static java.lang.String`	`DIMENSION_32` Supported sizes for images representation (Please note that not all of them are available on every file, refer to the documentation)
`static java.lang.String`	`DIMENSION_320`
`static java.lang.String`	`DIMENSION_94`
`protected static java.lang.String`	`FIELD_CONTENT`
`protected static java.lang.String`	`FIELD_INFO`
`protected static java.lang.String`	`FIELD_PROPERTIES`
`protected static java.lang.String`	`FIELD_REPRESENTATION`
`protected static java.lang.String`	`FIELD_STATUS`
`static java.lang.String`	`REP_HINTS_HEADER` Http header to inform the server on which representations you are interested This header can be used for instance when retrieving the file info or a folder.
`static java.lang.String`	`TYPE_DASH`
`static java.lang.String`	`TYPE_FILMSTRIP`
`static java.lang.String`	`TYPE_JPG` Supported Representation types
`static java.lang.String`	`TYPE_MP3`
`static java.lang.String`	`TYPE_MP4`
`static java.lang.String`	`TYPE_PDF`
`static java.lang.String`	`TYPE_PNG`
`static java.lang.String`	`TYPE_TEXT`

Constructor Summary

Constructors
Constructor and Description
`BoxRepresentation()` Constructs an empty BoxExpiringEmbedLinkFile object.
`BoxRepresentation(com.eclipsesource.json.JsonObject object)` Constructs a BoxRepresentation with the provided map values

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`BoxRepresentation.BoxRepContent`	`getContent()`
`BoxEmbedLink`	`getInfo()`
`BoxRepresentation.BoxRepPropertiesMap`	`getProperties()`
`static java.lang.String`	`getRepresentationHintString(java.lang.String repType, java.lang.String repSize)` Helper method to generate representation hint string
`java.lang.String`	`getRepresentationType()` Retrieves the representation type.
`BoxRepresentation.BoxRepStatus`	`getStatus()`

Methods inherited from class com.box.androidsdk.content.models.BoxJsonObject
addInJsonArray, addInJsonArray, createFromJson, createFromJson, equals, getBoxJsonObjectCreator, getPropertiesKeySet, getPropertyAsBoolean, getPropertyAsDate, getPropertyAsDouble, getPropertyAsFloat, getPropertyAsInt, getPropertyAsJsonArray, getPropertyAsJsonObject, getPropertyAsJsonObjectArray, getPropertyAsLong, getPropertyAsString, getPropertyAsStringArray, getPropertyAsStringHashSet, getPropertyValue, hashCode, parseJSONMember, remove, set, set, set, set, set, set, set, set, set, toJson, toJsonObject

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - FIELD_REPRESENTATION
```
protected static final java.lang.String FIELD_REPRESENTATION
```
    See Also:
    
    Constant Field Values
  - FIELD_PROPERTIES
```
protected static final java.lang.String FIELD_PROPERTIES
```
    See Also:
    
    Constant Field Values
  - FIELD_STATUS
```
protected static final java.lang.String FIELD_STATUS
```
    See Also:
    
    Constant Field Values
  - FIELD_CONTENT
```
protected static final java.lang.String FIELD_CONTENT
```
    See Also:
    
    Constant Field Values
  - FIELD_INFO
```
protected static final java.lang.String FIELD_INFO
```
    See Also:
    
    Constant Field Values
  - TYPE_JPG
```
public static final java.lang.String TYPE_JPG
```
    Supported Representation types
    
    See Also:
    
    Constant Field Values
  - TYPE_PNG
```
public static final java.lang.String TYPE_PNG
```
    See Also:
    
    Constant Field Values
  - TYPE_PDF
```
public static final java.lang.String TYPE_PDF
```
    See Also:
    
    Constant Field Values
  - TYPE_TEXT
```
public static final java.lang.String TYPE_TEXT
```
    See Also:
    
    Constant Field Values
  - TYPE_MP4
```
public static final java.lang.String TYPE_MP4
```
    See Also:
    
    Constant Field Values
  - TYPE_DASH
```
public static final java.lang.String TYPE_DASH
```
    See Also:
    
    Constant Field Values
  - TYPE_FILMSTRIP
```
public static final java.lang.String TYPE_FILMSTRIP
```
    See Also:
    
    Constant Field Values
  - TYPE_MP3
```
public static final java.lang.String TYPE_MP3
```
    See Also:
    
    Constant Field Values
  - DIMENSION_32
```
public static final java.lang.String DIMENSION_32
```
    Supported sizes for images representation (Please note that not all of them are available on every file, refer to the documentation)
    
    See Also:
    
    Constant Field Values
  - DIMENSION_94
```
public static final java.lang.String DIMENSION_94
```
    See Also:
    
    Constant Field Values
  - DIMENSION_160
```
public static final java.lang.String DIMENSION_160
```
    See Also:
    
    Constant Field Values
  - DIMENSION_320
```
public static final java.lang.String DIMENSION_320
```
    See Also:
    
    Constant Field Values
  - DIMENSION_1024
```
public static final java.lang.String DIMENSION_1024
```
    See Also:
    
    Constant Field Values
  - DIMENSION_2048
```
public static final java.lang.String DIMENSION_2048
```
    See Also:
    
    Constant Field Values
  - REP_HINTS_HEADER
```
public static final java.lang.String REP_HINTS_HEADER
```
    Http header to inform the server on which representations you are interested This header can be used for instance when retrieving the file info or a folder.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - BoxRepresentation
```
public BoxRepresentation()
```
    Constructs an empty BoxExpiringEmbedLinkFile object.
  - BoxRepresentation
```
public BoxRepresentation(com.eclipsesource.json.JsonObject object)
```
    Constructs a BoxRepresentation with the provided map values
    
    Parameters:
    
    object - JsonObject representing this class
- Method Detail
  - getRepresentationType
```
public java.lang.String getRepresentationType()
```
    Retrieves the representation type.
    
    Returns:
    
    a string for this representation type
  - getProperties
```
public BoxRepresentation.BoxRepPropertiesMap getProperties()
```
    Returns:
    
    a map of key value pairs with properties about this representation.
  - getStatus
```
public BoxRepresentation.BoxRepStatus getStatus()
```
    Returns:
    
    a string status of this representation such as pending or success.
  - getInfo
```
public BoxEmbedLink getInfo()
```
    Returns:
    
    url to get additional information about this representation.
  - getContent
```
public BoxRepresentation.BoxRepContent getContent()
```
    Returns:
    
    the main content (link) associated with this link.
  - getRepresentationHintString
```
public static java.lang.String getRepresentationHintString(java.lang.String repType,
                                                           java.lang.String repSize)
```
    Helper method to generate representation hint string
    
    Parameters:
    
    repType - the type of representation
    
    repSize - the size of representation, used for image types. (please refer to dimension string
    
    Returns:
    
    string that can be used on server requests hinting the type of representation to return

Class BoxRepresentation

Nested Class Summary

Nested classes/interfaces inherited from class com.box.androidsdk.content.models.BoxJsonObject

Field Summary

Constructor Summary

Method Summary

Methods inherited from class com.box.androidsdk.content.models.BoxJsonObject

Methods inherited from class java.lang.Object

Field Detail

FIELD_REPRESENTATION

FIELD_PROPERTIES

FIELD_STATUS

FIELD_CONTENT

FIELD_INFO

TYPE_JPG

TYPE_PNG

TYPE_PDF

TYPE_TEXT

TYPE_MP4

TYPE_DASH

TYPE_FILMSTRIP

TYPE_MP3

DIMENSION_32

DIMENSION_94

DIMENSION_160

DIMENSION_320

DIMENSION_1024

DIMENSION_2048

REP_HINTS_HEADER

Constructor Detail

BoxRepresentation

BoxRepresentation

Method Detail

getRepresentationType

getProperties

getStatus

getInfo

getContent

getRepresentationHintString