← Back to branch summary

~zeitgeist-packagers/libzeitgeist/ubuntu

« back to all changes in this revision

Viewing changes to src/docbook-interface-org.gnome.zeitgeist.Log.xml

  • Committer: Sebastien Bacher
  • Date: 2010-12-17 11:24:32 UTC
  • mfrom: (130.2.8 upstream)
  • Revision ID: seb128@ubuntu.com-20101217112432-fvpa4ogpotl4k0pz
* New upstream version
* debian/control: 
  - don't use libeggdbus, update the requirement on libglib for gdbus
  - updated for the new soname
* Updated the .install and the .symbols for the new soname

Show diffs side-by-side

added added

removed removed

Lines of Context:
src/docbook-interface-org.gnome.zeitgeist.Log.xml
1
 
<?xml version="1.0"?>
2
 
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2 //EN"
3
 
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
4
 
<refentry id="eggdbus-interface-org.gnome.zeitgeist.Log">
5
 
  <refmeta>
6
 
    <refentrytitle role="top_of_page">org.gnome.zeitgeist.Log Interface</refentrytitle>
7
 
  </refmeta>
8
 
  <refnamediv>
9
 
    <refname>org.gnome.zeitgeist.Log Interface</refname>
10
 
    <refpurpose>FIXME: not documented.</refpurpose>
11
 
  </refnamediv>
12
 
  <refsynopsisdiv role="synopsis">
13
 
    <title role="synopsis.title">Methods</title>
14
 
    <synopsis>
15
 
<link linkend="eggdbus-method-org.gnome.zeitgeist.Log.InsertEvents">InsertEvents</link>    (IN  Array&lt;<link linkend="eggdbus-struct-Event">Event</link>&gt;   events,
16
 
                 OUT Array&lt;UInt32&gt;  event_ids)
17
 
<link linkend="eggdbus-method-org.gnome.zeitgeist.Log.DeleteLog">DeleteLog</link>       ()
18
 
<link linkend="eggdbus-method-org.gnome.zeitgeist.Log.FindRelatedUris">FindRelatedUris</link> (IN  <link linkend="eggdbus-struct-TimeRange">TimeRange</link>      time_range,
19
 
                 IN  Array&lt;<link linkend="eggdbus-struct-Event">Event</link>&gt;   event_templates,
20
 
                 IN  Array&lt;<link linkend="eggdbus-struct-Event">Event</link>&gt;   result_event_templates,
21
 
                 IN  <link linkend="eggdbus-enum-StorageState">StorageState</link>   storage_state,
22
 
                 IN  UInt32         num_events,
23
 
                 IN  <link linkend="eggdbus-enum-ResultType">ResultType</link>     result_type,
24
 
                 OUT Array&lt;String&gt;  subject_uris)
25
 
<link linkend="eggdbus-method-org.gnome.zeitgeist.Log.FindEvents">FindEvents</link>      (IN  <link linkend="eggdbus-struct-TimeRange">TimeRange</link>      time_range,
26
 
                 IN  Array&lt;<link linkend="eggdbus-struct-Event">Event</link>&gt;   event_templates,
27
 
                 IN  <link linkend="eggdbus-enum-StorageState">StorageState</link>   storage_state,
28
 
                 IN  UInt32         num_events,
29
 
                 IN  <link linkend="eggdbus-enum-ResultType">ResultType</link>     result_type,
30
 
                 OUT Array&lt;<link linkend="eggdbus-struct-Event">Event</link>&gt;   events)
31
 
<link linkend="eggdbus-method-org.gnome.zeitgeist.Log.FindEventIds">FindEventIds</link>    (IN  <link linkend="eggdbus-struct-TimeRange">TimeRange</link>      time_range,
32
 
                 IN  Array&lt;<link linkend="eggdbus-struct-Event">Event</link>&gt;   event_templates,
33
 
                 IN  <link linkend="eggdbus-enum-StorageState">StorageState</link>   storage_state,
34
 
                 IN  UInt32         num_events,
35
 
                 IN  <link linkend="eggdbus-enum-ResultType">ResultType</link>     result_type,
36
 
                 OUT Array&lt;UInt32&gt;  event_ids)
37
 
<link linkend="eggdbus-method-org.gnome.zeitgeist.Log.DeleteEvents">DeleteEvents</link>    (IN  Array&lt;UInt32&gt;  event_ids)
38
 
<link linkend="eggdbus-method-org.gnome.zeitgeist.Log.Quit">Quit</link>            ()
39
 
