DeviceStorage.add()

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

Summary

The add method is used to add a file inside a given storage area.

When a file is added with this method, its name is generated automatically and is available within the request's result which is a File object.

Syntax

var instanceOfDOMRequest = instanceOfDeviceStorage.add(file);

Parameters

file
A Blob object representing the file to add (note that a File object is also a Blob object).

Returns

It returns a DOMRequest object to handle the success or error of the operation.

Example

var sdcard = navigator.getDeviceStorage("sdcard");
var file   = new Blob(["This is a text file."], {type: "text/plain"});

var request = sdcard.add(file);

request.onsuccess = function () {
  var name = this.result.name;
  console.log('File "' + name + '" successfully wrote on the sdcard storage area');
}

// An error typically occur if a file with the same name already exist
request.onerror = function () {
  console.warn('Unable to write the file: ' + this.error);
}

Specification

Not part of any specification.

See also

Document Tags and Contributors

 Contributors to this page: chrisdavidmills, fscholz, kscarfone, Jeremie
 Last updated by: chrisdavidmills,