Service/Sync/FxSync/Developer/BrowserObjects - Revision history

Gszorc: blank page since content on docs.services.m.c

2011-08-16T17:40:21Z

blank page since content on docs.services.m.c

Gszorc: moved Labs/Weave/Developer/BrowserObjects to Service/Sync/FxSync/Developer/BrowserObjects: Sync is not in labs

2011-08-10T21:56:47Z

moved Labs/Weave/Developer/BrowserObjects to Service/Sync/FxSync/Developer/BrowserObjects: Sync is not in labs

← Older revision	Revision as of 21:56, 10 August 2011
(No difference)

Philikon: /* query */

2011-01-26T21:55:12Z

query

← Older revision		Revision as of 21:55, 26 January 2011
Line 55:		Line 55:

	<b>folderName</b> <i>string</i>: name of the folder/tag to link to		<b>folderName</b> <i>string</i>: name of the folder/tag to link to
			<b>queryId</b> <i>string</i> (optional): identifier of the smart bookmark query

	<b>title</b> <i>string</i>: name of the query		<b>title</b> <i>string</i>: name of the query

Philikon: /* bookmarks (engine version 2) */

2010-12-06T14:58:27Z

bookmarks (engine version 2)

← Older revision		Revision as of 14:58, 6 December 2010
Line 112:		Line 112:

	<b>children</b> <i>array of strings</i>: ordered list of child GUIDs		<b>children</b> <i>array of strings</i>: ordered list of child GUIDs

			* the special folders 'menu' and 'toolbar' now have records that are synced, purely to maintain order within them according to their '''children''' array.

	== clients ==		== clients ==

Philikon at 00:33, 30 November 2010

2010-11-30T00:33:37Z

← Older revision		Revision as of 00:33, 30 November 2010
Line 109:		Line 109:

	* the predecessorid is removed from all records,		* the predecessorid is removed from all records,
	* instead folder and livemark records have a children attribute which is an array of child GUIDs in order of their appearance in the folder		* instead folder and livemark records have a children attribute which is an array of child GUIDs in order of their appearance in the folder:

			<b>children</b> <i>array of strings</i>: ordered list of child GUIDs

	== clients ==		== clients ==

Philikon: /* bookmarks */

2010-11-30T00:27:58Z

bookmarks

← Older revision		Revision as of 00:27, 30 November 2010
Line 9:		Line 9:
	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>.		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 (engine version 1) ==

	One bookmark record exists for each "bookmark item," where an item may actually be a folder or a separator. Each item will have a <tt>type</tt> that determines what other fields are available in the object. The following sections describe the object format for a given <tt>type</tt>.		One bookmark record exists for each "bookmark item," where an item may actually be a folder or a separator. Each item will have a <tt>type</tt> that determines what other fields are available in the object. The following sections describe the object format for a given <tt>type</tt>.
Line 15:		Line 15:
	Each bookmark item has a parentid and predecessorid to form a structure like a tree of linked-lists to provide a hierarchical ordered list of bookmarks, folders, etc.		Each bookmark item has a parentid and predecessorid to form a structure like a tree of linked-lists to provide a hierarchical ordered list of bookmarks, folders, etc.

	==== bookmark ~~(engine version 1)~~ ====		==== bookmark ====

	This describes a regular bookmark that users can click to view a page.		This describes a regular bookmark that users can click to view a page.
Line 30:		Line 30:
	<b>predecessorid</b> <i>string</i>: GUID of the item before this (empty if it's first)		<b>predecessorid</b> <i>string</i>: GUID of the item before this (empty if it's first)
	<b>type</b> <i>string</i>: "bookmark"		<b>type</b> <i>string</i>: "bookmark"

	~~==== bookmark (engine version 2) ====~~

	~~Same as engine version 1, but without predecessorid.~~

	==== microsummary ====		==== microsummary ====
Line 107:		Line 103:
	<b>predecessorid</b> <i>string</i>: GUID of the item before this (empty if it's first)		<b>predecessorid</b> <i>string</i>: GUID of the item before this (empty if it's first)
	<b>type</b> <i>string</i>: "separator"		<b>type</b> <i>string</i>: "separator"

			== bookmarks (engine version 2) ==

			Same as engine version 1, except:

			* the predecessorid is removed from all records,
			* instead folder and livemark records have a children attribute which is an array of child GUIDs in order of their appearance in the folder

	== clients ==		== clients ==