<link linkend="eggdbus-method-org.gnome.zeitgeist.Log.GetEvents">GetEvents</link>       (IN  Array&lt;UInt32&gt;  event_ids,
40
 
                 OUT Array&lt;<link linkend="eggdbus-struct-Event">Event</link>&gt;   events)
41
 
<link linkend="eggdbus-method-org.gnome.zeitgeist.Log.InstallMonitor">InstallMonitor</link>  (IN  ObjectPath     monitor_path,
42
 
                 IN  <link linkend="eggdbus-struct-TimeRange">TimeRange</link>      time_range,
43
 
                 IN  Array&lt;<link linkend="eggdbus-struct-Event">Event</link>&gt;   event_templates)
44
 
<link linkend="eggdbus-method-org.gnome.zeitgeist.Log.RemoveMonitor">RemoveMonitor</link>   (IN  ObjectPath     monitor_path)
45
 
    </synopsis>
46
 
  </refsynopsisdiv>
47
 
  <refsect1 role="desc" id="eggdbus-if-description-org.gnome.zeitgeist.Log">
48
 
    <title role="desc.title">Description</title>
49
 
      <para>
50
 
FIXME: not documented.
51
 
      </para>
52
 
  </refsect1>
53
 
  <refsect1 role="details" id="eggdbus-if-method-details-org.gnome.zeitgeist.Log">
54
 
    <title role="details.title">Method Details</title>
55
 
    <refsect2 role="function" id="eggdbus-method-org.gnome.zeitgeist.Log.InsertEvents">
56
 
      <title>InsertEvents ()</title>
57
 
    <programlisting>
58
 
InsertEvents (IN  Array&lt;<link linkend="eggdbus-struct-Event">Event</link>&gt;   events,
59
 
              OUT Array&lt;UInt32&gt;  event_ids)
60
 
    </programlisting>
61
 
    <para>
62
 
FIXME: not documented.
63
 
    </para>
64
 
<variablelist role="params">
65
 
  <varlistentry>
66
 
    <term><literal>IN  Array&lt;<link linkend="eggdbus-struct-Event">Event</link>&gt; <parameter>events</parameter></literal>:</term>
67
 
    <listitem>
68
 
      <para>
69
 
FIXME: not documented.
70
 
      </para>
71
 
    </listitem>
72
 
  </varlistentry>
73
 
  <varlistentry>
74
 
    <term><literal>OUT Array&lt;UInt32&gt; <parameter>event_ids</parameter></literal>:</term>
75
 
    <listitem>
76
 
      <para>
77
 
FIXME: not documented.
78
 
      </para>
79
 
    </listitem>
80
 
  </varlistentry>
81
 
</variablelist>
82
 
    </refsect2>
83
 
    <refsect2 role="function" id="eggdbus-method-org.gnome.zeitgeist.Log.DeleteLog">
84
 
      <title>DeleteLog ()</title>
85
 
    <programlisting>
86
 
DeleteLog ()
87
 
    </programlisting>
88
 
    <para>
89
 
FIXME: not documented.
90
 
    </para>
91
 
<variablelist role="params">
92
 
</variablelist>
93
 
    </refsect2>
94
 
    <refsect2 role="function" id="eggdbus-method-org.gnome.zeitgeist.Log.FindRelatedUris">
95
 
      <title>FindRelatedUris ()</title>
96
 
    <programlisting>
97
 
FindRelatedUris (IN  <link linkend="eggdbus-struct-TimeRange">TimeRange</link>      time_range,
98
 
                 IN  Array&lt;<link linkend="eggdbus-struct-Event">Event</link>&gt;   event_templates,
99
 
                 IN  Array&lt;<link linkend="eggdbus-struct-Event">Event</link>&gt;   result_event_templates,
100
 
                 IN  <link linkend="eggdbus-enum-StorageState">StorageState</link>   storage_state,
101
 
                 IN  UInt32         num_events,
102
 
                 IN  <link linkend="eggdbus-enum-ResultType">ResultType</link>     result_type,
103
 
                 OUT Array&lt;String&gt;  subject_uris)
104
 
    </programlisting>
105
 
    <para>
106
 
FIXME: not documented.
107
 
    </para>
108
 
<variablelist role="params">
109
 
  <varlistentry>
110
 
    <term><literal>IN  <link linkend="eggdbus-struct-TimeRange">TimeRange</link> <parameter>time_range</parameter></literal>:</term>
111
 
    <listitem>
112
 
      <para>
113
 
FIXME: not documented.
114
 
      </para>
115
 
    </listitem>
