com.box.androidsdk.content.models

Class BoxItem

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

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

BoxBookmark, BoxFile, BoxFolder

public abstract class BoxItem
extends BoxEntity

Abstract class that represents a BoxItem which is the super class of BoxFolder, BoxFile, and BoxBookmark.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	FIELD_ALLOWED_SHARED_LINK_ACCESS_LEVELS
static java.lang.String	FIELD_CREATED_AT
static java.lang.String	FIELD_CREATED_BY
static java.lang.String	FIELD_DESCRIPTION
static java.lang.String	FIELD_ETAG
static java.lang.String	FIELD_ITEM_STATUS
static java.lang.String	FIELD_MODIFIED_AT
static java.lang.String	FIELD_MODIFIED_BY
static java.lang.String	FIELD_NAME
static java.lang.String	FIELD_OWNED_BY
static java.lang.String	FIELD_PARENT
static java.lang.String	FIELD_PATH_COLLECTION
static java.lang.String	FIELD_PERMISSIONS
static java.lang.String	FIELD_PURGED_AT
static java.lang.String	FIELD_SEQUENCE_ID
static java.lang.String	FIELD_SHARED_LINK
static java.lang.String	FIELD_SYNCED
static java.lang.String	FIELD_TAGS
static java.lang.String	FIELD_TRASHED_AT

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

FIELD_ID, FIELD_ITEM_ID, FIELD_ITEM_TYPE, FIELD_TYPE

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

mProperties

Constructor Summary

Constructors

Constructor and Description
BoxItem() Constructs an empty BoxItem object.
BoxItem(java.util.Map<java.lang.String,java.lang.Object> map) Constructs a BoxItem with the provided map values.

Method Summary

Methods

Modifier and Type	Method and Description
static BoxItem	createBoxItemFromJson(JsonObject json) Creates a BoxItem object from a JsonObject.
static BoxItem	createBoxItemFromJson(java.lang.String json) Creates a BoxItem object from a JSON string.
java.util.ArrayList<BoxSharedLink.Access>	getAllowedSharedLinkAccessLevels() Access level settings for shared links set by administrator.
protected java.lang.Long	getCommentCount() Gets the number of comments on the item.
protected java.util.Date	getContentCreatedAt() Gets the time that the item was created according to the uploader.
protected java.util.Date	getContentModifiedAt() Gets the time that the item was last modified according to the uploader.
java.util.Date	getCreatedAt() Gets the time the item was created.
BoxUser	getCreatedBy() Gets info about the user who created the item.
java.lang.String	getDescription() Gets the description of the item.
java.lang.String	getEtag() Gets a unique string identifying the version of the item.
java.lang.Boolean	getIsSynced() Gets whether or not this item is synced.
java.lang.String	getItemStatus() Gets the status of the item.
java.util.Date	getModifiedAt() Gets the time the item was last modified.
BoxUser	getModifiedBy() Gets info about the user who last modified the item.
java.lang.String	getName() Gets the name of the item.
BoxUser	getOwnedBy() Gets info about the user who owns the item.
BoxFolder	getParent() Gets info about the parent folder of the item.
BoxList<BoxFolder>	getPathCollection() Gets the path of folders to the item, starting at the root.
java.util.Date	getPurgedAt() Gets the time that the item was purged from the trash.
java.lang.String	getSequenceID() Gets a unique ID for use with the EventStreams.
BoxSharedLink	getSharedLink() Gets the shared link for the item.
java.lang.Long	getSize() Gets the size of the item in bytes.
java.util.Date	getTrashedAt() Gets the time that the item was trashed.
protected void	parseJSONMember(JsonObject.Member member) Invoked with a JSON member whenever this object is updated or created from a JSON object.
protected JsonValue	parseJsonObject(java.util.Map.Entry<java.lang.String,java.lang.Object> entry)

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

createEntityFromJson, createEntityFromJson, getId, getType

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

createFromJson, createFromJson, getPropertiesAsHashMap, parseNullJsonMember, toJson, toJsonObject

Methods inherited from class java.lang.Object

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

Field Detail

FIELD_NAME

public static final java.lang.String FIELD_NAME

See Also:

Constant Field Values

FIELD_SEQUENCE_ID

public static final java.lang.String FIELD_SEQUENCE_ID

See Also:

Constant Field Values

FIELD_ETAG

public static final java.lang.String FIELD_ETAG

See Also:

Constant Field Values

FIELD_CREATED_AT

public static final java.lang.String FIELD_CREATED_AT

See Also:

Constant Field Values

FIELD_MODIFIED_AT

public static final java.lang.String FIELD_MODIFIED_AT

See Also:

Constant Field Values

FIELD_DESCRIPTION

public static final java.lang.String FIELD_DESCRIPTION

See Also:

Constant Field Values

FIELD_PATH_COLLECTION

public static final java.lang.String FIELD_PATH_COLLECTION

See Also:

Constant Field Values

FIELD_CREATED_BY

public static final java.lang.String FIELD_CREATED_BY

See Also:

Constant Field Values

FIELD_MODIFIED_BY

public static final java.lang.String FIELD_MODIFIED_BY

See Also:

Constant Field Values

FIELD_TRASHED_AT

public static final java.lang.String FIELD_TRASHED_AT

See Also:

Constant Field Values

FIELD_PURGED_AT

public static final java.lang.String FIELD_PURGED_AT

See Also:

