DeviceStorage.enumerate

This article is in need of a technical review.

Non-standard
This feature is not on a current W3C standards track, but it is supported on the Firefox OS platform. Although implementations may change in the future and it is not supported widely across browsers, it is suitable for use in code dedicated to Firefox OS apps.

This API is available on Firefox OS for privileged or certified applications only.

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 file reached on the device.

Syntax

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

Parameters

path Optional
A string representing a path directory within the storage area where to search for files.
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

Document Tags and Contributors

Contributors to this page: kscarfone, ladybenko, NickDesaulniers, crh, Jeremie
Last updated by: ladybenko,