← Back to branch summary

~ubuntu-branches/ubuntu/precise/libzeitgeist/precise-proposed

« back to all changes in this revision

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

  • Committer: Bazaar Package Importer
  • Author(s): Didier Roche
  • Date: 2010-08-02 18:22:32 UTC
  • mfrom: (1.1.1 upstream)
  • Revision ID: james.westby@ubuntu.com-20100802182232-47ohrpyfxep802pr
Tags: 0.2.3-0ubuntu1
* New upstream release.
  - New API to talk to the Data Source Registry extension of Zeitgeist
    (Michal Hruby)
  - A new "connected" property on ZeitgeistLog telling you whether or
    not the Zeitgeist daemon is running (Michal Hruby)
  - Fix a crasher when finalizing a ZeitgeistLog with active monitors
    installed (Michal Hruby)

Show diffs side-by-side

added added

removed removed

Lines of Context:
src/docbook-interface-org.gnome.zeitgeist.DataSourceRegistry.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.DataSourceRegistry">
 
5
  <refmeta>
 
6
    <refentrytitle role="top_of_page">org.gnome.zeitgeist.DataSourceRegistry Interface</refentrytitle>
 
7
  </refmeta>
 
8
  <refnamediv>
 
9
    <refname>org.gnome.zeitgeist.DataSourceRegistry 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.DataSourceRegistry.RegisterDataSource">RegisterDataSource</link>   (IN  String             unique_id,
 
16
                      IN  String             name,
 
17
                      IN  String             description,
 
18
                      IN  Array&lt;<link linkend="eggdbus-struct-Event">Event</link>&gt;       event_templates,
 
19
                      OUT Boolean            result)
 
20
<link linkend="eggdbus-method-org.gnome.zeitgeist.DataSourceRegistry.SetDataSourceEnabled">SetDataSourceEnabled</link> (IN  String             unique_id,
 
21
                      IN  Boolean            enabled)
 
22
<link linkend="eggdbus-method-org.gnome.zeitgeist.DataSourceRegistry.GetDataSources">GetDataSources</link>       (OUT Array&lt;<link linkend="eggdbus-struct-DataSource">DataSource</link>&gt;  arg_0)
 
23
    </synopsis>
 
24
  </refsynopsisdiv>
 
25
  <refsect1 role="signal_proto" id="eggdbus-if-signals-org.gnome.zeitgeist.DataSourceRegistry">
 
26
    <title role="signal_proto.title">Signals</title>
 
27
    <synopsis>
 
28
<link linkend="eggdbus-signal-org.gnome.zeitgeist.DataSourceRegistry::DataSourceRegistered">DataSourceRegistered</link>   (<link linkend="eggdbus-struct-DataSource">DataSource</link>  arg_0)
 
29
<link linkend="eggdbus-signal-org.gnome.zeitgeist.DataSourceRegistry::DataSourceDisconnected">DataSourceDisconnected</link> (<link linkend="eggdbus-struct-DataSource">DataSource</link>  arg_0)
 
30
<link linkend="eggdbus-signal-org.gnome.zeitgeist.DataSourceRegistry::DataSourceEnabled">DataSourceEnabled</link>      (String      unique_id,
 
31
                        Boolean     enabled)
 
32
    </synopsis>
 
33
  </refsect1>
 
34
  <refsect1 role="desc" id="eggdbus-if-description-org.gnome.zeitgeist.DataSourceRegistry">
 
35
    <title role="desc.title">Description</title>
 
36
      <para>
 
37
An extension which allows you to registers data sources in a central repository. This allows for example to disable some data sources.
 
38
      </para>
 
39
  </refsect1>
 
40
  <refsect1 role="details" id="eggdbus-if-method-details-org.gnome.zeitgeist.DataSourceRegistry">
 
41
    <title role="details.title">Method Details</title>
 
42
    <refsect2 role="function" id="eggdbus-method-org.gnome.zeitgeist.DataSourceRegistry.RegisterDataSource">
 
43
      <title>RegisterDataSource ()</title>
 
44
    <programlisting>
 
45
RegisterDataSource (IN  String        unique_id,
 
46
                    IN  String        name,
 
47
                    IN  String        description,
 
48
                    IN  Array&lt;<link linkend="eggdbus-struct-Event">Event</link>&gt;  event_templates,
 
49
                    OUT Boolean       result)
 
50
    </programlisting>
 
51
    <para>
 
52
FIXME: not documented.
 
53
    </para>
 
54
<variablelist role="params">
 
55
  <varlistentry>
 
56
    <term><literal>IN  String <parameter>unique_id</parameter></literal>:</term>
 
57
    <listitem>
 
58
      <para>
 
59
FIXME: not documented.
 
60
      </para>
 
61
    </listitem>
 
62
  </varlistentry>
 
63
  <varlistentry>
 
64
    <term><literal>IN  String <parameter>name</parameter></literal>:</term>
 
65
    <listitem>
 
66
      <para>
 
67
FIXME: not documented.
 
68
      </para>
 
69
    </listitem>
 
70
  </varlistentry>
 
71
  <varlistentry>
 
72
    <term><literal>IN  String <parameter>description</parameter></literal>:</term>
 
73
    <listitem>
 
74
      <para>
 
75
FIXME: not documented.
 
76
      </para>
 
77
    </listitem>
 
78
  </varlistentry>
 
79
  <varlistentry>
 
80
    <term><literal>IN  Array&lt;<link linkend="eggdbus-struct-Event">Event</link>&gt; <parameter>event_templates</parameter></literal>:</term>
 
81
    <listitem>
 
82
      <para>
 
83
FIXME: not documented.
 
84
      </para>
 
85
    </listitem>
 
86
  </varlistentry>
 
