on_metadata_list Event
Fires once for each metadata item when listing a resource metadata.
Syntax
class BoxMetadataListEventParams(object): @property def name() -> str: ... @property def value() -> str: ... @property def value_type() -> int: ... @property def container_scope() -> str: ... @property def container_schema() -> str: ... @property def resource_id() -> str: ... # In class Box: @property def on_metadata_list() -> Callable[[BoxMetadataListEventParams], None]: ... @on_metadata_list.setter def on_metadata_list(event_hook: Callable[[BoxMetadataListEventParams], None]) -> None: ...
Remarks
This event fires once for each metadata item returned when list_metadata 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.