UpdateMetadata Method

Updates metadata fields for a file.

Syntax

[VB.NET]
Public Sub UpdateMetadata()

[C#]
public void UpdateMetadata();

Remarks

This method updates specific fields in the metadata for a file. This may be used to add, update, or delete fields to existing metadata for a file.

Before calling this method populate MetadataFields with the appropriate field names and values to modify. The UpdateOp field specifies the operation to perform on the field (add, update, or delete).

As an alternative to directly specifying the metadata fields to modify GetMetadata may be called to retrieve all metadata for a file. Once retrieved the MetadataFields may be modified with any new Value and UpdateOp values.

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();

NOTE: This method has a corresponding asynchronous version (UpdateMetadataAsync) for use in the Xamarin environment.