~kamstrup/zeitgeist/query-expansion

« back to all changes in this revision

Viewing changes to doc/dbus/source/index.rst

  • Committer: "Mikkel Kamstrup Erlandsen"
  • Date: 2009-11-17 19:06:01 UTC
  • mfrom: (1146.2.154 zeitgeist-resonance)
  • Revision ID: mikkel.kamstrup@gmail.com-20091117190601-a8gqi8clxhvcqm0t
MergeĀ lp:~zeitgeist/zeitgeist/zeitgeist-resonanceĀ branch

Show diffs side-by-side

added added

removed removed

Lines of Context:
17
17
Data Types
18
18
==========
19
19
 
20
 
.. _event-label:
21
 
 
22
 
A dict representing an event, with the following elements:
23
 
 
24
 
 #. **timestamp** (integer) - timestamp of the event
25
 
 #. **uri** (string) - unique URI identifying the event
26
 
 #. **subject** - URI of the affected item
27
 
 #. **source** (string) - URI representing the cause of the event
28
 
 #. **content** (string) - URI representing the event type
29
 
 #. **application** (string) - .desktop file of the application related to the event
30
 
 #. **tags** (string) - dict containing lists with different tag strings
31
 
 #. **bookmark** (boolean) - whether the user marked the event as important
32
 
 
33
 
.. _item-label:
34
 
 
35
 
Item
36
 
++++
37
 
 
38
 
A dict representing an item, with the following elements:
39
 
 
40
 
 #. **source** (string) - URI representing where the item originates (file/online/etc.)
41
 
 #. **content** (string) - URI representing the item type (image/video/etc.)
42
 
 #. **mimetype** (string) - mimetype of the item
43
 
 #. **origin** (string) - URI pointing to where the item came from (optional)
44
 
 #. **text** (string) - name of the item (optional)
45
 
 #. **icon** (string) - icon override hint
46
 
 #. **tags** (string) - dict containing lists with different tag strings
47
 
 #. **bookmark** (boolean) - whether the user marked the item as important
48
 
 
49
 
.. _annotation-label:
50
 
 
51
 
Annotation
52
 
++++++++++
53
 
 
54
 
A dict which can have the following items:
55
 
 
56
 
 #. **uri** (string) - URI identifying the annotation item
57
 
 #. **subject** (string) - URI of the relevant item or event
58
 
 #. **source** (string) - URI representing the origin of the annotation's creation
59
 
 #. **content** (string) - URI representing the annotation type
60
 
 #. **text** (string) - text value of the annotation (optional)
61
 
 
62
 
.. _filter-label:
63
 
 
64
 
Filter
65
 
++++++
66
 
 
67
 
A dict which can have the following items:
68
 
 
69
 
 * **name** (list of strings) - filter by name (``OR`` Condition)
70
 
 * **uri** (list of strings) - filter by uris (``OR`` Condition)
71
 
 * **tags** (list of strings) - filter by tags (``AND`` Condition)
72
 
 * **mimetypes** (list of strings) - filter by mimetypes (``OR`` Condition)
73
 
 * **source** (list of strings) - filter by source (``OR`` Condition)
74
 
 * **content** (list of strings) - filter by content (``OR`` Condition)
75
 
 * **application** (list of strings) - filter by application (ie., path to its .desktop file) (``OR`` Condition)
76
 
 * **bookmarked** (boolean) -
 
20
.. _sorting-label:
 
21
 
 
22
Sorting
 
23
+++++++
 
24
 
 
25
An unsigned integer with one of the following values, to determine the
 
26
type of sorting:
 
27
 
 
28
 * **0** - by timestamp (ascending order)
 
29
 * **1** - by timestamp (descending order)
 
30
 * **2** - by timestamp, no repeated items (ascending order)
 
31
 * **3** - by timestamp, no repeated items (descending order)
 
32
 * **4** - by usage, no repeated items (ascending order)
 
33
 * **5** - by usage, no repeated items (descending order)