ListResources Method

Lists the resources in the current folder.

Syntax

dropbox.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 within the account at the specified path.

Before calling this method set ResourcePath to the full path to the folder to list. If ResourcePath is unspecified the root folder contents will be listed.

After calling this method set ResourceIndex to a value from 0 to ResourceCount - 1. Setting ResourceIndex populates other Resource properties to provide information about the resource.

After calling this method the following resource properties are populated:

• ResourceCount
• ResourceId
• ResourceMarker
• ResourceModifiedDate
• ResourceName
• ResourcePath
• ResourceRevision
• ResourceType

If the ResourceType is 1 (rtFolder) only the following properties are applicable:

• ResourceCount
• ResourceId
• ResourceMarker
• ResourceName
• ResourcePath
• ResourceType

If the results are paged, the ResourceMarker property will be populated. Call this method again to retrieve the next page of results. When the last page of results is returned ResourceMarker will be empty.

By default only resources of the specified ResourcePath are returned. To list files included within subfolders set RecurseSubfolders to True.

dropbox.ResourcePath = "/New Folder";
dropbox.ListResources();
for (int i = 0; i < dropbox.ResourceCount; i++)
{
  dropbox.ResourceIndex = i;
  Console.WriteLine(dropbox.ResourceName + ": " + dropbox.ResourceSize);
}