BoxMetadata Type
A Box metadata item.
Remarks
This type represents a Box metadata item.
Fields
ContainerSchema String |
The schema of the metadata item's container. This field specifies the metadata of the schema item's container. | ||||||||||||||
ContainerScope String |
The scope that the metadata item's container resides in. This field specifies the scope that the metadata item's container resides in. | ||||||||||||||
ModOp BoxMetadataModOps |
The modification operation to perform on the metadata item. This field specifies which modification operation should be performed for the metadata item when UpdateMetadata is called. Possible values are:
Refer to UpdateMetadata for more information. | ||||||||||||||
Name String |
The name of the metadata item. This field specifies the name of the metadata item. It cannot begin with the $ character. This field may be used as input when CreateMetadata or UpdateMetadata is called. | ||||||||||||||
ResourceId String |
The Id of the resource the metadata item is associated with. This field specifies the Id of the resource the metadata item is associated with. | ||||||||||||||
SourceName String |
The name of another metadata item from which to copy or move a value. This field specifies the name of another metadata item whose value should be copied or moved to this one. It cannot begin with the $ character. This field may be used as input when UpdateMetadata is called if the ModOp field is set to one of the following:
| ||||||||||||||
Value String |
The value of the metadata item. This field specifies the value of the metadata item. This field may be used as input when CreateMetadata or UpdateMetadata is called if the ModOp field is set to one of the following:
When this field's value is sent to the server, it is encoded according to the ValueType field. | ||||||||||||||
ValueType BoxMetadataTypes |
The type of the metadata item's value. This field specifies the type of the metadata item's value, and controls how the component encodes Value when submitting it to the server. Possible values, and their corresponding Box types, are:
The Value field should hold a comma-separated list of strings when this field is set to 2 (mtMultiSelect). This field may be used as input when CreateMetadata or UpdateMetadata is called if the ModOp field is set to one of the following:
Important: Box only allows string-typed metadata items in the /global/properties metadata container; the component will always ignore this field and encode metadata items as strings when creating or updating the /global/properties container. |
Constructors
public BoxMetadata();
Public BoxMetadata()