ListVersions Method

Lists previous versions of a file resource.

Syntax

box.listVersions(fileId, [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 previous versions of the file resource specified by FileId. The current version is not included in the results.

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

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

Note that Box only returns certain resource details when listing file versions; this is a limitation of the Box API that cannot be changed. Specifically, the following properties are returned:

• ResourceCreatedTime
• ResourceHash
• ResourceId (populated by the class for convenience)
• ResourceModifiedBy
• ResourceModifiedTime
• ResourceName
• ResourceSize
• ResourceType (always 0 (brtFile))
• ResourceVersionId

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

Note that Box only tracks file versions for paid accounts.

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

do {
  box.ListVersions("f:09876");

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