MetadataList Event

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

Syntax

class BoxMetadataListEventParams {
public:
  const QString &Name();
  const QString &Value();
  int ValueType();
  const QString &ContainerScope();
  const QString &ContainerSchema();
  const QString &ResourceId();
  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void MetadataList(BoxMetadataListEventParams *e);
// Or, subclass Box and override this emitter function. virtual int FireMetadataList(BoxMetadataListEventParams *e) {...}

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 Qt Edition - Version 20.0 [Build 8265]