canmove, Confirmed users
409
edits
Services/Sync/Features/Addon Sync: Difference between revisions
Services/Sync/Features/Addon Sync (view source)
Revision as of 00:14, 31 August 2011
, 31 August 2011no edit summary
No edit summary |
No edit summary |
||
| Line 40: | Line 40: | ||
; getAddonBySyncGUID(syncGUID, callback) : Obtain an add-on from its Sync GUID. Calls the supplied function when that add-on is retrieved. The callback receives null on unknown add-on or the add-on object (generated from the underlying provider) on success. This API technically isn't required, but it makes the Sync code smaller by pushing out logic and possibly caching. | ; getAddonBySyncGUID(syncGUID, callback) : Obtain an add-on from its Sync GUID. Calls the supplied function when that add-on is retrieved. The callback receives null on unknown add-on or the add-on object (generated from the underlying provider) on success. This API technically isn't required, but it makes the Sync code smaller by pushing out logic and possibly caching. | ||
; | ; applyRecords(records, callbackObj) : This applies an array of records that contain add-on metadata and makes the current state of the world agree with that data as much as possible. | ||
The callbackObj is an object containing the following optional keys: | The callbackObj is an object containing the following optional keys: | ||
| Line 54: | Line 54: | ||
* isDeleted (optional) - If evaluates to true, indicates that the record was deleted. Application of this record should involve trying to delete this add-on if present or no-op if not present. | * isDeleted (optional) - If evaluates to true, indicates that the record was deleted. Application of this record should involve trying to delete this add-on if present or no-op if not present. | ||
The implementation of | The implementation of applyRecords() will resemble the following pseudocode: | ||
<pre> | <pre> | ||
| Line 95: | Line 95: | ||
#* Open Issue: Should the AddonManager do this filtering? Should the add-on providers only expose syncData on add-ons installed in the proper location? | #* Open Issue: Should the AddonManager do this filtering? Should the add-on providers only expose syncData on add-ons installed in the proper location? | ||
The engine will process incoming records by converting them to the API accepted by AddonManager. | The engine will process incoming records by converting them to the API accepted by AddonManager.applyRecords() and will invoke that function with them. This is similar to how the history engine works. | ||
The Sync add-on tracker will install add-on listeners in the AddonManager and will listen for the following events: | The Sync add-on tracker will install add-on listeners in the AddonManager and will listen for the following events: | ||