com.box.sdk

Class BoxFolder.Info

Object

BoxJSONObject

BoxResource.Info

BoxItem.Info

BoxFolder.Info

Enclosing class:

BoxFolder

public class BoxFolder.Info
extends BoxItem.Info

Contains information about a BoxFolder.

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() Retrieves the allowed roles for collaborations.
List<String>	getAllowedSharedLinkAccessLevels() Retrieves the allowed access levels for a shared link.
boolean	getCanNonOwnersInvite() Gets whether or not the non-owners can invite collaborators to the folder.
BoxClassification	getClassification() Gets the metadata classification type of this folder.
boolean	getHasCollaborations() Gets whether or not the folder has any collaborations.
boolean	getIsAccessibleViaSharedLink() Returns the flag indicating whether the folder is accessible via a shared link.
boolean	getIsCollaborationRestrictedToEnterprise() Gets whether future collaborations should be restricted to within the enterprise only.
boolean	getIsExternallyOwned() Get the field is_externally_owned determining whether this folder is owned by a user outside of the enterprise.
boolean	getIsWatermarked() Gets flag indicating whether this file is Watermarked.
Metadata	getMetadata(String templateName, String scope) Gets the metadata on this folder associated with a specified scope and template.
EnumSet<BoxFolder.Permission>	getPermissions() Gets the permissions that the current user has on the folder.
BoxFolder	getResource() Gets the resource associated with this Info.
BoxFolder.SyncState	getSyncState() Gets the sync state of the folder.
BoxUploadEmail	getUploadEmail() Gets the upload email for the folder.
protected void	parseJSONMember(JsonObject.Member member) Invoked with a JSON member whenever this object is updated or created from a JSON object.
void	setCanNonOwnersInvite(boolean canNonOwnersInvite) Sets whether or not non-owners can invite collaborators to the folder.
void	setIsCollaborationRestrictedToEnterprise(boolean isRestricted) Sets whether future collaborations should be restricted to within the enterprise only.
void	setSyncState(BoxFolder.SyncState syncState) Sets the sync state of the folder.
void	setUploadEmail(BoxUploadEmail uploadEmail) Sets the upload email for the folder.

Methods inherited from class BoxItem.Info

getCollections, getContentCreatedAt, getContentModifiedAt, getCreatedAt, getCreatedBy, getDescription, 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

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

getUploadEmail

public BoxUploadEmail getUploadEmail()

Gets the upload email for the folder.

Returns:

the upload email for the folder.

setUploadEmail

public void setUploadEmail(BoxUploadEmail uploadEmail)

Sets the upload email for the folder.

Parameters:

uploadEmail - the upload email for the folder.

getHasCollaborations

public boolean getHasCollaborations()

Gets whether or not the folder has any collaborations.

Returns:

true if the folder has collaborations; otherwise false.

getSyncState

public BoxFolder.SyncState getSyncState()

Gets the sync state of the folder.

Returns:

the sync state of the folder.

setSyncState

public void setSyncState(BoxFolder.SyncState syncState)

Sets the sync state of the folder.

Parameters:

syncState - the sync state of the folder.

getPermissions

public EnumSet<BoxFolder.Permission> getPermissions()

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

Returns:

the permissions that the current user has on the folder.

getCanNonOwnersInvite

public boolean getCanNonOwnersInvite()

Gets whether or not the non-owners can invite collaborators to the folder.

Returns:

[description]

setCanNonOwnersInvite

public void setCanNonOwnersInvite(boolean canNonOwnersInvite)

Sets whether or not non-owners can invite collaborators to the folder.

Parameters:

canNonOwnersInvite - indicates non-owners can invite collaborators to the folder.

getIsCollaborationRestrictedToEnterprise

public boolean getIsCollaborationRestrictedToEnterprise()

Gets whether future collaborations should be restricted to within the enterprise only.

Returns:

indicates whether collaboration is restricted to enterprise only.

setIsCollaborationRestrictedToEnterprise

public void setIsCollaborationRestrictedToEnterprise(boolean isRestricted)

Sets whether future collaborations should be restricted to within the enterprise only.

Parameters:

isRestricted - indicates whether there is collaboration restriction within enterprise.

getAllowedInviteeRoles

public List<String> getAllowedInviteeRoles()

Retrieves the allowed roles for collaborations.

Returns:

the roles allowed for collaboration.

getAllowedSharedLinkAccessLevels

public List<String> getAllowedSharedLinkAccessLevels()

Retrieves the allowed access levels for a shared link.

Returns:

the allowed access levels for a shared link.

getIsWatermarked

public boolean getIsWatermarked()

Gets flag indicating whether this file is Watermarked.

Returns:

whether the file is watermarked or not

getMetadata

public Metadata getMetadata(String templateName,
                            String scope)

Gets the metadata on this folder 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()

Get the field is_externally_owned determining whether this folder is owned by a user outside of the enterprise.

Returns:

a boolean indicating whether this folder is owned by a user outside the enterprise.

getClassification

public BoxClassification getClassification()

Gets the metadata classification type of this folder.

Returns:

the metadata classification type of this folder.

getIsAccessibleViaSharedLink

public boolean getIsAccessibleViaSharedLink()

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

Returns:

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

getResource

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

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.