MetadataList Event

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

Syntax

• C++
• Objective-C
• C

ANSI (Cross Platform)
virtual int FireMetadataList(BoxMetadataListEventParams *e);

typedef struct {
  const char *Name;
  const char *Value;
  int ValueType;
  const char *ContainerScope;
  const char *ContainerSchema;
  const char *ResourceId;
  int reserved;
} BoxMetadataListEventParams;

Unicode (Windows)
virtual INT FireMetadataList(BoxMetadataListEventParams *e);

typedef struct {
  LPCWSTR Name;
  LPCWSTR Value;
  INT ValueType;
  LPCWSTR ContainerScope;
  LPCWSTR ContainerSchema;
  LPCWSTR ResourceId;
  INT reserved;
} BoxMetadataListEventParams;

- (void)onMetadataList:(NSString*)name :(NSString*)value :(int)valueType :(NSString*)containerScope :(NSString*)containerSchema :(NSString*)resourceId;

#define EID_BOX_METADATALIST 6

virtual INT IPWORKSCLOUD_CALL FireMetadataList(LPSTR &lpszName, LPSTR &lpszValue, INT &iValueType, LPSTR &lpszContainerScope, LPSTR &lpszContainerSchema, LPSTR &lpszResourceId);

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.