com.box.androidsdk.content.models

Class BoxFolder

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

All Implemented Interfaces:

java.io.Serializable

public class BoxFolder
extends BoxItem

Class that represents a folder on Box.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BoxFolder.Permission Enumerates the possible permissions that a user can have on a folder.
static class	BoxFolder.SyncState Enumerates the possible sync states that a folder can have.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String[]	ALL_FIELDS
static java.lang.String	FIELD_ALLOWED_INVITEE_ROLES
static java.lang.String	FIELD_CAN_NON_OWNERS_INVITE
static java.lang.String	FIELD_CONTENT_CREATED_AT
static java.lang.String	FIELD_CONTENT_MODIFIED_AT
static java.lang.String	FIELD_FOLDER_UPLOAD_EMAIL
static java.lang.String	FIELD_HAS_COLLABORATIONS
static java.lang.String	FIELD_IS_EXTERNALLY_OWNED
static java.lang.String	FIELD_ITEM_COLLECTION
static java.lang.String	FIELD_SIZE
static java.lang.String	FIELD_SYNC_STATE
static java.lang.String	TYPE

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

FIELD_ALLOWED_SHARED_LINK_ACCESS_LEVELS, 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

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
BoxFolder() Constructs an empty BoxFolder object.
BoxFolder(java.util.Map<java.lang.String,java.lang.Object> map) Constructs a BoxFolder with the provided map values.

Method Summary

Methods

Modifier and Type	Method and Description
static BoxFolder	createFromId(java.lang.String folderId) A convenience method to create an empty folder with just the id and type fields set.
java.util.ArrayList<BoxCollaboration.Role>	getAllowedInviteeRoles() Folder collaboration settings allowed by the enterprise administrator.
java.util.ArrayList<BoxSharedLink.Access>	getAllowedSharedLinkAccessLevels() Access level settings for shared links set by administrator.
java.lang.Boolean	getCanNonOwnersInvite() Gets whether or not the non-owners can invite collaborators to the folder.
java.util.Date	getContentCreatedAt() Gets the time that the item was created according to the uploader.
java.util.Date	getContentModifiedAt() Gets the time that the item was last modified according to the uploader.
java.lang.Boolean	getHasCollaborations() Gets whether or not the folder has any collaborations.
java.lang.Boolean	getIsExternallyOwned() Gets whether this folder is owned by a user outside of the enterprise.
BoxListItems	getItemCollection() Gets collection of mini file, folder, and bookmark objects contained in this folder.
java.util.EnumSet<BoxFolder.Permission>	getPermissions() Gets the permissions that the current user has on the folder.
java.lang.Long	getSize() Gets the size of the item in bytes.
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.

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

createBoxItemFromJson, createBoxItemFromJson, getCommentCount, getCreatedAt, getCreatedBy, getDescription, getEtag, getIsSynced, getItemStatus, getModifiedAt, getModifiedBy, getName, getOwnedBy, getParent, getPathCollection, getPurgedAt, getSequenceID, getSharedLink, getTrashedAt, parseJsonObject

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

TYPE

public static final java.lang.String TYPE

See Also:

Constant Field Values

FIELD_FOLDER_UPLOAD_EMAIL

public static final java.lang.String FIELD_FOLDER_UPLOAD_EMAIL

See Also:

Constant Field Values

FIELD_HAS_COLLABORATIONS

public static final java.lang.String FIELD_HAS_COLLABORATIONS

See Also:

Constant Field Values

FIELD_SYNC_STATE

public static final java.lang.String FIELD_SYNC_STATE

See Also:

Constant Field Values

FIELD_CAN_NON_OWNERS_INVITE

public static final java.lang.String FIELD_CAN_NON_OWNERS_INVITE

See Also:

Constant Field Values

FIELD_ITEM_COLLECTION

public static final java.lang.String FIELD_ITEM_COLLECTION

See Also:

Constant Field Values

FIELD_IS_EXTERNALLY_OWNED

public static final java.lang.String FIELD_IS_EXTERNALLY_OWNED

See Also:

Constant Field Values

FIELD_ALLOWED_INVITEE_ROLES

public static final java.lang.String FIELD_ALLOWED_INVITEE_ROLES

See Also:

Constant Field Values

FIELD_SIZE

public static final java.lang.String FIELD_SIZE

See Also:

Constant Field Values

FIELD_CONTENT_CREATED_AT

public static final java.lang.String FIELD_CONTENT_CREATED_AT

See Also:

Constant Field Values

FIELD_CONTENT_MODIFIED_AT

public static final java.lang.String FIELD_CONTENT_MODIFIED_AT

See Also:

Constant Field Values

ALL_FIELDS

public static final java.lang.String[] ALL_FIELDS

Constructor Detail

BoxFolder

public BoxFolder()

Constructs an empty BoxFolder object.

BoxFolder

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

Constructs a BoxFolder with the provided map values.

Parameters:

map - map of keys and values of the object.

Method Detail

createFromId

public static BoxFolder createFromId(java.lang.String folderId)

A convenience method to create an empty folder with just the id and type fields set. This allows the ability to interact with the content sdk in a more descriptive and type safe manner

Parameters:

folderId - the id of folder to create

Returns:

an empty BoxFolder object that only contains id and type information

getUploadEmail

public BoxUploadEmail getUploadEmail()

Gets the upload email for the folder.

Returns:

the upload email for the folder.

getHasCollaborations

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

getPermissions

public java.util.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 java.lang.Boolean getCanNonOwnersInvite()

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

Returns:

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

getItemCollection

public BoxListItems getItemCollection()

Gets collection of mini file, folder, and bookmark objects contained in this folder.

Returns:

list of mini item objects contained in the folder.

getIsExternallyOwned

public java.lang.Boolean getIsExternallyOwned()

Gets whether this folder is owned by a user outside of the enterprise.

Returns:

whether this folder is owned externally.

getAllowedSharedLinkAccessLevels

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

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

Overrides:

getAllowedSharedLinkAccessLevels in class BoxItem

Returns:

array list of access levels that are allowed by the administrator.

getAllowedInviteeRoles

public java.util.ArrayList<BoxCollaboration.Role> getAllowedInviteeRoles()

Folder collaboration settings allowed by the enterprise administrator.

Returns:

list of roles allowed for folder collaboration invitees.

getContentCreatedAt

public java.util.Date getContentCreatedAt()

Description copied from class: BoxItem

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

Overrides:

getContentCreatedAt in class BoxItem

Returns:

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

getSize

public java.lang.Long getSize()

Description copied from class: BoxItem

Gets the size of the item in bytes.

Overrides:

getSize in class BoxItem

Returns:

the size of the item in bytes.

getContentModifiedAt

public java.util.Date getContentModifiedAt()

Description copied from class: BoxItem

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

Overrides:

getContentModifiedAt in class BoxItem

Returns:

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

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

Parameters:

member - the JSON member to be parsed.