DeviceStorage.enumerateEditable()

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

Summary

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

If the request is successful, the request's result is a FileHandle object allowing to access and modify the current file reached on the device.

Syntax

var instanceOfDOMCursor = instanceOfDeviceStorage.enumerateEditable([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.enumerateEditable(param);
cursor.onsuccess = function () {
  var file = this.result;
  console.log("File updated on: " + file.lastModifiedDate);
  // Once we found a file we check if there are other results
  if (!this.done) {
    // Then we move to the next result, which calls the cursor
    // success with the next file as result.
    this.continue();
  }
}

Specification

Not part of any specification.