87
  <varlistentry>
 
88
    <term><literal>OUT Boolean <parameter>result</parameter></literal>:</term>
 
89
    <listitem>
 
90
      <para>
 
91
FIXME: not documented.
 
92
      </para>
 
93
    </listitem>
 
94
  </varlistentry>
 
95
</variablelist>
 
96
    </refsect2>
 
97
    <refsect2 role="function" id="eggdbus-method-org.gnome.zeitgeist.DataSourceRegistry.SetDataSourceEnabled">
 
98
      <title>SetDataSourceEnabled ()</title>
 
99
    <programlisting>
 
100
SetDataSourceEnabled (IN  String   unique_id,
 
101
                      IN  Boolean  enabled)
 
102
    </programlisting>
 
103
    <para>
 
104
FIXME: not documented.
 
105
    </para>
 
106
<variablelist role="params">
 
107
  <varlistentry>
 
108
    <term><literal>IN  String <parameter>unique_id</parameter></literal>:</term>
 
109
    <listitem>
 
110
      <para>
 
111
FIXME: not documented.
 
112
      </para>
 
113
    </listitem>
 
114
  </varlistentry>
 
115
  <varlistentry>
 
116
    <term><literal>IN  Boolean <parameter>enabled</parameter></literal>:</term>
 
117
    <listitem>
 
118
      <para>
 
119
FIXME: not documented.
 
120
      </para>
 
121
    </listitem>
 
122
  </varlistentry>
 
123
</variablelist>
 
124
    </refsect2>
 
125
    <refsect2 role="function" id="eggdbus-method-org.gnome.zeitgeist.DataSourceRegistry.GetDataSources">
 
126
      <title>GetDataSources ()</title>
 
127
    <programlisting>
 
128
GetDataSources (OUT Array&lt;<link linkend="eggdbus-struct-DataSource">DataSource</link>&gt;  arg_0)
 
129
    </programlisting>
 
130
    <para>
 
131
FIXME: not documented.
 
132
    </para>
 
133
<variablelist role="params">
 
134
  <varlistentry>
 
135
    <term><literal>OUT Array&lt;<link linkend="eggdbus-struct-DataSource">DataSource</link>&gt; <parameter>arg_0</parameter></literal>:</term>
 
136
    <listitem>
 
137
      <para>
 
138
FIXME: not documented.
 
139
      </para>
 
140
    </listitem>
 
141
  </varlistentry>
 
142
</variablelist>
 
143
    </refsect2>
 
144
  </refsect1>
 
145
  <refsect1 role="signals" id="eggdbus-if-signal-details-org.gnome.zeitgeist.DataSourceRegistry">
 
146
    <title role="signals.title">Signal Details</title>
 
147
    <refsect2 role="signal" id="eggdbus-signal-org.gnome.zeitgeist.DataSourceRegistry::DataSourceRegistered">
 
148
      <title>The "DataSourceRegistered" signal</title>
 
149
    <programlisting>
 
150
DataSourceRegistered (<link linkend="eggdbus-struct-DataSource">DataSource</link>  arg_0)
 
151
    </programlisting>
 
152
    <para>
 
153
FIXME: not documented.
 
154
    </para>
 
155
<variablelist role="params">
 
156
  <varlistentry>
 
157
    <term><literal><link linkend="eggdbus-struct-DataSource">DataSource</link> <parameter>arg_0</parameter></literal>:</term>
 
158
    <listitem>
 
159
      <para>
 
160
FIXME: not documented.
 
161
      </para>
 
162
    </listitem>
 
163
  </varlistentry>
 
164
</variablelist>
 
165
    </refsect2>
 
166
    <refsect2 role="signal" id="eggdbus-signal-org.gnome.zeitgeist.DataSourceRegistry::DataSourceDisconnected">
 
167
      <title>The "DataSourceDisconnected" signal</title>
 
168
    <programlisting>
 
169
DataSourceDisconnected (<link linkend="eggdbus-struct-DataSource">DataSource</link>  arg_0)
 
170
    </programlisting>
 
171
    <para>
 
172
FIXME: not documented.
 
173
    </para>
 
174
<variablelist role="params">
 
175
  <varlistentry>
 
176
    <term><literal><link linkend="eggdbus-struct-DataSource">DataSource</link> <parameter>arg_0</parameter></literal>:</term>
 
177
    <listitem>
 
178
      <para>
 
179
FIXME: not documented.
 
180
      </para>
 
181
    </listitem>
 
182
  </varlistentry>
 
183
</variablelist>
 
184
    </refsect2>
 
185
    <refsect2 role="signal" id="eggdbus-signal-org.gnome.zeitgeist.DataSourceRegistry::DataSourceEnabled">
 
186
      <title>The "DataSourceEnabled" signal</title>
 
187
    <programlisting>
 
188
DataSourceEnabled (String   unique_id,
 
189
                   Boolean  enabled)
 
190
    </programlisting>
 
191
    <para>
 
192
FIXME: not documented.
 
193
    </para>
 
194
<variablelist role="params">
 
195
  <varlistentry>
 
196
    <term><literal>String <parameter>unique_id</parameter></literal>:</term>
 
197
    <listitem>
 
198
      <para>
 
199
FIXME: not documented.
 
200
      </para>
 
201
    </listitem>
 
202
  </varlistentry>
 
203
  <varlistentry>
 
204
    <term><literal>Boolean <parameter>enabled</parameter></literal>:</term>
 
205
    <listitem>
 
206
      <para>
 
207
FIXME: not documented.
 
208
      </para>
 
209
    </listitem>
 
210
  </varlistentry>
 
211
</variablelist>
 
212
    </refsect2>
 
213
  </refsect1>
 
214
</refentry>