Changes

This page describes how to the client-side Sync API for sync engines (and their helper objects). The focus is on using this API to create a new sync engine to synchronize a new data type. The data type can be anything that extension JS code has access to through any Mozilla API; this means To do this page must of necessity be pretty vague about reading and writing the underlying data. You'll have to fill in those blanks yourself. Try browsing the [link] xpcom documentation to find out how to get at the many types of useful data that Mozilla stores. To sync a new data type, you'll need to write an engine object that extends the base <tt>SyncEngine</tt> object; you. You'll also need to extend three helper objects. Here are the base implementations you need to extend, and the files in which they're defined:

So to start out, import these files at the top of your JS module. We're also going to import <tt>util.js</tt> as it contains many useful helpers. <pre> const Cu = Components.utils; Cu.import("resource://services-sync/engines.js"); Cu.import("resource://services-sync/record.js"); Cu.import("resource://services-sync/util.js");</pre> It will be very helpful to look at the existing sync engines -- such as the one for bookmarks and the one for history -- , and their helper classeshelpers, for guidance. You can find these files at: