UpdateResource Method

Updates a resource.

Syntax

public void updateResource(String resourceId);

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 a BoxResource item in the Resources collection whose Id field 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 Resources collection.
2. Modify the BoxResource item's fields as desired; the following fields are supported:
   • Description
   • Name (the same restrictions as described in UploadFile apply)
   • ParentId (only updated if not empty; d:0 can be used to move the resource to the root folder)
   • SyncState (only applicable for folder resources; only updated if set to 1 (ssSynced) or 2 (ssNotSynced))
   • Tags
3. For file resources, you may call SetUploadStream or 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);