IPWorks Cloud 2020 Java Edition

Questions / Feedback?

MetadataList Event

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

Syntax

public class DefaultBoxEventListener implements BoxEventListener {
  ...
  public void metadataList(BoxMetadataListEvent e) {}
  ...
}

public class BoxMetadataListEvent {
  public String name;
  public String value;
  public int valueType;
  public String containerScope;
  public String containerSchema;
  public String resourceId;
}

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:

Value Type Encoded As Corresponding Box Types
0 (mtString - default) String string, date, enum (single-select)
1 (mtNumber) Number float (note: actually any numeric value, including integers)
2 (mtMultiSelect) Array of strings enum (multi-select)

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.

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