ListResources Method

Lists the resources in the specified folder.

Syntax

box.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

ListResources lists resources in the folder specified by ResourceParentId. If ResourceParentId 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:

ResourceDeleted
ResourceETag
ResourceHash (not applicable to folders)
ResourceId
ResourceMarker
ResourceName
ResourceRevision
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.

Note: To define a specific list of fields which are returned in the response for each resource set the "fields" parameter via AddQueryParam. Refer to the Box documentation for a full list of available fields.

box.ResourceParentId = "123456";
box.ListResources();
for (int i = 0; i < box.ResourceCount; i++)
{
  box.ResourceIndex = i;
  Console.WriteLine(box.ResourceName);
}