MozillaWiki

WebAPI/DataStore: Difference between revisions

Page Discussion

WebAPI/DataStore (view source)

Revision as of 23:49, 1 October 2014

515 bytes added ,  1 October 2014
no edit summary
No edit summary
 
(8 intermediate revisions by 3 users not shown)
Line 63: Line 63:
== Interface ==
== Interface ==


  typedef (DOMString or unsigned long) DataStoreKey;
 
   interface DataStore : EventTarget {
   interface DataStore : EventTarget {
     // Returns the label of the DataSource.
     // Returns the label of the DataSource.
Line 75: Line 77:
    
    
     // Promise<any>
     // Promise<any>
     Promise get(unsigned long id);
     Promise get(DataStoreKey... id);
 
     
    // Promise<any>
    Promise get(sequence<unsigned long> id);
 
     // Promise<void>
     // Promise<void>
     Promise put(any obj, unsigned long id);
     Promise put(any obj, DataStoreKey id, optional DOMString revisionId = "");
 
 
     // Promise<unsigned long>
     // Promise<DataStoreKey>
     Promise add(any obj, optional unsigned long id);
     Promise add(any obj, optional DataStoreKey id, optional DOMString revisionId = "");
    
    
     // Promise<boolean>
     // Promise<boolean>
     Promise remove(unsigned long id);
     Promise remove(DataStoreKey id, optional DOMString revisionId = "");
    
    
     // Promise<void>
     // Promise<void>
     Promise clear();
     Promise clear(optional DOMString revisionId = "");
    
    
     readonly attribute DOMString revisionId;
     readonly attribute DOMString revisionId;
 
   
    attribute EventHandler onchange;
   
     // Promise<unsigned long>
     // Promise<unsigned long>
     Promise getLength();
     Promise getLength();
Line 123: Line 124:
    
    
     DataStoreOperation operation;
     DataStoreOperation operation;
     unsigned long id;
     DataStoreKey id;
     any data;
     any data;
  };
 
  dictionary DataStoreChangeEventInit : EventInit {
    DOMString revisionId = "";
    DataStoreKey id = 0;
    DOMString operation = "";
    DOMStirng owner = "";
  };
 
  [Constructor(DOMString type, optional DataStoreChangeEventInit eventInitDict)]
  interface DataStoreChangeEvent : Event {
    readonly attribute DOMString revisionId;
    readonly attribute DataStoreKey id;
    readonly attribute DOMString operation;
    readonly attribute DOMString owner;
   };
   };


Line 134: Line 150:
     datastores-owned: {
     datastores-owned: {
       "contacts": {
       "contacts": {
         "readonly": true,
         "access": "readonly",
         "description": "Facebook contacts",
         "description": ...
       }
       }
     },
     },
Line 146: Line 162:
     datastores-access: {
     datastores-access: {
       "contacts": {
       "contacts": {
         "access": "readonly",
         "readonly": true,
         "description": ...
         "description": "Facebook contacts",
       }
       }
     },
     },
Line 200: Line 216:
=== Sync ===
=== Sync ===


The synchronization of  a DataStore with a 'private' app storage can be done using the 'sync' method. Calling this method, DataStore creates a DataStoreCursor that helps the app with the synchronization starting from scratch or for a valid revisionId. When a cursor is active, onchange events are not sent to the app. The sync operation can be terminated calling cursor.close(). If something changes in the DataStore when the cursor is synchronize the app, all the changes will be managed by the cursor as additional operation: this means that when the cursor completes its tasks, the app will be always in sync with the current revisionId of the DataStore.
The synchronization of  a DataStore with a 'private' app storage can be done using the 'sync' method. Calling this method, DataStore creates a DataStoreCursor that helps the app with the synchronization starting from scratch or for a valid revisionId. The sync operation can be terminated calling cursor.close(). If something changes in the DataStore when the cursor is synchronize the app, all the changes will be managed by the cursor as additional operation: this means that when the cursor completes its tasks, the app will be always in sync with the current revisionId of the DataStore.


The basic usage of the cursor is this:
The basic usage of the cursor is this:


   navagiator.getDataStores('contacts').then(functions(stores) {
   navigator.getDataStores('contacts').then(functions(stores) {
     if (!stores.length) return;
     if (!stores.length) return;
    
    
Line 213: Line 229:
       switch (task.operation) {
       switch (task.operation) {
         case 'done':
         case 'done':
           // No additional operation has to be done. When 'done' is received, the sync is completed and onchange events can be received again.
           // No additional operation has to be done.
           dump("The current revision ID is: " + task.revisionId + "\n");
           dump("The current revision ID is: " + task.revisionId + "\n");
           return;
           return;
Line 248: Line 264:
  * Should all data stores with the same name share a schema?
  * Should all data stores with the same name share a schema?
  * Enforcing types can be a footgun. What should a data provider do if it decides some key should have a different type?
  * Enforcing types can be a footgun. What should a data provider do if it decides some key should have a different type?
[[Category:Web APIs]]
Chaasof
Confirmed users
1,340

edits

Retrieved from "https://wiki.allizom.org/Special:MobileDiff/768513...1021372"