UpdateResource Method

Updates a resource.

Syntax

box.updateResource(resourceId, [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 updates the information for the resource specified by ResourceId. For file resources, the file data can optionally be updated as well.

Usage

There must be an item in the Resource* properties whose ResourceId property matches the given ResourceId parameter before this method is called.

1. If necessary, call GetResourceInfo or ListResources to ensure an item with the resource's latest information is present in the Resource* properties.
2. Modify the item's Resource* properties as desired; the following properties are supported:
   • ResourceDescription
   • ResourceName (the same restrictions as described in UploadFile apply)
   • ResourceParentId (only updated if not empty; d:0 can be used to move the resource to the root folder)
   • ResourceSyncState (only applicable for folder resources; only updated if set to 1 (ssSynced) or 2 (ssNotSynced))
   • ResourceTags
3. For file resources, you may set LocalFile or ResourceData if you wish to update the file data on the server. (Refer to UploadFile for more information about simple vs. resumable uploads and encrypting the file data before uploading.)
   • Like with UploadFile, the ClientModifiedTime configuration setting may be set when updating file data.
4. Finally, call this method to update the resource.

// Load the latest information about the resource into the Resources collection.
string resId = "f:09876";
box.GetResourceInfo(resId);

// We'll update the file resource's name, description, and content.
box.ResourceData = "new file content";
box.Resources[0].Name = "CoolStuff2.txt";
box.Resources[0].Description = "This is a text file with cool stuff in it";

box.UpdateResource(resId);