MetadataList Event

Fires once for each metadata item when listing a resource metadata.

Syntax

• C#
• VB.NET

public event OnMetadataListHandler OnMetadataList;

public delegate void OnMetadataListHandler(object sender, BoxMetadataListEventArgs e);

public class BoxMetadataListEventArgs : EventArgs {
  public string Name { get; }
  public string Value { get; }
  public int ValueType { get; }
  public string ContainerScope { get; }
  public string ContainerSchema { get; }
  public string ResourceId { get; }
}

Public Event OnMetadataList As OnMetadataListHandler

Public Delegate Sub OnMetadataListHandler(sender As Object, e As BoxMetadataListEventArgs)

Public Class BoxMetadataListEventArgs Inherits EventArgs
  Public ReadOnly Property Name As String
  Public ReadOnly Property Value As String
  Public ReadOnly Property ValueType As Integer
  Public ReadOnly Property ContainerScope As String
  Public ReadOnly Property ContainerSchema As String
  Public ReadOnly Property ResourceId As String
End Class

Remarks

This event fires once for each metadata item returned when ListMetadata is called.

Name is the name of the metadata item.

Value is the value of the metadata item.

ValueType is the value of the metadata item. Possible values, and their corresponding Box types, are:

ContainerScope is the scope that the metadata item's container resides in.

ContainerSchema is the schema of the metadata item's container.

ResourceId is the Id of the resource that the metadata is associated with.

Note that metadata is only usable on resources owned by paid Box accounts.