ResourceList Event

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

Syntax

• C#
• VB.NET

public event OnResourceListHandler OnResourceList;

public delegate void OnResourceListHandler(object sender, BoxResourceListEventArgs e);

public class BoxResourceListEventArgs : EventArgs {
  public string Id { get; }
  public string Name { get; }
  public string Description { get; }
  public int ResourceType { get; }
  public string CreatedTime { get; }
  public string ModifiedTime { get; }
  public long Size { get; }
  public string VersionId { get; }
  public string ETag { get; }
  public string Hash { get; }
  public bool Trashed { get; }
  public string SharedLink { get; }
}

Public Event OnResourceList As OnResourceListHandler

Public Delegate Sub OnResourceListHandler(sender As Object, e As BoxResourceListEventArgs)

Public Class BoxResourceListEventArgs Inherits EventArgs
  Public ReadOnly Property Id As String
  Public ReadOnly Property Name As String
  Public ReadOnly Property Description As String
  Public ReadOnly Property ResourceType As Integer
  Public ReadOnly Property CreatedTime As String
  Public ReadOnly Property ModifiedTime As String
  Public ReadOnly Property Size As Long
  Public ReadOnly Property VersionId As String
  Public ReadOnly Property ETag As String
  Public ReadOnly Property Hash As String
  Public ReadOnly Property Trashed As Boolean
  Public ReadOnly Property SharedLink As String
End Class

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.