116
 
  </varlistentry>
117
 
  <varlistentry>
118
 
    <term><literal>IN  Array&lt;<link linkend="eggdbus-struct-Event">Event</link>&gt; <parameter>event_templates</parameter></literal>:</term>
119
 
    <listitem>
120
 
      <para>
121
 
FIXME: not documented.
122
 
      </para>
123
 
    </listitem>
124
 
  </varlistentry>
125
 
  <varlistentry>
126
 
    <term><literal>IN  Array&lt;<link linkend="eggdbus-struct-Event">Event</link>&gt; <parameter>result_event_templates</parameter></literal>:</term>
127
 
    <listitem>
128
 
      <para>
129
 
FIXME: not documented.
130
 
      </para>
131
 
    </listitem>
132
 
  </varlistentry>
133
 
  <varlistentry>
134
 
    <term><literal>IN  <link linkend="eggdbus-enum-StorageState">StorageState</link> <parameter>storage_state</parameter></literal>:</term>
135
 
    <listitem>
136
 
      <para>
137
 
FIXME: not documented.
138
 
      </para>
139
 
    </listitem>
140
 
  </varlistentry>
141
 
  <varlistentry>
142
 
    <term><literal>IN  UInt32 <parameter>num_events</parameter></literal>:</term>
143
 
    <listitem>
144
 
      <para>
145
 
FIXME: not documented.
146
 
      </para>
147
 
    </listitem>
148
 
  </varlistentry>
149
 
  <varlistentry>
150
 
    <term><literal>IN  <link linkend="eggdbus-enum-ResultType">ResultType</link> <parameter>result_type</parameter></literal>:</term>
151
 
    <listitem>
152
 
      <para>
153
 
FIXME: not documented.
154
 
      </para>
155
 
    </listitem>
156
 
  </varlistentry>
157
 
  <varlistentry>
158
 
    <term><literal>OUT Array&lt;String&gt; <parameter>subject_uris</parameter></literal>:</term>
159
 
    <listitem>
160
 
      <para>
161
 
An array of subject URIs
162
 
      </para>
163
 
    </listitem>
164
 
  </varlistentry>
165
 
</variablelist>
166
 
    </refsect2>
167
 
    <refsect2 role="function" id="eggdbus-method-org.gnome.zeitgeist.Log.FindEvents">
168
 
      <title>FindEvents ()</title>
169
 
    <programlisting>
170
 
FindEvents (IN  <link linkend="eggdbus-struct-TimeRange">TimeRange</link>     time_range,
171
 
            IN  Array&lt;<link linkend="eggdbus-struct-Event">Event</link>&gt;  event_templates,
172
 
            IN  <link linkend="eggdbus-enum-StorageState">StorageState</link>  storage_state,
173
 
            IN  UInt32        num_events,
174
 
            IN  <link linkend="eggdbus-enum-ResultType">ResultType</link>    result_type,
175
 
            OUT Array&lt;<link linkend="eggdbus-struct-Event">Event</link>&gt;  events)
176
 
    </programlisting>
177
 
    <para>
178
 
FIXME: not documented.
179
 
    </para>
180
 
<variablelist role="params">
181
 
  <varlistentry>
182
 
    <term><literal>IN  <link linkend="eggdbus-struct-TimeRange">TimeRange</link> <parameter>time_range</parameter></literal>:</term>
183
 
    <listitem>
184
 
      <para>
185
 
FIXME: not documented.
186
 
      </para>
187
 
    </listitem>
188
 
  </varlistentry>
189
 
  <varlistentry>
190
 
    <term><literal>IN  Array&lt;<link linkend="eggdbus-struct-Event">Event</link>&gt; <parameter>event_templates</parameter></literal>:</term>
191
 
    <listitem>
192
 
      <para>
193
 
FIXME: not documented.
194
 
      </para>
195
 
    </listitem>
196
 
  </varlistentry>
197
 
  <varlistentry>
198
 
    <term><literal>IN  <link linkend="eggdbus-enum-StorageState">StorageState</link> <parameter>storage_state</parameter></literal>:</term>
199
 
    <listitem>
200
 
      <para>
201
 
FIXME: not documented.
202
 
      </para>
203
 
    </listitem>
204
 
  </varlistentry>
205
 
  <varlistentry>
206
 
    <term><literal>IN  UInt32 <parameter>num_events</parameter></literal>:</term>
207
 
    <listitem>
208
 
      <para>
209
 
FIXME: not documented.
210
 
      </para>
211
 
    </listitem>
