Navigator.getDeviceStorage()

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 getDeviceStorage method is used to access some storage area available on the device.

This method gives access to a storage area from the device's default storage, that is the storage area whose .default attribute is true. This is controlled by the user via Settings App > Media Storage > Default media location (e.g. sdcard, internal memory, etc.) Alternatively, you can use the getDeviceStorages method, which returns an Array of DeviceStorage objects, one per physical storage area.

Note: To be able to use a storage area, the application must declare it in its application manifest. For example, if the application wants to access the sdcard storage area, it must have the "device-storage:sdcard" permission in its manifest.

Syntax

  var instanceOfDeviceStorage = navigator.getDeviceStorage(storageName);

Parameters

storageName
The name of the targeted storage area. Firefox OS supports the following areas:
  • apps: This storage area is used to store the user data needed by apps. As it is critical data, accessing this storage area requires some extra privileges and is available for certified applications only.
  • music: This is the storage area where music and sounds are stored.
  • pictures: This is the storage area where pictures are stored.
  • sdcard: This is the storage area that gives access to the device's SDCard.
  • videos: This is the storage area where videos are stored.

Returns

This method returns a DeviceStorage object that can be used to manage files on the associated storage area.

Example

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

Specification

Not part of any specification.

See also

Document Tags and Contributors

Contributors to this page: teoli, chrisdavidmills, kscarfone, Jeremie
Last updated by: teoli,
Hide Sidebar