DeviceStorage.enumerate()

Summary

The enumerate method is used to iterate through the files of a given storage area.

If the request is successful, the request's result is a File object containing the data of the current files stored on the device.

Syntax

var instanceOfDOMCursor = instanceOfDeviceStorage.enumerate([path][, options]);

Parameters

path Optional

A string representing a path directory within the storage area to search for files within. Note that you should not include a leading slash on the path you specify.

options Optional

An object with the property since which is a Date object. Files older than that date will be ignored during the iteration process.

Returns

It returns a DOMCursor object to handle the success or error of the iteration.

Example

var sdcard = navigator.getDeviceStorage('sdcard');

// Let's retrieve files from last week.
var param = {
  since: new Date((+new Date()) - 7*24*60*60*1000)
}

var cursor = sdcard.enumerate(param);

cursor.onsuccess = function () {

  if (this.result) {
    var file = this.result;
    console.log("File updated on: " + file.lastModifiedDate);

    // Once we found a file we check if there are other results
    // Then we move to the next result, which calls the cursor
    // success possibly with the next file as result.
    this.continue();
  }
}

Specification

Not part of any specification.

See also

• DeviceStorage
• FileHandle
• DOMCursor
• Device Storage API
• FileHandle API