IPWorks Cloud 2020 Python Edition

Questions / Feedback?

update_resource Method

Updates a resource.

Syntax

def update_resource(resource_id: str) -> None: ...

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 resource_id property matches the given ResourceId parameter before this method is called.

  1. If necessary, call get_resource_info or list_resources 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:
  3. For file resources, you may set local_file or resource_data if you wish to update the file data on the server. (Refer to upload_file 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 Python Edition - Version 20.0 [Build 8265]