ResourceList Event

Fires once for each resource returned when listing resources or versions.

Syntax

public open class DefaultBoxEventListener : BoxEventListener {
  ...
  public override fun resourceList(e: BoxResourceListEvent) {}
  ...
}

public class BoxResourceListEvent {
  val id: String?
  val name: String?
  val description: String?
  val resourceType: Int
  val createdTime: String?
  val modifiedTime: String?
  val size: Long
  val versionId: String?
  val eTag: String?
  val hash: String?
  val trashed: Boolean
  val sharedLink: String?
}

Remarks

This event fires once for each resource returned when ListResources, GetResourceInfo, Search, or ListVersions is called.

Id is the Id of the resource.

Name is the name of the resource.

Description is a description of the resource.

ResourceType reflects the resource's type. Possible values are:

CreatedTime and ModifiedTime reflect the resource's creation and last modified timestamps. Timestamps are formatted according to RFC 3339.

Size is the size of the resource (for folders, their contents' total size), in bytes.

VersionId is the version Id of the file resource. Not applicable for file resources. (Note that Box only tracks file versions for paid accounts.)

ETag is the ETag of the resource.

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

Trashed indicates whether the resource is in the trash.

SharedLink is the shared link URL for the resource. May be empty if the resource doesn't have a shared link active.