metadata_value_type Property
The type of the metadata item's value.
Syntax
def get_metadata_value_type(metadata_index: int) -> int: ... def set_metadata_value_type(metadata_index: int, value: int) -> None: ...
Default Value
0
Remarks
The type of the metadata item's value.
This property specifies the type of the metadata item's value, and controls how the class encodes metadata_value when submitting it to the server. 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) |
The metadata_value property should hold a comma-separated list of strings when this property is set to 2 (mtMultiSelect).
This property may be used as input when create_metadata or update_metadata is called if the metadata_mod_op property is set to one of the following:
- 1 (opAdd)
- 2 (opReplace)
- 6 (opTest)
Important: Box only allows string-typed metadata items in the /global/properties metadata container; the class will always ignore this property and encode metadata items as strings when creating or updating the /global/properties container.
The metadata_index parameter specifies the index of the item in the array. The size of the array is controlled by the metadata_count property.