com.box.sdk

Class BoxItem.Info

Object

BoxJSONObject

BoxResource.Info

BoxItem.Info

Direct Known Subclasses:

BoxFile.Info, BoxFolder.Info, BoxWebLink.Info

Enclosing class:

BoxItem

public abstract class BoxItem.Info
extends BoxResource.Info

Contains information about a BoxItem.

Constructor Summary

Constructors

Constructor and Description
Info() Constructs an empty Info object.
Info(String json) Constructs an Info object by parsing information from a JSON string.

Method Summary

Modifier and Type	Method and Description
Iterable<BoxCollection.Info>	getCollections() Gets info about the collections that this item belongs to.
Date	getContentCreatedAt() Gets the time that the item was created according to the uploader.
Date	getContentModifiedAt() Gets the time that the item was last modified according to the uploader.
Date	getCreatedAt() Gets the time the item was created.
BoxUser.Info	getCreatedBy() Gets info about the user who created the item.
String	getDescription() Gets the description of the item.
String	getEtag() Gets a unique string identifying the version of the item.
Date	getExpiresAt() Gets the expires at time for this item.
String	getItemStatus() Gets the status of the item.
Date	getModifiedAt() Gets the time the item was last modified.
BoxUser.Info	getModifiedBy() Gets info about the user who last modified the item.
String	getName() Gets the name of the item.
BoxUser.Info	getOwnedBy() Gets info about the user who owns the item.
BoxFolder.Info	getParent() Gets info about the parent folder of the item.
List<BoxFolder.Info>	getPathCollection() Gets the path of folders to the item, starting at the root.
Date	getPurgedAt() Gets the time that the item was purged from the trash.
String	getSequenceID() Gets a unique ID for use with the EventStream.
BoxSharedLink	getSharedLink() Gets the shared link for the item.
long	getSize() Gets the size of the item in bytes.
List<String>	getTags() Gets a list of all the tags applied to the item.
Date	getTrashedAt() Gets the time that the item was trashed.
String	getType() Gets the item type.
protected void	parseJSONMember(JsonObject.Member member) Invoked with a JSON member whenever this object is updated or created from a JSON object.
void	removeSharedLink() Removes the shared link for the item.
void	setCollections(Iterable<BoxCollection> collections) Sets the collections that this item belongs to.
void	setDescription(String description) Sets the description of the item.
void	setName(String name) Sets the name of the item.
void	setSharedLink(BoxSharedLink sharedLink) Sets a shared link for the item.
void	setTags(List<String> tags) Sets the tags for an item.

Methods inherited from class BoxResource.Info

getID, getResource

Methods inherited from class BoxJSONObject

clearPendingChanges, getJson, getPendingChanges, getPendingChangesAsJsonObject, getPendingJSONObject

Methods inherited from class Object

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

Constructor Detail

Info

public Info()

Constructs an empty Info object.

Info

public Info(String json)

Constructs an Info object by parsing information from a JSON string.

Parameters:

json - the JSON string to parse.

Method Detail

getType

public String getType()

Gets the item type.

Returns:

the item's type.

getEtag

public String getEtag()

Gets a unique string identifying the version of the item.

Returns:

a unique string identifying the version of the item.

getName

public String getName()

Gets the name of the item.

Returns:

the name of the item.

setName

public void setName(String name)

Sets the name of the item.

Parameters:

name - the new name of the item.

getCreatedAt

public Date getCreatedAt()

Gets the time the item was created.

Returns:

the time the item was created.

getModifiedAt

public Date getModifiedAt()

Gets the time the item was last modified.

Returns:

the time the item was last modified.

getDescription

public String getDescription()

Gets the description of the item.

Returns:

the description of the item.

setDescription

public void setDescription(String description)

Sets the description of the item.

Parameters:

description - the new description of the item.

getSize

public long getSize()

Gets the size of the item in bytes.

Returns:

the size of the item in bytes.

getPathCollection

public List<BoxFolder.Info> getPathCollection()

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

Returns:

the path of folders to the item.

getCreatedBy

public BoxUser.Info getCreatedBy()

Gets info about the user who created the item.

Returns:

info about the user who created the item.

getModifiedBy

public BoxUser.Info getModifiedBy()

Gets info about the user who last modified the item.

Returns:

info about the user who last modified the item.

getTrashedAt

public Date getTrashedAt()

Gets the time that the item was trashed.

Returns:

the time that the item was trashed.

getPurgedAt

public 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

public 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

public 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.

getExpiresAt

public Date getExpiresAt()

Gets the expires at time for this item.

Returns:

the time that the item will expire at.

getOwnedBy

public BoxUser.Info 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.

setSharedLink

public void setSharedLink(BoxSharedLink sharedLink)

Sets a shared link for the item.

Parameters:

sharedLink - the shared link for the item.

removeSharedLink

public void removeSharedLink()

Removes the shared link for the item.

getSequenceID

public String getSequenceID()

Gets a unique ID for use with the EventStream.

Returns:

a unique ID for use with the EventStream.

getTags

public List<String> getTags()

Gets a list of all the tags applied to the item.

Note that this field isn't populated by default and must be specified as a field parameter when getting Info about the item.

Returns:

a list of all the tags applied to the item.

setTags

public void setTags(List<String> tags)

Sets the tags for an item.

Parameters:

tags - The new tags for the item.

getParent

public BoxFolder.Info getParent()

Gets info about the parent folder of the item.

Returns:

info about the parent folder of the item.

getItemStatus

public String getItemStatus()

Gets the status of the item.

Returns:

the status of the item.

getCollections

public Iterable<BoxCollection.Info> getCollections()

Gets info about the collections that this item belongs to.

Returns:

info about the collections that this item belongs to.

setCollections

public void setCollections(Iterable<BoxCollection> collections)

Sets the collections that this item belongs to.

Parameters:

collections - the new list of collections that this item should belong to.

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.

Parameters:

member - the JSON member to be parsed.