MetadataFieldUpdateOp Property

The update operation to perform.

Syntax

 box.getMetadataFieldUpdateOp(index, [callback])
 box.setMetadataFieldUpdateOp(index,  metadataFieldUpdateOp, [callback])

Possible Values

  0 (uoAdd), 
  1 (uoReplace), 
  2 (uoDelete)

Default Value

Callback

The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).

The callback for the getMetadataFieldUpdateOp([callback]) method is defined as:

function(err, data){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'data' is the value returned by the method.

The callback for the setMetadataFieldUpdateOp([callback]) method is defined as:

function(err){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

The update operation to perform. This is applicable when calling UpdateMetadata. Possible values are:

0 (uoAdd)
1 (uoReplace)
2 (uoDelete)

The size of the array is controlled by the MetadataFieldCount property.

This property is not available at design time.

Data Type

Integer