212
 
  </varlistentry>
213
 
  <varlistentry>
214
 
    <term><literal>IN  <link linkend="eggdbus-enum-ResultType">ResultType</link> <parameter>result_type</parameter></literal>:</term>
215
 
    <listitem>
216
 
      <para>
217
 
FIXME: not documented.
218
 
      </para>
219
 
    </listitem>
220
 
  </varlistentry>
221
 
  <varlistentry>
222
 
    <term><literal>OUT Array&lt;<link linkend="eggdbus-struct-Event">Event</link>&gt; <parameter>events</parameter></literal>:</term>
223
 
    <listitem>
224
 
      <para>
225
 
FIXME: not documented.
226
 
      </para>
227
 
    </listitem>
228
 
  </varlistentry>
229
 
</variablelist>
230
 
    </refsect2>
231
 
    <refsect2 role="function" id="eggdbus-method-org.gnome.zeitgeist.Log.FindEventIds">
232
 
      <title>FindEventIds ()</title>
233
 
    <programlisting>
234
 
FindEventIds (IN  <link linkend="eggdbus-struct-TimeRange">TimeRange</link>      time_range,
235
 
              IN  Array&lt;<link linkend="eggdbus-struct-Event">Event</link>&gt;   event_templates,
236
 
              IN  <link linkend="eggdbus-enum-StorageState">StorageState</link>   storage_state,
237
 
              IN  UInt32         num_events,
238
 
              IN  <link linkend="eggdbus-enum-ResultType">ResultType</link>     result_type,
239
 
              OUT Array&lt;UInt32&gt;  event_ids)
240
 
    </programlisting>
241
 
    <para>
242
 
FIXME: not documented.
243
 
    </para>
244
 
<variablelist role="params">
245
 
  <varlistentry>
246
 
    <term><literal>IN  <link linkend="eggdbus-struct-TimeRange">TimeRange</link> <parameter>time_range</parameter></literal>:</term>
247
 
    <listitem>
248
 
      <para>
249
 
FIXME: not documented.
250
 
      </para>
251
 
    </listitem>
252
 
  </varlistentry>
253
 
  <varlistentry>
254
 
    <term><literal>IN  Array&lt;<link linkend="eggdbus-struct-Event">Event</link>&gt; <parameter>event_templates</parameter></literal>:</term>
255
 
    <listitem>
256
 
      <para>
257
 
FIXME: not documented.
258
 
      </para>
259
 
    </listitem>
260
 
  </varlistentry>
261
 
  <varlistentry>
262
 
    <term><literal>IN  <link linkend="eggdbus-enum-StorageState">StorageState</link> <parameter>storage_state</parameter></literal>:</term>
263
 
    <listitem>
264
 
      <para>
265
 
FIXME: not documented.
266
 
      </para>
267
 
    </listitem>
268
 
  </varlistentry>
269
 
  <varlistentry>
270
 
    <term><literal>IN  UInt32 <parameter>num_events</parameter></literal>:</term>
271
 
    <listitem>
272
 
      <para>
273
 
FIXME: not documented.
274
 
      </para>
275
 
    </listitem>
276
 
  </varlistentry>
277
 
  <varlistentry>
278
 
    <term><literal>IN  <link linkend="eggdbus-enum-ResultType">ResultType</link> <parameter>result_type</parameter></literal>:</term>
279
 
    <listitem>
280
 
      <para>
281
 
FIXME: not documented.
282
 
      </para>
283
 
    </listitem>
284
 
  </varlistentry>
285
 
  <varlistentry>
286
 
    <term><literal>OUT Array&lt;UInt32&gt; <parameter>event_ids</parameter></literal>:</term>
287
 
    <listitem>
288
 
      <para>
289
 
An array of event ids
290
 
      </para>
291
 
    </listitem>
292
 
  </varlistentry>
293
 
</variablelist>
294
 
    </refsect2>
295
 
    <refsect2 role="function" id="eggdbus-method-org.gnome.zeitgeist.Log.DeleteEvents">
296
 
      <title>DeleteEvents ()</title>
297
 
    <programlisting>
298
 
DeleteEvents (IN  Array&lt;UInt32&gt;  event_ids)
299
 
    </programlisting>
300
 
    <para>
301
 
FIXME: not documented.
302
 
    </para>
303
 
<variablelist role="params">
304
 
  <varlistentry>
305
 
    <term><literal>IN  Array&lt;UInt32&gt; <parameter>event_ids</parameter></literal>:</term>
306
 
    <listitem>
307
 
      <para>
