BoxResource Type

A Box resource.

Remarks

This type represents a Box resource.

Fields

CreatedBy
String?

The email address of the user who created the resource.

This field reflects the email address of the user who created the resource.

CreatedTime
String?

The creation timestamp of the resource.

This field reflects the creation timestamp of the resource. Timestamps are formatted according to RFC 3339.

Description
String?

A description of the resource.

This field specifies a description of the resource.

ETag
String?

The ETag of the resource.

This field reflects the ETag of the resource.

Hash
String?

A SHA1 hash of the file resource's content.

This field holds a SHA1 hash of the file resource's content. Not applicable for folder resources.

Id
String?

The Id of the resource.

This field specifies the Id of the resource.

ModifiedBy
String?

The email address of the user who last modified the resource.

This field reflects the email address of the user who last modified the resource.

ModifiedTime
String?

The last modified timestamp of the resource.

This field reflects the last modified timestamp of the resource. Timestamps are formatted according to RFC 3339.

Name
String?

The name of the resource.

This field specifies the name of the resource.

Owner
String?

The email address of the user who owns the resource.

This field reflects the email address of the user who owns the resource.

ParentId
String?

The Id of the resource's parent.

This field specifies the Id of the resource's parent.

SharedLink
String?

The URL of the resource's shared link.

This field holds the URL of the resource's shared link, or empty string if the resource doesn't currently have an active shared link.

SharedLinkAccess
BoxSharedLinkAccess

Access level afforded by the resource's shared link.

This field reflects the access level that the resource's SharedLink provides. Possible values are:


0 (slaOpen - default)	Anyone can access the resource using the link.
1 (slaCompany)	Only members of the company can access the resource using the link.
2 (slaCollaborators)	Only members of the folder the resource is in can access the resource using the link.

SharedLinkProtected
Boolean

Whether the resource's shared link is password-protected.

This field indicates whether the resource's shared link is password-protected.

Size
Long

The size of the resource.

This field reflects the size of the resource, in bytes. For folder resources, this is the total size of everything within the folder.

SyncState
BoxResourceSyncStates

The sync state of the folder resource.

This field specifies the sync state of the folder resource. Not applicable for file resources. Possible values are:


0 (ssUndefined - default)	The sync state is undefined. This is the only valid value for file resources, and is also used if a folder resource's sync state is unknown.
1 (ssSynced)	The folder resource is fully synced.
2 (ssNotSynced)	The folder resource is not synced.
3 (ssPartiallySynced)	Only parts of the folder resource's contents are synced.

Tags
String?

Tags applied to the resource.

This field specifies a comma-separated list of tags applied to the resource.

Trashed
Boolean

Whether the resource is in the trash.

This field indicates whether the resource has been moved to trash.

TrashedTime
String?

The trashed timestamp of the resource.

This field reflects the trashed timestamp of the resource. Timestamps are formatted according to RFC 3339.

Type
BoxResourceTypes

The resource's type.

This field indicates whether the resource is a folder or a file. Possible values are:


0 (brtFile)	A file.
1 (brtFolder)	A folder.

VersionId
String?

The version Id of the file resource.

This field reflects the version Id of the file resource. Not applicable for folder resources.

Note that Box only tracks file versions for paid accounts.

Constructors

public constructor()

IPWorks Cloud 2020 Kotlin Edition

BoxResource Type

Remarks

Fields

Constructors