IPWorks Cloud 2020 macOS Edition

Questions / Feedback?

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 property reflects the email address of the user who created the resource.

createdTime
String

The creation timestamp of the resource.

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

description_
String

A description of the resource.

This property specifies a description of the resource.

eTag
String

The ETag of the resource.

This property reflects the ETag of the resource.

hashData
String

A SHA1 hash of the file resource's content.

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

id
String

The Id of the resource.

This property specifies the Id of the resource.

modifiedBy
String

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

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

modifiedTime
String

The last modified timestamp of the resource.

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

name
String

The name of the resource.

This property specifies the name of the resource.

owner
String

The email address of the user who owns the resource.

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

parentId
String

The Id of the resource's parent.

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

sharedLink
String

The URL of the resource's shared link.

This property 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 property 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
Bool

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

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

size
Int64

The size of the resource.

This property 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 property 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 property specifies a comma-separated list of tags applied to the resource.

trashed
Bool

Whether the resource is in the trash.

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

trashedTime
String

The trashed timestamp of the resource.

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

type
BoxResourceTypes

The resource's type.

This property 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 property 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 init()

Copyright (c) 2022 /n software inc. - All rights reserved.
IPWorks Cloud 2020 macOS Edition - Version 20.0 [Build 8265]