CreateMetadata Method

Creates metadata for a file.

Syntax

box.createMetadata([callback])

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 this 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

This method creates metadata for the file specified by ResourceId.

Before calling this method new name/value pairs may be added to MetadataFields.

Note: Metadata is only applicable to files.

Metadata Examples:

//Update an existing metadata field
box.MetadataFields.Add(new MetadataFieldDetail());
box.MetadataFields[0].Name = "name1";
box.MetadataFields[0].Value = "new_value";
box.MetadataFields[0].UpdateOp = BoxUpdateOps.uoReplace;
box.UpdateMetadata();

//Delete a metadata field
box.MetadataFields.Add(new MetadataFieldDetail());
box.MetadataFields[0].Name = "field_to_delete";
box.MetadataFields[0].UpdateOp = BoxUpdateOps.uoDelete;
box.UpdateMetadata();

//Add a new metadata field
box.MetadataFields.Add(new MetadataFieldDetail());
box.MetadataFields[0].Name = "field_to_add";
box.MetadataFields[0].Value = "my_value";
box.MetadataFields[0].UpdateOp = BoxUpdateOps.uoAdd;
box.UpdateMetadata();