Service/Sync/FxSync/Developer/BrowserObjects

From MozillaWiki
Revision as of 21:43, 5 February 2010 by Mardak (talk | contribs) (Initial document description/structure)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

Once an encrypted Weave Basic Object's payload is decrypted using Weave Crypto, the result is a cleartext JSON string. Each collection can have its own object structure to store data that it needs to reconstruct the item on the client.

This document describes the current format of the objects for each collection. Typically, one record corresponds to one item, e.g., a bookmark, and the object formats have a fixed list of keys for simple key/value string pairs.

The following sections, named by the corresponding collection name, describes the various object formats and how they're used. Note that object structures may change in the future and may not be backwards compatible.

bookmarks

One bookmark record exists for each "bookmark item," where an item may actually be a folder or a separator. Each item will have a type that determines what other fields are available in the object. The following sections describe the object format for a given type.

item

bookmark

microsummary

query

folder

livemark

separator

forms

history

passwords

prefs

tabs