shared-storage.idl (5120B)
1 // GENERATED CONTENT - DO NOT EDIT 2 // Content was automatically extracted by Reffy into webref 3 // (https://github.com/w3c/webref) 4 // Source: Shared Storage API (https://wicg.github.io/shared-storage/) 5 6 typedef (USVString or FencedFrameConfig) SharedStorageResponse; 7 8 [Exposed=(Window)] 9 interface SharedStorageWorklet : Worklet { 10 Promise<SharedStorageResponse> selectURL(DOMString name, 11 sequence<SharedStorageUrlWithMetadata> urls, 12 optional SharedStorageRunOperationMethodOptions options = {}); 13 Promise<any> run(DOMString name, 14 optional SharedStorageRunOperationMethodOptions options = {}); 15 }; 16 17 callback RunFunctionForSharedStorageSelectURLOperation = Promise<unsigned long>(sequence<USVString> urls, optional any data); 18 19 [Exposed=SharedStorageWorklet, Global=SharedStorageWorklet] 20 interface SharedStorageWorkletGlobalScope : WorkletGlobalScope { 21 undefined register(DOMString name, 22 Function operationCtor); 23 24 readonly attribute SharedStorage sharedStorage; 25 readonly attribute PrivateAggregation privateAggregation; 26 27 Promise<sequence<StorageInterestGroup>> interestGroups(); 28 29 readonly attribute SharedStorageWorkletNavigator navigator; 30 }; 31 32 dictionary SharedStorageUrlWithMetadata { 33 required USVString url; 34 object reportingMetadata; 35 }; 36 37 partial interface Window { 38 [SecureContext] readonly attribute SharedStorage? sharedStorage; 39 }; 40 41 [Exposed=(Window,SharedStorageWorklet)] 42 interface SharedStorageModifierMethod {}; 43 44 [Exposed=(Window, SharedStorageWorklet)] 45 interface SharedStorageSetMethod : SharedStorageModifierMethod { 46 constructor(DOMString key, DOMString value, optional SharedStorageSetMethodOptions options = {}); 47 }; 48 49 [Exposed=(Window, SharedStorageWorklet)] 50 interface SharedStorageAppendMethod : SharedStorageModifierMethod { 51 constructor(DOMString key, DOMString value, optional SharedStorageModifierMethodOptions options = {}); 52 }; 53 54 [Exposed=(Window, SharedStorageWorklet)] 55 interface SharedStorageDeleteMethod : SharedStorageModifierMethod { 56 constructor(DOMString key, optional SharedStorageModifierMethodOptions options = {}); 57 }; 58 59 [Exposed=(Window, SharedStorageWorklet)] 60 interface SharedStorageClearMethod : SharedStorageModifierMethod { 61 constructor(optional SharedStorageModifierMethodOptions options = {}); 62 }; 63 64 dictionary SharedStorageModifierMethodOptions { 65 DOMString withLock; 66 }; 67 68 dictionary SharedStorageSetMethodOptions : SharedStorageModifierMethodOptions { 69 boolean ignoreIfPresent; 70 }; 71 72 [Exposed=(Window,SharedStorageWorklet)] 73 interface SharedStorage { 74 Promise<DOMString> get(DOMString key); 75 Promise<any> set(DOMString key, 76 DOMString value, 77 optional SharedStorageSetMethodOptions options = {}); 78 Promise<any> append(DOMString key, 79 DOMString value, 80 optional SharedStorageModifierMethodOptions options = {}); 81 Promise<any> delete(DOMString key, optional SharedStorageModifierMethodOptions options = {}); 82 Promise<any> clear(optional SharedStorageModifierMethodOptions options = {}); 83 Promise<any> batchUpdate(sequence<SharedStorageModifierMethod> methods, 84 optional SharedStorageModifierMethodOptions options = {}); 85 86 [Exposed=Window] 87 Promise<SharedStorageResponse> selectURL(DOMString name, 88 sequence<SharedStorageUrlWithMetadata> urls, 89 optional SharedStorageRunOperationMethodOptions options = {}); 90 91 [Exposed=Window] 92 Promise<any> run(DOMString name, 93 optional SharedStorageRunOperationMethodOptions options = {}); 94 95 [Exposed=Window] 96 Promise<SharedStorageWorklet> createWorklet(USVString moduleURL, optional SharedStorageWorkletOptions options = {}); 97 98 [Exposed=Window] 99 readonly attribute SharedStorageWorklet worklet; 100 101 [Exposed=SharedStorageWorklet] 102 Promise<unsigned long> length(); 103 104 [Exposed=SharedStorageWorklet] 105 Promise<double> remainingBudget(); 106 107 [Exposed=SharedStorageWorklet] 108 async_iterable<DOMString, DOMString>; 109 }; 110 111 dictionary SharedStoragePrivateAggregationConfig { 112 USVString aggregationCoordinatorOrigin; 113 USVString contextId; 114 [EnforceRange] unsigned long long filteringIdMaxBytes; 115 [EnforceRange] unsigned long long maxContributions; 116 }; 117 118 dictionary SharedStorageRunOperationMethodOptions { 119 object data; 120 boolean resolveToConfig = false; 121 boolean keepAlive = false; 122 SharedStoragePrivateAggregationConfig privateAggregationConfig; 123 DOMString savedQuery; 124 }; 125 126 dictionary SharedStorageWorkletOptions : WorkletOptions { 127 USVString dataOrigin = "context-origin"; 128 }; 129 130 interface mixin HTMLSharedStorageWritableElementUtils { 131 [CEReactions, SecureContext] attribute boolean sharedStorageWritable; 132 }; 133 134 HTMLIFrameElement includes HTMLSharedStorageWritableElementUtils; 135 HTMLImageElement includes HTMLSharedStorageWritableElementUtils; 136 137 partial dictionary RequestInit { 138 boolean sharedStorageWritable; 139 }; 140 141 [ 142 Exposed=SharedStorageWorklet 143 ] interface SharedStorageWorkletNavigator {}; 144 145 SharedStorageWorkletNavigator includes NavigatorLocks;