dom/webidl/DataStore.webidl

   1 /* -*- Mode: IDL; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* This Source Code Form is subject to the terms of the Mozilla Public
   3  * License, v. 2.0. If a copy of the MPL was not distributed with this file,
   4  * You can obtain one at http://mozilla.org/MPL/2.0/.
   5  */
   6
   7 typedef (DOMString or unsigned long) DataStoreKey;
   8
   9 // TODO Bug 957086 - The constructor and the setDataStoreImpl(...) will be
  10 //                   removed once the DataStore API is fully rewritten in C++,
  11 //                   which currently plays a role of C++ proxy directing to the
  12 //                   JS codes implemented by the DataStoreImpl WebIDL.
  13
  14 [Func="Navigator::HasDataStoreSupport",
  15  ChromeConstructor,
  16  Exposed=(Window,Worker)]
  17 interface DataStore : EventTarget {
  18   // Returns the label of the DataSource.
  19   [GetterThrows]
  20   readonly attribute DOMString name;
  21
  22   // Returns the origin of the DataSource (e.g., 'facebook.com').
  23   // This value is the manifest URL of the owner app.
  24   [GetterThrows]
  25   readonly attribute DOMString owner;
  26
  27   // is readOnly a F(current_app, datastore) function? yes
  28   [GetterThrows]
  29   readonly attribute boolean readOnly;
  30
  31   [Throws]
  32   Promise<any> get(DataStoreKey... id);
  33
  34   [Throws]
  35   Promise<void> put(any obj, DataStoreKey id, optional DOMString revisionId = "");
  36
  37   [Throws]
  38   Promise<DataStoreKey> add(any obj, optional DataStoreKey id,
  39                             optional DOMString revisionId = "");
  40
  41   [Throws]
  42   Promise<boolean> remove(DataStoreKey id, optional DOMString revisionId = "");
  43
  44   [Throws]
  45   Promise<void> clear(optional DOMString revisionId = "");
  46
  47   [GetterThrows]
  48   readonly attribute DOMString revisionId;
  49
  50   attribute EventHandler onchange;
  51
  52   [Throws]
  53   Promise<unsigned long> getLength();
  54
  55   [NewObject, Throws]
  56   DataStoreCursor sync(optional DOMString revisionId = "");
  57 };
  58
  59 partial interface DataStore {
  60   [ChromeOnly, Throws]
  61   void setDataStoreImpl(DataStoreImpl store);
  62 };
  63
  64 // TODO Bug 957086 - The constructor and the setDataStoreCursorImpl(...) will be
  65 //                   removed once the DataStore API is fully rewritten in C++,
  66 //                   which currently plays a role of C++ proxy directing to the
  67 //                   JS codes implemented by the DataStoreCursorImpl WebIDL.
  68
  69 [Func="Navigator::HasDataStoreSupport",
  70  ChromeConstructor,
  71  Exposed=(Window,Worker)]
  72 interface DataStoreCursor {
  73   // the DataStore
  74   [GetterThrows]
  75   readonly attribute DataStore store;
  76
  77   [Throws]
  78   Promise<DataStoreTask> next();
  79
  80   [Throws]
  81   void close();
  82 };
  83
  84 partial interface DataStoreCursor {
  85   [ChromeOnly]
  86   void setDataStoreCursorImpl(DataStoreCursorImpl cursor);
  87 };
  88
  89 enum DataStoreOperation {
  90   "add",
  91   "update",
  92   "remove",
  93   "clear",
  94   "done"
  95 };
  96
  97 dictionary DataStoreTask {
  98   DOMString revisionId;
  99
 100   DataStoreOperation operation;
 101
 102   // When |operation| is "clear" or "done", this must return null.
 103   DataStoreKey? id;
 104   any data;
 105 };
 106
 107 // For internal use.
 108 dictionary DataStoreRevisionData {
 109   DOMString revisionId = "";
 110   unsigned long objectId = 0;
 111   DOMString operation = "";
 112 };