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