com.box.androidsdk.content.models

Class BoxExpiringEmbedLinkFile

java.lang.Object

com.box.androidsdk.content.models.BoxObject

com.box.androidsdk.content.models.BoxJsonObject

com.box.androidsdk.content.models.BoxEntity

com.box.androidsdk.content.models.BoxItem

com.box.androidsdk.content.models.BoxFile

com.box.androidsdk.content.models.BoxExpiringEmbedLinkFile

All Implemented Interfaces:

java.io.Serializable

public class BoxExpiringEmbedLinkFile
extends BoxFile

Class that represents a file on Box that has an expiring embed link.

See Also:

Serialized Form

Nested Class Summary

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

BoxItem.Permission

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

BoxEntity.BoxEntityCreator

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	FIELD_EMBED_LINK
protected static java.lang.String	FIELD_EMBED_LINK_CREATION_TIME

Fields inherited from class com.box.androidsdk.content.models.BoxFile

ALL_FIELDS, FIELD_COMMENT_COUNT, FIELD_CONTENT_CREATED_AT, FIELD_CONTENT_MODIFIED_AT, FIELD_EXTENSION, FIELD_FILE_VERSION, FIELD_IS_PACKAGE, FIELD_REPRESENTATIONS, FIELD_SHA1, FIELD_SIZE, FIELD_VERSION_NUMBER, TYPE

Fields inherited from class com.box.androidsdk.content.models.BoxItem

FIELD_ALLOWED_SHARED_LINK_ACCESS_LEVELS, FIELD_COLLECTIONS, FIELD_CREATED_AT, FIELD_CREATED_BY, FIELD_DESCRIPTION, FIELD_ETAG, FIELD_ITEM_STATUS, FIELD_MODIFIED_AT, FIELD_MODIFIED_BY, FIELD_NAME, FIELD_OWNED_BY, FIELD_PARENT, FIELD_PATH_COLLECTION, FIELD_PERMISSIONS, FIELD_PURGED_AT, FIELD_SEQUENCE_ID, FIELD_SHARED_LINK, FIELD_SYNCED, FIELD_TAGS, FIELD_TRASHED_AT, mPermissions

Fields inherited from class com.box.androidsdk.content.models.BoxEntity

FIELD_ID, FIELD_ITEM_ID, FIELD_ITEM_TYPE, FIELD_TYPE

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	createFromJson(java.lang.String json) Serializes a json blob into a BoxJsonObject.
BoxEmbedLink	getEmbedLink() Gets the expiring embed link of the file.
java.lang.Long	getUrlCreationTime() This is the System.currentTimeMillis from the device when the server response was first parsed.
boolean	isEmbedLinkUrlExpired() Convenience method to check if 60 seconds has passed since the time this link was created.
boolean	isPreviewSessionExpired() Convenience method to check if 60 minutes has passed since the time this link was created.

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

createFromId, createFromIdAndName, getCommentCount, getContentCreatedAt, getContentModifiedAt, getExtension, getFileVersion, getIsPackage, getRepresentations, getSha1, getSize, getVersionNumber

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

createBoxItemFromJson, createBoxItemFromJson, getAllowedSharedLinkAccessLevels, getCollections, getCreatedAt, getCreatedBy, getDescription, getEtag, getIsSynced, getItemStatus, getModifiedAt, getModifiedBy, getName, getOwnedBy, getParent, getPathCollection, getPermissions, getPurgedAt, getSequenceID, getSharedLink, getTags, getTrashedAt, parsePermissions

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

addEntityType, createEntityFromJson, createEntityFromJson, getBoxJsonObjectCreator, getId, getType

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

addInJsonArray, addInJsonArray, 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_EMBED_LINK

public static final java.lang.String FIELD_EMBED_LINK

See Also:

Constant Field Values

FIELD_EMBED_LINK_CREATION_TIME

protected static final java.lang.String FIELD_EMBED_LINK_CREATION_TIME

See Also:

Constant Field Values

Constructor Detail

BoxExpiringEmbedLinkFile

public BoxExpiringEmbedLinkFile()

Constructs an empty BoxExpiringEmbedLinkFile object.

BoxExpiringEmbedLinkFile

public BoxExpiringEmbedLinkFile(com.eclipsesource.json.JsonObject object)

Constructs a BoxExpiringEmbedLinkFile with the provided map values

Parameters:

object - JsonObject representing this class

Method Detail

createFromJson

public void createFromJson(java.lang.String json)

Description copied from class: BoxJsonObject

Serializes a json blob into a BoxJsonObject.

Overrides:

createFromJson in class BoxJsonObject

Parameters:

json - json blob to deserialize.

getEmbedLink

public BoxEmbedLink getEmbedLink()

Gets the expiring embed link of the file. The URL will expire after 60 seconds and the preview session will expire after 60 minutes

Returns:

the expiring embed link of the file.

getUrlCreationTime

public java.lang.Long getUrlCreationTime()

This is the System.currentTimeMillis from the device when the server response was first parsed.

Returns:

the System.currentTimeMillis from the device when the server response was first parsed

isEmbedLinkUrlExpired

public boolean isEmbedLinkUrlExpired()

Convenience method to check if 60 seconds has passed since the time this link was created.

Returns:

false if creation time is less than 60 seconds, true otherwise.

isPreviewSessionExpired

public boolean isPreviewSessionExpired()

Convenience method to check if 60 minutes has passed since the time this link was created.

Returns:

false if creation time is less than 60 minutes, true otherwise.