Constant Field Values

FIELD_OWNED_BY

public static final java.lang.String FIELD_OWNED_BY

See Also:

Constant Field Values

FIELD_SHARED_LINK

public static final java.lang.String FIELD_SHARED_LINK

See Also:

Constant Field Values

FIELD_PARENT

public static final java.lang.String FIELD_PARENT

See Also:

Constant Field Values

FIELD_ITEM_STATUS

public static final java.lang.String FIELD_ITEM_STATUS

See Also:

Constant Field Values

FIELD_PERMISSIONS

public static final java.lang.String FIELD_PERMISSIONS

See Also:

Constant Field Values

FIELD_SYNCED

public static final java.lang.String FIELD_SYNCED

See Also:

Constant Field Values

FIELD_ALLOWED_SHARED_LINK_ACCESS_LEVELS

public static final java.lang.String FIELD_ALLOWED_SHARED_LINK_ACCESS_LEVELS

See Also:

Constant Field Values

FIELD_TAGS

public static final java.lang.String FIELD_TAGS

See Also:

Constant Field Values

Constructor Detail

BoxItem

public BoxItem()

Constructs an empty BoxItem object.

BoxItem

public BoxItem(java.util.Map<java.lang.String,java.lang.Object> map)

Constructs a BoxItem with the provided map values.

Parameters:

map - map of keys and values of the object.

Method Detail

getEtag

public java.lang.String getEtag()

Gets a unique string identifying the version of the item.

Returns:

a unique string identifying the version of the item.

getName

public java.lang.String getName()

Gets the name of the item.

Returns:

the name of the item.

getCreatedAt

public java.util.Date getCreatedAt()

Gets the time the item was created.

Returns:

the time the item was created.

getModifiedAt

public java.util.Date getModifiedAt()

Gets the time the item was last modified.

Returns:

the time the item was last modified.

getDescription

public java.lang.String getDescription()

Gets the description of the item.

Returns:

the description of the item.

getSize

public java.lang.Long getSize()

Gets the size of the item in bytes.

Returns:

the size of the item in bytes.

getPathCollection

public BoxList<BoxFolder> getPathCollection()

Gets the path of folders to the item, starting at the root.

Returns:

the path of folders to the item.

getCreatedBy

public BoxUser getCreatedBy()

Gets info about the user who created the item.

Returns:

info about the user who created the item.

getModifiedBy

public BoxUser getModifiedBy()

Gets info about the user who last modified the item.

Returns:

info about the user who last modified the item.

getTrashedAt

public java.util.Date getTrashedAt()

Gets the time that the item was trashed.

Returns:

the time that the item was trashed.

getPurgedAt

public java.util.Date getPurgedAt()

Gets the time that the item was purged from the trash.

Returns:

the time that the item was purged from the trash.

getContentCreatedAt

protected java.util.Date getContentCreatedAt()

Gets the time that the item was created according to the uploader.

Returns:

the time that the item was created according to the uploader.

getContentModifiedAt

protected java.util.Date getContentModifiedAt()

Gets the time that the item was last modified according to the uploader.

Returns:

the time that the item was last modified according to the uploader.

getOwnedBy

public BoxUser getOwnedBy()

Gets info about the user who owns the item.

Returns:

info about the user who owns the item.

getSharedLink

public BoxSharedLink getSharedLink()

Gets the shared link for the item.

Returns:

the shared link for the item.

getSequenceID

public java.lang.String getSequenceID()

Gets a unique ID for use with the EventStreams.

Returns:

a unique ID for use with the EventStream.

getAllowedSharedLinkAccessLevels

public java.util.ArrayList<BoxSharedLink.Access> getAllowedSharedLinkAccessLevels()

Access level settings for shared links set by administrator. Can be collaborators, open, or company.

Returns:

possible access level settings for this item.

getParent

public BoxFolder getParent()

Gets info about the parent folder of the item.

Returns:

info about the parent folder of the item.

getItemStatus

public java.lang.String getItemStatus()

Gets the status of the item.

Returns:

the status of the item.

getIsSynced

public java.lang.Boolean getIsSynced()

Gets whether or not this item is synced.

Returns:

true if this item is synced, false otherwise.

getCommentCount

protected java.lang.Long getCommentCount()

Gets the number of comments on the item.

Returns:

the number of comments on the item.

parseJSONMember

protected void parseJSONMember(JsonObject.Member member)

Description copied from class: BoxJsonObject

Invoked with a JSON member whenever this object is updated or created from a JSON object.

Subclasses should override this method in order to parse any JSON members it knows about. This method is a no-op by default.

Overrides:

parseJSONMember in class BoxEntity

Parameters:

member - the JSON member to be parsed.

parseJsonObject

protected JsonValue parseJsonObject(java.util.Map.Entry<java.lang.String,java.lang.Object> entry)

Overrides:

parseJsonObject in class BoxJsonObject

createBoxItemFromJson

public static BoxItem createBoxItemFromJson(java.lang.String json)

Creates a BoxItem object from a JSON string.

Parameters:

json - JSON string to convert to a BoxItem.

Returns:

BoxItem object representing information in the JSON string.

createBoxItemFromJson

public static BoxItem createBoxItemFromJson(JsonObject json)

Creates a BoxItem object from a JsonObject.

Parameters:

json - JsonObject to convert to a BoxItem.

Returns:

BoxItem object representing information in the JsonObject.