MetadataName Property

The name of the metadata item.

Syntax

 backblazeb2.getMetadataName(index, [callback])
 backblazeb2.setMetadataName(index,  metadataName, [callback])

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 getMetadataName([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 setMetadataName([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 name of the metadata item.

This property specifies the name of the metadata item. Metadata item names may be up to 50 characters in length, and must consist solely of letters, numbers, hyphens (-), and underscores (_). The server stores all metadata item names in lowercase.

A metadata item's name cannot start with b2- unless said name is one those explicitly defined by the Backblaze B2 API documentation. Keep in mind that the MetadataValue of such a metadata item must comply with the format specified by the Backblaze B2 API documentation as well, otherwise the server will reject it.

The index parameter specifies the index of the item in the array. The size of the array is controlled by the MetadataCount property.

This property is not available at design time.

Data Type

String