com.box.sdk

Class BoxFile.Info

Object

BoxJSONObject

BoxResource.Info

BoxItem.Info

BoxFile.Info

Enclosing class:

BoxFile

public class BoxFile.Info
extends BoxItem.Info

Contains information about a BoxFile.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
List<String>	getAllowedInviteeRoles() Returns the allowed invitee roles for this file item.
BoxClassification	getClassification() Gets the metadata classification type of this file.
long	getCommentCount() Gets the number of comments on the file.
Date	getDispositionAt() Returns the retention expiration timestamp for the given file.
String	getExtension() Gets the extension suffix of the file, excluding the dot.
Boolean	getHasCollaborations() Returns the indicator for whether this file item has collaborations.
boolean	getIsAccessibleViaSharedLink() Returns the flag indicating whether the file is accessible via a shared link.
boolean	getIsExternallyOwned() Returns the field for indicating whether a file is owned by a user outside the enterprise.
boolean	getIsPackage() Gets whether or not the file is an OSX package.
boolean	getIsWatermarked() Gets flag indicating whether this file is Watermarked.
BoxLock	getLock() Gets the lock of the file.
Metadata	getMetadata(String templateName, String scope) Gets the metadata on this file associated with a specified scope and template.
EnumSet<BoxFile.Permission>	getPermissions() Gets the permissions that the current user has on the file.
URL	getPreviewLink() Gets the current expiring preview link.
List<Representation>	getRepresentations() Get file's representations.
BoxFile	getResource() Gets the resource associated with this Info.
String	getSha1() Gets the SHA1 hash of the file.
String	getUploaderDisplayName() Returns user's name at the time of upload.
BoxFileVersion	getVersion() Gets the current version details of the file.
String	getVersionNumber() Gets the current version number of the file.
protected void	parseJSONMember(JsonObject.Member member) Invoked with a JSON member whenever this object is updated or created from a JSON object.
void	setDispositionAt(Date dispositionAt) Modifies the retention expiration timestamp for the given file.

Methods inherited from class BoxItem.Info

getCollections, getContentCreatedAt, getContentModifiedAt, getCreatedAt, getCreatedBy, getDescription, getDownloadUrl, getEtag, getExpiresAt, getItemStatus, getModifiedAt, getModifiedBy, getName, getOwnedBy, getParent, getPathCollection, getPurgedAt, getSequenceID, getSharedLink, getSize, getTags, getTrashedAt, getType, removeSharedLink, setCollections, setDescription, setName, setSharedLink, setTags

Methods inherited from class BoxResource.Info

getID

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.

Info

public Info(JsonObject jsonObject)

Constructs an Info object using an already parsed JSON object.

Parameters:

jsonObject - the parsed JSON object.

Method Detail

getResource

public BoxFile getResource()

Description copied from class: BoxResource.Info

Gets the resource associated with this Info.

Specified by:

getResource in class BoxResource.Info

Returns:

the associated resource.

getSha1

public String getSha1()

Gets the SHA1 hash of the file.

Returns:

the SHA1 hash of the file.

getLock

public BoxLock getLock()

Gets the lock of the file.

Returns:

the lock of the file.

getVersionNumber

public String getVersionNumber()

Gets the current version number of the file.

Returns:

the current version number of the file.

getCommentCount

public long getCommentCount()

Gets the number of comments on the file.

Returns:

the number of comments on the file.

getPermissions

public EnumSet<BoxFile.Permission> getPermissions()

Gets the permissions that the current user has on the file.

Returns:

the permissions that the current user has on the file.

getExtension

public String getExtension()

Gets the extension suffix of the file, excluding the dot.

Returns:

the extension of the file.

getIsPackage

public boolean getIsPackage()

Gets whether or not the file is an OSX package.

Returns:

true if the file is an OSX package; otherwise false.

getVersion

public BoxFileVersion getVersion()

Gets the current version details of the file.

Returns:

the current version details of the file.

getPreviewLink

public URL getPreviewLink()

Gets the current expiring preview link.

Returns:

the expiring preview link

getIsWatermarked

public boolean getIsWatermarked()

Gets flag indicating whether this file is Watermarked.

Returns:

whether the file is watermarked or not

getAllowedInviteeRoles

public List<String> getAllowedInviteeRoles()

Returns the allowed invitee roles for this file item.

Returns:

the list of roles allowed for invited collaborators.

getHasCollaborations

public Boolean getHasCollaborations()

Returns the indicator for whether this file item has collaborations.

Returns:

indicator for whether this file item has collaborations.

getMetadata

public Metadata getMetadata(String templateName,
                            String scope)

Gets the metadata on this file associated with a specified scope and template. Makes an attempt to get metadata that was retrieved using getInfo(String ...) method.

Parameters:

templateName - the metadata template type name.

scope - the scope of the template (usually "global" or "enterprise").

Returns:

the metadata returned from the server.

getIsExternallyOwned

public boolean getIsExternallyOwned()

Returns the field for indicating whether a file is owned by a user outside the enterprise.

Returns:

indicator for whether or not the file is owned by a user outside the enterprise.

getRepresentations

public List<Representation> getRepresentations()

Get file's representations.

Returns:

list of representations

getUploaderDisplayName

public String getUploaderDisplayName()

Returns user's name at the time of upload.

Returns:

user's name at the time of upload

getClassification

public BoxClassification getClassification()

Gets the metadata classification type of this file.

Returns:

the metadata classification type of this file.

getDispositionAt

public Date getDispositionAt()

Returns the retention expiration timestamp for the given file.

Returns:

Date representing expiration timestamp

setDispositionAt

public void setDispositionAt(Date dispositionAt)

Modifies the retention expiration timestamp for the given file. This date cannot be shortened once set on a file.

Parameters:

dispositionAt - Date representing expiration timestamp

getIsAccessibleViaSharedLink

public boolean getIsAccessibleViaSharedLink()

Returns the flag indicating whether the file is accessible via a shared link.

Returns:

boolean flag indicating whether the file is accessible via a shared link.

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 BoxItem.Info

Parameters:

member - the JSON member to be parsed.