Changes

Jump to: navigation, search

CloudServices/Sync/FxSync/Developer/ClientAPI

102 bytes removed, 23:17, 21 February 2011
Writing a Store class
</pre>
== Writing a The Store class object ==
The Store object (which extends <tt>Store</tt>, as defined in <tt>services/sync/modules/engines.js</tt>) has the job of creating and maintaining a set of Record objects from the underlying data. The store must also make updates to the underlying data itself, to keep based on incoming Record objects. The majority of the code you write for syncing a new data up-to-date with type will most likely be in the user's latest changes, when the store is instructed to do soStore implementation.
The majority of the code you write for syncing a new data type will most likely be in the Store class. Each Record that the Store keeps track of must be identified by a unique ID (unique among all records in the store) called GUID. Depending of what type of data you're working with, you might already have GUIDs built into your data that you can make use of(note that GUIDs must be allowed to change and should be URL friendly). If not, you may have to invent your own mapping from data objects to GUIDs as long as it's consistent. In this case, it is highly recommended to use the <tt>Utils.makeGUID()</tt> helperto generate new GUIDs:
let newGuid = Utils.makeGUID();
 
In either case, ensure that the GUIDs are URL friendly (base64url is a recommended alphabet).
Your Store object '''must''' implement the following methods:
=== createRecord ===
The <tt>createRecord( id, collection )</tt> method gets called by the engine to request a new record for an item with a given GUID. It's your Store's responsibility to instantiate a Record object (of the class you defined earlier), assign the given GUID, and return it.
=== itemExists(guid) ===
:TODO
=== Example Store class skeleton ===
<pre>
Canmove, confirm
725
edits

Navigation menu