Service/Sync/FxSync/Developer/BrowserObjects: Difference between revisions

Jump to navigation Jump to search
rewrite intro to reference storage format
(rewrite intro to reference storage format)
Line 1: Line 1:
Once an encrypted Weave Basic Object's payload is decrypted using [[Labs/Weave/Crypto|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.
Once an [[Labs/Weave/Developer/StorageFormat#Payload:_Encrypted_Data_Object|Encrypted Data Object]]'s payload is decrypted using [[Labs/Weave/Crypto|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 object structure is versioned with the version metadata stored in the [[Labs/Weave/Developer/StorageFormat#Payload:_meta.2Fglobal|payload of meta/global]].
 
This document describes the format of the objects for each collection for each version. 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.
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.


In addition to these custom collection object structures, the top level Weave Basic Object provides fields for the GUID, sortindex (interestingness), parentid, and modified time.
In addition to these custom collection object structures, the [[Labs/Weave/Developer/StorageFormat#Payload:_Encrypted_Data_Object|Encrypted Data Object]] adds fields like <tt>id</tt> and <tt>deleted</tt>. Also, remember that there is data at the [[Labs/Weave/Developer/StorageFormat#Weave_Basic_Object|Weave Basic Object]] level as well such as <tt>id</tt>, <tt>modified</tt>, <tt>sortindex</tt> and <tt>payload</tt>.


== bookmarks ==
== bookmarks ==
383

edits

Navigation menu