ListResources Method

Lists resources.

Syntax

box.listResources(folderId, [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 within the folder specified by FolderId.

FolderId can be empty string to list resources in the root folder, or trash to list trashed resources.

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.

The MaxResults configuration setting can be used to control the maximum number of results to return at once.

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

do {
  box.ListResources("d:123456");

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