308
 
FIXME: not documented.
309
 
      </para>
310
 
    </listitem>
311
 
  </varlistentry>
312
 
</variablelist>
313
 
    </refsect2>
314
 
    <refsect2 role="function" id="eggdbus-method-org.gnome.zeitgeist.Log.Quit">
315
 
      <title>Quit ()</title>
316
 
    <programlisting>
317
 
Quit ()
318
 
    </programlisting>
319
 
    <para>
320
 
FIXME: not documented.
321
 
    </para>
322
 
<variablelist role="params">
323
 
</variablelist>
324
 
    </refsect2>
325
 
    <refsect2 role="function" id="eggdbus-method-org.gnome.zeitgeist.Log.GetEvents">
326
 
      <title>GetEvents ()</title>
327
 
    <programlisting>
328
 
GetEvents (IN  Array&lt;UInt32&gt;  event_ids,
329
 
           OUT Array&lt;<link linkend="eggdbus-struct-Event">Event</link>&gt;   events)
330
 
    </programlisting>
331
 
    <para>
332
 
Get a set of events given their event ids
333
 
    </para>
334
 
<variablelist role="params">
335
 
  <varlistentry>
336
 
    <term><literal>IN  Array&lt;UInt32&gt; <parameter>event_ids</parameter></literal>:</term>
337
 
    <listitem>
338
 
      <para>
339
 
FIXME: not documented.
340
 
      </para>
341
 
    </listitem>
342
 
  </varlistentry>
343
 
  <varlistentry>
344
 
    <term><literal>OUT Array&lt;<link linkend="eggdbus-struct-Event">Event</link>&gt; <parameter>events</parameter></literal>:</term>
345
 
    <listitem>
346
 
      <para>
347
 
FIXME: not documented.
348
 
      </para>
349
 
    </listitem>
350
 
  </varlistentry>
351
 
</variablelist>
352
 
    </refsect2>
353
 
    <refsect2 role="function" id="eggdbus-method-org.gnome.zeitgeist.Log.InstallMonitor">
354
 
      <title>InstallMonitor ()</title>
355
 
    <programlisting>
356
 
InstallMonitor (IN  ObjectPath    monitor_path,
357
 
                IN  <link linkend="eggdbus-struct-TimeRange">TimeRange</link>     time_range,
358
 
                IN  Array&lt;<link linkend="eggdbus-struct-Event">Event</link>&gt;  event_templates)
359
 
    </programlisting>
360
 
    <para>
361
 
FIXME: not documented.
362
 
    </para>
363
 
<variablelist role="params">
364
 
  <varlistentry>
365
 
    <term><literal>IN  ObjectPath <parameter>monitor_path</parameter></literal>:</term>
366
 
    <listitem>
367
 
      <para>
368
 
FIXME: not documented.
369
 
      </para>
370
 
    </listitem>
371
 
  </varlistentry>
372
 
  <varlistentry>
373
 
    <term><literal>IN  <link linkend="eggdbus-struct-TimeRange">TimeRange</link> <parameter>time_range</parameter></literal>:</term>
374
 
    <listitem>
375
 
      <para>
376
 
FIXME: not documented.
377
 
      </para>
378
 
    </listitem>
379
 
  </varlistentry>
380
 
  <varlistentry>
381
 
    <term><literal>IN  Array&lt;<link linkend="eggdbus-struct-Event">Event</link>&gt; <parameter>event_templates</parameter></literal>:</term>
382
 
    <listitem>
383
 
      <para>
384
 
FIXME: not documented.
385
 
      </para>
386
 
    </listitem>
387
 
  </varlistentry>
388
 
</variablelist>
389
 
    </refsect2>
390
 
    <refsect2 role="function" id="eggdbus-method-org.gnome.zeitgeist.Log.RemoveMonitor">
391
 
      <title>RemoveMonitor ()</title>
392
 
    <programlisting>
393
 
RemoveMonitor (IN  ObjectPath  monitor_path)
394
 
    </programlisting>
395
 
    <para>
396
 
FIXME: not documented.
397
 
    </para>
398
 
<variablelist role="params">
399
 
  <varlistentry>
400
 
    <term><literal>IN  ObjectPath <parameter>monitor_path</parameter></literal>:</term>
401
 
    <listitem>
402
 
      <para>
403
 
FIXME: not documented.
404
 
      </para>
405
 
    </listitem>
406
 
  </varlistentry>
407
 
</variablelist>
408
 
    </refsect2>
409
 
  </refsect1>
410
 
</refentry>