IPWorks Cloud 2020 JavaScript Edition

Questions / Feedback?

UpdateResource Method

Updates a resource.

Syntax

async box.updateResource(resourceId : string): Promise<void>

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 ResourcesId 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:
    • ResourcesDescription
    • ResourcesName (the same restrictions as described in UploadFile apply)
    • ResourcesParentId (only updated if not empty; d:0 can be used to move the resource to the root folder)
    • ResourcesSyncState (only applicable for folder resources; only updated if set to 1 (ssSynced) or 2 (ssNotSynced))
    • ResourcesTags
  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.)
  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);

Copyright (c) 2022 /n software inc. - All rights reserved.
IPWorks Cloud 2020 JavaScript Edition - Version 20.0 [Build 8265]