Philikon: /* bookmark */

2010-11-30T00:24:12Z

bookmark

← Older revision		Revision as of 00:24, 30 November 2010
Line 15:		Line 15:
	Each bookmark item has a parentid and predecessorid to form a structure like a tree of linked-lists to provide a hierarchical ordered list of bookmarks, folders, etc.		Each bookmark item has a parentid and predecessorid to form a structure like a tree of linked-lists to provide a hierarchical ordered list of bookmarks, folders, etc.

	==== bookmark ====		==== bookmark (engine version 1) ====

	This describes a regular bookmark that users can click to view a page.		This describes a regular bookmark that users can click to view a page.
Line 30:		Line 30:
	<b>predecessorid</b> <i>string</i>: GUID of the item before this (empty if it's first)		<b>predecessorid</b> <i>string</i>: GUID of the item before this (empty if it's first)
	<b>type</b> <i>string</i>: "bookmark"		<b>type</b> <i>string</i>: "bookmark"

			==== bookmark (engine version 2) ====

			Same as engine version 1, but without predecessorid.

	==== microsummary ====		==== microsummary ====

Philikon: /* prefs (engine version 2) */

2010-11-29T23:58:00Z

prefs (engine version 2)

← Older revision		Revision as of 23:58, 29 November 2010
Line 154:		Line 154:
	There is only one record for preferences, using nsIXULAppInfo.ID as the GUID. Custom preferences can be synced such as [[Labs/Weave/Developer/HowToSynchronizeAddOnPrefs\|add-on preferences]].		There is only one record for preferences, using nsIXULAppInfo.ID as the GUID. Custom preferences can be synced such as [[Labs/Weave/Developer/HowToSynchronizeAddOnPrefs\|add-on preferences]].

	<b>value</b> <i>object</i> containing name and value of the preferences. ~~This includes the~~ preferences that determine which preferences are synced.		<b>value</b> <i>object</i> containing name and value of the preferences.

			Note: The preferences that determine which preferences are synced are now included as well.

	== tabs ==		== tabs ==

Philikon: /* prefs */

2010-11-29T23:56:37Z

prefs

← Older revision		Revision as of 23:56, 29 November 2010
Line 141:		Line 141:
	<b>passwordField</b> <i>string</i>: HTML field name of the password		<b>passwordField</b> <i>string</i>: HTML field name of the password

	== prefs ==		== prefs (engine version 1) ==

	Some preferences used by Firefox will be synced to other clients. There is only one record for preferences with a GUID "preferences". Custom preferences can be synced such as [[Labs/Weave/Developer/HowToSynchronizeAddOnPrefs\|add-on preferences]].		Some preferences used by Firefox will be synced to other clients. There is only one record for preferences with a GUID "preferences". Custom preferences can be synced such as [[Labs/Weave/Developer/HowToSynchronizeAddOnPrefs\|add-on preferences]].
Line 149:		Line 149:
	<b>type</b> <i>string</i>: the type of preference (int, string, boolean)		<b>type</b> <i>string</i>: the type of preference (int, string, boolean)
	<b>value</b> <i>depends on type</i>: value of the preference		<b>value</b> <i>depends on type</i>: value of the preference

			== prefs (engine version 2) ==

			There is only one record for preferences, using nsIXULAppInfo.ID as the GUID. Custom preferences can be synced such as [[Labs/Weave/Developer/HowToSynchronizeAddOnPrefs\|add-on preferences]].

			<b>value</b> <i>object</i> containing name and value of the preferences. This includes the preferences that determine which preferences are synced.

	== tabs ==		== tabs ==

Philikon: documented clients.commands

2010-08-12T14:06:14Z

documented clients.commands

← Older revision		Revision as of 14:06, 12 August 2010
Line 110:		Line 110:
	<b>name</b> <i>string</i>: name of the client connecting		<b>name</b> <i>string</i>: name of the client connecting
	<b>type</b> <i>string</i>: type of the client: "desktop" or "mobile"		<b>type</b> <i>string</i>: type of the client: "desktop" or "mobile"
			<b>commands</b> <i>array</i>: commands to be executed upon next sync

	== forms ==		== forms ==