IPWorks Cloud 2020 JavaScript Edition

Questions / Feedback?

ListResources Method

Lists resources.

Syntax

async dropbox.listResources(folderResource : string): Promise<void>

Remarks

This method lists resources within the specified FolderResource.

FolderResource must be a folder path, an Id-based relative folder path, a folder resource Id, or empty string (the root folder). The IncludeDeleted, IncludeMounted, MaxResults, and RecurseSubfolders configuration settings may be used to further control the scope of the results.

Note that the values of FolderResource and the aforementioned configuration settings are all ignored if ResourceMarker is populated (the marker encodes the values used originally).

Calling this method will fire the ResourceList event once for each resource, and will also populate the Resource* properties.

If there are still more resources available to list when this method returns, the ResourceMarker property will be populated. Continue to call this method until ResourceMarker is empty to accumulate all pages of results in the Resource* properties.

// ResourceList event handler.
dropbox.OnResourceList += (s, e) => {
  Console.WriteLine(e.Name);
};

do {
  dropbox.ListResources("/work_files/serious_business/cats");

  for (int i = 0; i < dropbox.Resources.Count; i++) {
    // Process resources here.
  }
} while (!string.IsNullOrEmpty(dropbox.ResourceMarker));

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