metadataModOp (property)
The modification operation to perform on the metadata item.
Syntax
- (int)metadataModOp:(int)metadataIndex; - (void)setMetadataModOp:(int)metadataIndex:(int)newMetadataModOp;
/* Possible Values */
OP_NONE(0),
OP_ADD(1),
OP_REPLACE(2),
OP_COPY_FROM(3),
OP_MOVE_FROM(4),
OP_REMOVE(5),
OP_TEST(6)
public func metadataModOp(metadataIndex: Int32) throws -> BoxMetadataModOps
public func setMetadataModOp(metadataIndex: Int32, newMetadataModOp: BoxMetadataModOps) throws -> Void
public enum BoxMetadataModOps : Int32 { case opNone = 0 case opAdd = 1 case opReplace = 2 case opCopyFrom = 3 case opMoveFrom = 4 case opRemove = 5 case opTest = 6 }
Default Value
0
Remarks
The modification operation to perform on the metadata item.
This property specifies which modification operation should be performed for the metadata item when UpdateMetadata is called. Possible values are:
| 0 (opNone - default) | No-Op (the class skips the metadata item). |
| 1 (opAdd) | A new metadata item will be added. If one already exists with the specified MetadataName, its value will be overwritten. |
| 2 (opReplace) | The metadata item with the given MetadataName (which must already exist) will have its value overwritten. |
| 3 (opCopyFrom) | A new metadata item will be added, its value copied from the item specified by MetadataSourceName (which must already exist). |
| 4 (opMoveFrom) | A new metadata item will be added, its value moved from the item specified by MetadataSourceName (which must already exist). The source item will then be removed. |
| 5 (opRemove) | The metadata item with the given MetadataName (which must already exist) will be removed. |
| 6 (opTest) | Will verify that the metadata item with the given MetadataName (which must already exist) has the specified MetadataValue. |
Refer to UpdateMetadata for more information.
The MetadataIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MetadataCount property.