IPWorks Cloud 2020 Node.js Edition

Questions / Feedback?

ListResources Method

Lists resources in the currently selected folder.

Syntax

onedrive.listResources([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 lists resources in the folder resource currently selected by RemoteId or RemotePath.

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.

For more complex queries, use the Search method.

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

// (Assume that the RemoteId property isn't set; it takes precedence if it is.)
onedrive.RemotePath = "/work_files/serious_business/cats";
do {
  onedrive.ListResources();

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

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