dom/webidl/DeviceStorageAreaChangedEvent.webidl
author James Cheng <jacheng@mozilla.com>
Fri, 05 Aug 2016 13:23:44 -0400
changeset 308428 8ee6f2eb8b349a351f6f76585eb85e0ec2b5c475
parent 240982 8123a477b7d7c99c9f62e4fd8dc3896da4624e42
permissions -rw-r--r--
Bug 1291229 - Fix typo for moving Java bindings to mozilla::java namespace. r=jchen MozReview-Commit-ID: KGAS6EhnwAI

/* -*- Mode: IDL; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

enum DeviceStorageAreaChangedEventOperation {
  "added",
  "removed",
  "unknown"
};

/*
 * For the EventHandler - onstorageareachanged, new event is introduced and called
 * DeviceStorageAreaChangedEvent.
 * The attribute - operation indicates that there is a storage area has been
 * added or removed.
 * 1. If a storage area is added, then the 'storageName' attribute will contain the
 * name of the storage area. To access this new storage area, a user needs to pass
 * storageName to navigator.getDeviceStorageByNameAndType to get a DeviceStorage object.
 * 2. If a storage area is removed, then the 'storageName' attribute indicates
 * which storage area was removed.
 */
[Pref="device.storage.enabled",
 Constructor(DOMString type, optional DeviceStorageAreaChangedEventInit eventInitDict)]
interface DeviceStorageAreaChangedEvent : Event {
  readonly attribute DeviceStorageAreaChangedEventOperation operation;
  readonly attribute DOMString                              storageName;
};

dictionary DeviceStorageAreaChangedEventInit : EventInit {
  DeviceStorageAreaChangedEventOperation operation = "unknown";
  DOMString                              storageName = "";
};