summaryrefslogtreecommitdiffstats
path: root/services/cloudsync/docs/dataformat.rst
blob: 9165814598edb0c45e20a4316549edbf34cd6dea (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
.. _cloudsync_dataformat:

===========
Data Format
===========

All fields are required unless noted otherwise.

Bookmarks
=========

Record
------

type:
    record type; one of CloudSync.bookmarks.{BOOKMARK, FOLDER, SEPARATOR, QUERY, LIVEMARK}

id:
    GUID for this bookmark item

parent:
    id of parent folder

index:
    item index in parent folder; should be unique and contiguous, or they will be adjusted internally

title:
    bookmark or folder title; not meaningful for separators

dateAdded:
    timestamp (in milliseconds) for item added

lastModified:
    timestamp (in milliseconds) for last modification

uri:
    bookmark URI; not meaningful for folders or separators

version:
    data layout version

Tabs
====

ClientRecord
------------

id:
    GUID for this client

name:
    name for this client; not guaranteed to be unique

tabs:
    list of tabs open on this client; see TabRecord

version:
    data layout version


TabRecord
---------

title:
    name for this tab

url:
    URL for this tab; only one tab for each URL is stored

icon:
    favicon URL for this tab; optional

lastUsed:
    timetamp (in milliseconds) for last use

version:
    data layout version