← Back to branch summary

~ubuntu-branches/ubuntu/wily/telepathy-glib/wily

« back to all changes in this revision

Viewing changes to docs/reference/xml/proxy-subclass.xml

  • Committer: Bazaar Package Importer
  • Author(s): Simon McVittie
  • Date: 2009-03-24 22:06:52 UTC
  • mfrom: (1.3.1 upstream) (17.1.10 sid)
  • Revision ID: james.westby@ubuntu.com-20090324220652-c8dvom0nsqomp23d
Tags: 0.7.28-1
* New upstream version (ABI, API added)
* Put the -dbg package in section debug, as per recent archive changes
* Remove obsolete Conflicts/Replaces with libtelepathy-glib-static-dev, which
  was never in a stable release (and probably never in Debian at all)

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/xml/proxy-subclass.xml
12
12
<refname>TpProxy subclasses and mixins</refname>
13
13
<refpurpose>Providing extra functionality for a <link linkend="TpProxy"><type>TpProxy</type></link> or
14
14
 subclass, or subclassing it</refpurpose>
15
 
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
16
15
</refnamediv>
17
16
 
18
17
<refsynopsisdiv id="telepathy-glib-proxy-subclass.synopsis" role="synopsis">
22
21
 
23
22
#include &lt;telepathy-glib/proxy-subclass.h&gt;
24
23
 
25
 
<link linkend="DBusGProxy">DBusGProxy</link>*         <link linkend="tp-proxy-add-interface-by-id">tp_proxy_add_interface_by_id</link>        (<link linkend="TpProxy">TpProxy</link> *self,
 
24
<link linkend="DBusGProxy">DBusGProxy</link> *        <link linkend="tp-proxy-add-interface-by-id">tp_proxy_add_interface_by_id</link>        (<link linkend="TpProxy">TpProxy</link> *self,
26
25
                                                         <link linkend="GQuark">GQuark</link> interface);
27
 
<link linkend="DBusGProxy">DBusGProxy</link>*         <link linkend="tp-proxy-borrow-interface-by-id">tp_proxy_borrow_interface_by_id</link>     (<link linkend="TpProxy">TpProxy</link> *self,
 
26
<link linkend="DBusGProxy">DBusGProxy</link> *        <link linkend="tp-proxy-borrow-interface-by-id">tp_proxy_borrow_interface_by_id</link>     (<link linkend="TpProxy">TpProxy</link> *self,
28
27
                                                         <link linkend="GQuark">GQuark</link> interface,
29
28
                                                         <link linkend="GError">GError</link> **error);
30
29
<link linkend="void">void</link>                <link linkend="tp-proxy-invalidate">tp_proxy_invalidate</link>                 (<link linkend="TpProxy">TpProxy</link> *self,
50
49
                                                         <link linkend="GCallback">GCallback</link> callback,
51
50
                                                         <link linkend="gpointer">gpointer</link> user_data,
52
51
                                                         <link linkend="GObject">GObject</link> *weak_object);
53
 
<link linkend="TpProxyPendingCall">TpProxyPendingCall</link>* <link linkend="tp-proxy-pending-call-v0-new">tp_proxy_pending_call_v0_new</link>        (<link linkend="TpProxy">TpProxy</link> *self,
 
52
<link linkend="TpProxyPendingCall">TpProxyPendingCall</link> * <link linkend="tp-proxy-pending-call-v0-new">tp_proxy_pending_call_v0_new</link>       (<link linkend="TpProxy">TpProxy</link> *self,
54
53
                                                         <link linkend="GQuark">GQuark</link> interface,
55
54
                                                         const <link linkend="gchar">gchar</link> *member,
56
55
                                                         <link linkend="DBusGProxy">DBusGProxy</link> *iface_proxy,
68
67
                                                        (<link linkend="TpProxyPendingCall">TpProxyPendingCall</link> *pc,
69
68
                                                         <link linkend="GError">GError</link> *error,
70
69
                                                         <link linkend="GValueArray">GValueArray</link> *args);
71
 
<link linkend="TpProxySignalConnection">TpProxySignalConnection</link>* <link linkend="tp-proxy-signal-connection-v0-new">tp_proxy_signal_connection_v0_new</link>
 
70
<link linkend="TpProxySignalConnection">TpProxySignalConnection</link> * <link linkend="tp-proxy-signal-connection-v0-new">tp_proxy_signal_connection_v0_new</link>
72
71
                                                        (<link linkend="TpProxy">TpProxy</link> *self,
73
72
                                                         <link linkend="GQuark">GQuark</link> interface,
74
73
                                                         const <link linkend="gchar">gchar</link> *member,
105
104
Mixin functions to implement particular D-Bus interfaces should usually
106
105
be auto-generated, by copying tools/glib-client-gen.py from telepathy-glib.</para>
107
106
<para>
108
 
 
109
107
</para>
110
108
</refsect1>
111
109
 
113
111
<title role="details.title">Details</title>
114
112
<refsect2 id="tp-proxy-add-interface-by-id" role="function" condition="since:0.7.1">
115
113
<title>tp_proxy_add_interface_by_id ()</title>
116
 
<indexterm zone="tp-proxy-add-interface-by-id" role="0.7.1"><primary>tp_proxy_add_interface_by_id</primary></indexterm><programlisting><link linkend="DBusGProxy">DBusGProxy</link>*         tp_proxy_add_interface_by_id        (<link linkend="TpProxy">TpProxy</link> *self,
 
114
<indexterm zone="tp-proxy-add-interface-by-id" role="0.7.1"><primary sortas="tp_proxy_add_interface_by_id">tp_proxy_add_interface_by_id</primary></indexterm><programlisting><link linkend="DBusGProxy">DBusGProxy</link> *        tp_proxy_add_interface_by_id        (<link linkend="TpProxy">TpProxy</link> *self,
117
115
                                                         <link linkend="GQuark">GQuark</link> interface);</programlisting>
118
116
<para>
119
117
Declare that this proxy supports a given interface, and allocate a
128
126
If the interface is the proxy's "main interface", or has already been
129
127
added, then do nothing.</para>
130
128
<para>
131
 
 
132
129
</para><variablelist role="params">
133
 
<varlistentry><term><parameter>self</parameter>&nbsp;:</term>
 
130
<varlistentry><term><parameter>self</parameter>&#160;:</term>
134
131
<listitem><simpara> the TpProxy
135
132
</simpara></listitem></varlistentry>
136
 
<varlistentry><term><parameter>interface</parameter>&nbsp;:</term>
 
133
<varlistentry><term><parameter>interface</parameter>&#160;:</term>
137
134
<listitem><simpara> quark representing the interface to be added
138
135
</simpara></listitem></varlistentry>
139
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the borrowed DBusGProxy
 
136
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the borrowed DBusGProxy
140
137
 
141
138
</simpara></listitem></varlistentry>
142
 
</variablelist><para role="since">Since  0.7.1
143
 
</para></refsect2>
 
139
</variablelist><para role="since">Since 0.7.1</para></refsect2>
144
140
<refsect2 id="tp-proxy-borrow-interface-by-id" role="function" condition="since:0.7.1">
145
141
<title>tp_proxy_borrow_interface_by_id ()</title>
146
 
<indexterm zone="tp-proxy-borrow-interface-by-id" role="0.7.1"><primary>tp_proxy_borrow_interface_by_id</primary></indexterm><programlisting><link linkend="DBusGProxy">DBusGProxy</link>*         tp_proxy_borrow_interface_by_id     (<link linkend="TpProxy">TpProxy</link> *self,
 
142
<indexterm zone="tp-proxy-borrow-interface-by-id" role="0.7.1"><primary sortas="tp_proxy_borrow_interface_by_id">tp_proxy_borrow_interface_by_id</primary></indexterm><programlisting><link linkend="DBusGProxy">DBusGProxy</link> *        tp_proxy_borrow_interface_by_id     (<link linkend="TpProxy">TpProxy</link> *self,
147
143
                                                         <link linkend="GQuark">GQuark</link> interface,
148
144
                                                         <link linkend="GError">GError</link> **error);</programlisting>
149
145
<para>
150
146
<!-- --></para>
151
147
<para>
152
 
 
153
148
</para><variablelist role="params">
154
 
<varlistentry><term><parameter>self</parameter>&nbsp;:</term>
 
149
<varlistentry><term><parameter>self</parameter>&#160;:</term>
155
150
<listitem><simpara> the TpProxy
156
151
</simpara></listitem></varlistentry>
157
 
<varlistentry><term><parameter>interface</parameter>&nbsp;:</term>
 
152
<varlistentry><term><parameter>interface</parameter>&#160;:</term>
158
153
<listitem><simpara> quark representing the interface required
159
154
</simpara></listitem></varlistentry>
160
 
<varlistentry><term><parameter>error</parameter>&nbsp;:</term>
 
155
<varlistentry><term><parameter>error</parameter>&#160;:</term>
161
156
<listitem><simpara> used to raise TP_DBUS_ERROR_NO_INTERFACE if this object does not
162
157
have the required interface
163
158
</simpara></listitem></varlistentry>
164
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a borrowed reference to a <link linkend="DBusGProxy"><type>DBusGProxy</type></link>
 
159
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a borrowed reference to a <link linkend="DBusGProxy"><type>DBusGProxy</type></link>
165
160
for which the bus name and object path are the same as for <parameter>self</parameter>, but the
166
 
interface is as given (or <link linkend="NULL:CAPS"><literal>NULL</literal></link> if this proxy does not implement it).
 
161
interface is as given (or <link linkend="NULL--CAPS"><literal>NULL</literal></link> if this proxy does not implement it).
167
162
The reference is only valid as long as <parameter>self</parameter> is.
168
163
 
169
164
</simpara></listitem></varlistentry>
170
 
</variablelist><para role="since">Since  0.7.1
171
 
</para></refsect2>
 
165
</variablelist><para role="since">Since 0.7.1</para></refsect2>
172
166
<refsect2 id="tp-proxy-invalidate" role="function" condition="since:0.7.1">
173
167
<title>tp_proxy_invalidate ()</title>
174
 
<indexterm zone="tp-proxy-invalidate" role="0.7.1"><primary>tp_proxy_invalidate</primary></indexterm><programlisting><link linkend="void">void</link>                tp_proxy_invalidate                 (<link linkend="TpProxy">TpProxy</link> *self,
 
168
<indexterm zone="tp-proxy-invalidate" role="0.7.1"><primary sortas="tp_proxy_invalidate">tp_proxy_invalidate</primary></indexterm><programlisting><link linkend="void">void</link>                tp_proxy_invalidate                 (<link linkend="TpProxy">TpProxy</link> *self,
175
169
                                                         const <link linkend="GError">GError</link> *error);</programlisting>
176
170
<para>
177
171
Mark <parameter>self</parameter> as having been invalidated - no further calls will work, and
178
172
if not already invalidated, the <link linkend="TpProxy--invalidated"><type>"invalidated"</type></link> signal will be emitted
179
173
with the given error.</para>
180
174
<para>
181
 
 
182
175
</para><variablelist role="params">
183
 
<varlistentry><term><parameter>self</parameter>&nbsp;:</term>
 
176
<varlistentry><term><parameter>self</parameter>&#160;:</term>
184
177
<listitem><simpara> a proxy
185
178
</simpara></listitem></varlistentry>
186
 
<varlistentry><term><parameter>error</parameter>&nbsp;:</term>
 
179
<varlistentry><term><parameter>error</parameter>&#160;:</term>
187
180
<listitem><simpara> an error causing the invalidation
188
181
</simpara></listitem></varlistentry>
189
 
</variablelist><para role="since">Since  0.7.1
190
 
</para></refsect2>
 
182
</variablelist><para role="since">Since 0.7.1</para></refsect2>
191
183
<refsect2 id="TpProxyInterfaceAddedCb" role="function" condition="since:0.7.1">
192
184
<title>TpProxyInterfaceAddedCb ()</title>
193
 
<indexterm zone="TpProxyInterfaceAddedCb" role="0.7.1"><primary>TpProxyInterfaceAddedCb</primary></indexterm><programlisting><link linkend="void">void</link>                (*TpProxyInterfaceAddedCb)          (<link linkend="TpProxy">TpProxy</link> *self,
 
185
<indexterm zone="TpProxyInterfaceAddedCb" role="0.7.1"><primary sortas="TpProxyInterfaceAddedCb">TpProxyInterfaceAddedCb</primary></indexterm><programlisting><link linkend="void">void</link>                (*TpProxyInterfaceAddedCb)          (<link linkend="TpProxy">TpProxy</link> *self,
194
186
                                                         <link linkend="guint">guint</link> quark,
195
187
                                                         <link linkend="DBusGProxy">DBusGProxy</link> *proxy,
196
188
                                                         <link linkend="gpointer">gpointer</link> unused);</programlisting>
197
189
<para>
198
190
The signature of a <link linkend="TpProxy-interface-added"><type>"interface-added"</type></link> signal callback.</para>
199
191
<para>
200
 
 
201
192
</para><variablelist role="params">
202
 
<varlistentry><term><parameter>self</parameter>&nbsp;:</term>
 
193
<varlistentry><term><parameter>self</parameter>&#160;:</term>
203
194
<listitem><simpara> the proxy
204
195
</simpara></listitem></varlistentry>
205
 
<varlistentry><term><parameter>quark</parameter>&nbsp;:</term>
 
196
<varlistentry><term><parameter>quark</parameter>&#160;:</term>
206
197
<listitem><simpara> a quark whose string value is the interface being added
207
198
</simpara></listitem></varlistentry>
208
 
<varlistentry><term><parameter>proxy</parameter>&nbsp;:</term>
 
199
<varlistentry><term><parameter>proxy</parameter>&#160;:</term>
209
200
<listitem><simpara> the <link linkend="DBusGProxy"><type>DBusGProxy</type></link> for the added interface
210
201
</simpara></listitem></varlistentry>
211
 
<varlistentry><term><parameter>unused</parameter>&nbsp;:</term>
 
202
<varlistentry><term><parameter>unused</parameter>&#160;:</term>
212
203
<listitem><simpara> unused
213
204
</simpara></listitem></varlistentry>
214
 
</variablelist><para role="since">Since  0.7.1
215
 
</para></refsect2>
 
205
</variablelist><para role="since">Since 0.7.1</para></refsect2>
216
206
<refsect2 id="tp-proxy-or-subclass-hook-on-interface-add" role="function" condition="since:0.7.1">
217
207
<title>tp_proxy_or_subclass_hook_on_interface_add ()</title>
218
 
<indexterm zone="tp-proxy-or-subclass-hook-on-interface-add" role="0.7.1"><primary>tp_proxy_or_subclass_hook_on_interface_add</primary></indexterm><programlisting><link linkend="void">void</link>                tp_proxy_or_subclass_hook_on_interface_add
 
208
<indexterm zone="tp-proxy-or-subclass-hook-on-interface-add" role="0.7.1"><primary sortas="tp_proxy_or_subclass_hook_on_interface_add">tp_proxy_or_subclass_hook_on_interface_add</primary></indexterm><programlisting><link linkend="void">void</link>                tp_proxy_or_subclass_hook_on_interface_add
219
209
                                                        (<link linkend="GType">GType</link> proxy_or_subclass,
220
210
                                                         <link linkend="TpProxyInterfaceAddedCb">TpProxyInterfaceAddedCb</link> callback);</programlisting>
221
211
<para>
231
221
call tp_proxy_init_known_interfaces, tp_connection_init_known_interfaces,
232
222
tp_channel_init_known_interfaces etc. as appropriate for the subclass.</para>
233
223
<para>
234
 
 
235
224
</para><variablelist role="params">
236
 
<varlistentry><term><parameter>proxy_or_subclass</parameter>&nbsp;:</term>
 
225
<varlistentry><term><parameter>proxy_or_subclass</parameter>&#160;:</term>
237
226
<listitem><simpara> The <link linkend="GType"><type>GType</type></link> of <link linkend="TpProxy"><type>TpProxy</type></link> or a subclass
238
227
</simpara></listitem></varlistentry>
239
 
<varlistentry><term><parameter>callback</parameter>&nbsp;:</term>
 
228
<varlistentry><term><parameter>callback</parameter>&#160;:</term>
240
229
<listitem><simpara> A signal handler for <link linkend="TpProxy-interface-added"><type>"interface-added"</type></link>
241
230
</simpara></listitem></varlistentry>
242
 
</variablelist><para role="since">Since  0.7.1
243
 
</para></refsect2>
 
231
</variablelist><para role="since">Since 0.7.1</para></refsect2>
244
232
<refsect2 id="tp-proxy-init-known-interfaces" role="function" condition="since:0.7.6">
245
233
<title>tp_proxy_init_known_interfaces ()</title>
246
 
<indexterm zone="tp-proxy-init-known-interfaces" role="0.7.6"><primary>tp_proxy_init_known_interfaces</primary></indexterm><programlisting><link linkend="void">void</link>                tp_proxy_init_known_interfaces      (void);</programlisting>
 
234
<indexterm zone="tp-proxy-init-known-interfaces" role="0.7.6"><primary sortas="tp_proxy_init_known_interfaces">tp_proxy_init_known_interfaces</primary></indexterm><programlisting><link linkend="void">void</link>                tp_proxy_init_known_interfaces      (void);</programlisting>
247
235
<para>
248
236
Ensure that the known interfaces for TpProxy have been set up.
249
237
This is done automatically when necessary, but for correct
255
243
Functions like tp_connection_init_known_interfaces and
256
244
tp_channel_init_known_interfaces do this automatically.</para>
257
245
<para>
258
 
 
259
 
</para><para role="since">Since  0.7.6
260
 
</para></refsect2>
 
246
</para><para role="since">Since 0.7.6</para></refsect2>
261
247
<refsect2 id="tp-proxy-subclass-add-error-mapping" role="function" condition="since:0.7.1">
262
248
<title>tp_proxy_subclass_add_error_mapping ()</title>
263
 
<indexterm zone="tp-proxy-subclass-add-error-mapping" role="0.7.1"><primary>tp_proxy_subclass_add_error_mapping</primary></indexterm><programlisting><link linkend="void">void</link>                tp_proxy_subclass_add_error_mapping (<link linkend="GType">GType</link> proxy_subclass,
 
249
<indexterm zone="tp-proxy-subclass-add-error-mapping" role="0.7.1"><primary sortas="tp_proxy_subclass_add_error_mapping">tp_proxy_subclass_add_error_mapping</primary></indexterm><programlisting><link linkend="void">void</link>                tp_proxy_subclass_add_error_mapping (<link linkend="GType">GType</link> proxy_subclass,
264
250
                                                         const <link linkend="gchar">gchar</link> *static_prefix,
265
251
                                                         <link linkend="GQuark">GQuark</link> domain,
266
252
                                                         <link linkend="GType">GType</link> code_enum_type);</programlisting>
287
273
</para>
288
274
<para>
289
275
If no suitable error mapping or code is found, the <link linkend="GError"><type>GError</type></link> will have
290
 
error domain <link linkend="TP-DBUS-ERRORS:CAPS"><literal>TP_DBUS_ERRORS</literal></link> and error code
291
 
<link linkend="TP-DBUS-ERROR-UNKNOWN-REMOTE-ERROR:CAPS"><literal>TP_DBUS_ERROR_UNKNOWN_REMOTE_ERROR</literal></link>.</para>
 
276
error domain <link linkend="TP-DBUS-ERRORS--CAPS"><literal>TP_DBUS_ERRORS</literal></link> and error code
 
277
<link linkend="TP-DBUS-ERROR-UNKNOWN-REMOTE-ERROR--CAPS"><literal>TP_DBUS_ERROR_UNKNOWN_REMOTE_ERROR</literal></link>.</para>
292
278
<para>
293
 
 
294
279
</para><variablelist role="params">
295
 
<varlistentry><term><parameter>proxy_subclass</parameter>&nbsp;:</term>
 
280
<varlistentry><term><parameter>proxy_subclass</parameter>&#160;:</term>
296
281
<listitem><simpara> The <link linkend="GType"><type>GType</type></link> of a subclass of <link linkend="TpProxy"><type>TpProxy</type></link> (which must not be
297
282
 <link linkend="TpProxy"><type>TpProxy</type></link> itself)
298
283
</simpara></listitem></varlistentry>
299
 
<varlistentry><term><parameter>static_prefix</parameter>&nbsp;:</term>
 
284
<varlistentry><term><parameter>static_prefix</parameter>&#160;:</term>
300
285
<listitem><simpara> A prefix for D-Bus error names, not including the trailing
301
286
 dot (which must remain valid forever, and should usually be in static
302
287
 storage)
303
288
</simpara></listitem></varlistentry>
304
 
<varlistentry><term><parameter>domain</parameter>&nbsp;:</term>
 
289
<varlistentry><term><parameter>domain</parameter>&#160;:</term>
305
290
<listitem><simpara> A quark representing the corresponding <link linkend="GError"><type>GError</type></link> domain
306
291
</simpara></listitem></varlistentry>
307
 
<varlistentry><term><parameter>code_enum_type</parameter>&nbsp;:</term>
 
292
<varlistentry><term><parameter>code_enum_type</parameter>&#160;:</term>
308
293
<listitem><simpara> The type of a subclass of <link linkend="GEnumClass"><type>GEnumClass</type></link>
309
294
</simpara></listitem></varlistentry>
310
 
</variablelist><para role="since">Since  0.7.1
311
 
</para></refsect2>
 
295
</variablelist><para role="since">Since 0.7.1</para></refsect2>
312
296
<refsect2 id="tp-proxy-dbus-g-proxy-claim-for-signal-adding" role="function" condition="since:0.7.6">
313
297
<title>tp_proxy_dbus_g_proxy_claim_for_signal_adding ()</title>
314
 
<indexterm zone="tp-proxy-dbus-g-proxy-claim-for-signal-adding" role="0.7.6"><primary>tp_proxy_dbus_g_proxy_claim_for_signal_adding</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            tp_proxy_dbus_g_proxy_claim_for_signal_adding
 
298
<indexterm zone="tp-proxy-dbus-g-proxy-claim-for-signal-adding" role="0.7.6"><primary sortas="tp_proxy_dbus_g_proxy_claim_for_signal_adding">tp_proxy_dbus_g_proxy_claim_for_signal_adding</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            tp_proxy_dbus_g_proxy_claim_for_signal_adding
315
299
                                                        (<link linkend="DBusGProxy">DBusGProxy</link> *proxy);</programlisting>
316
300
<para>
317
301
Attempt to "claim" a <link linkend="DBusGProxy"><type>DBusGProxy</type></link> for addition of signal signatures.
318
 
If this function has not been called on <parameter>proxy</parameter> before, <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> is
 
302
If this function has not been called on <parameter>proxy</parameter> before, <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> is
319
303
returned, and the caller may safely call <link linkend="dbus-g-proxy-add-signal"><function>dbus_g_proxy_add_signal()</function></link>
320
 
on <parameter>proxy</parameter>. If this function has already been caled, <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> is
 
304
on <parameter>proxy</parameter>. If this function has already been caled, <link linkend="FALSE--CAPS"><literal>FALSE</literal></link> is
321
305
returned, and the caller may not safely call <link linkend="dbus-g-proxy-add-signal"><function>dbus_g_proxy_add_signal()</function></link>.
322
306
</para>
323
307
<para>
325
309
to allow interfaces provided as local extensions to override those in
326
310
telepathy-glib without causing assertion failures.</para>
327
311
<para>
328
 
 
329
312
</para><variablelist role="params">
330
 
<varlistentry><term><parameter>proxy</parameter>&nbsp;:</term>
 
313
<varlistentry><term><parameter>proxy</parameter>&#160;:</term>
331
314
<listitem><simpara> a <link linkend="DBusGProxy"><type>DBusGProxy</type></link>
332
315
</simpara></listitem></varlistentry>
333
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if it is safe to call <link linkend="dbus-g-proxy-add-signal"><function>dbus_g_proxy_add_signal()</function></link>
 
316
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> if it is safe to call <link linkend="dbus-g-proxy-add-signal"><function>dbus_g_proxy_add_signal()</function></link>
334
317
</simpara></listitem></varlistentry>
335
 
</variablelist><para role="since">Since  0.7.6
336
 
</para></refsect2>
 
318
</variablelist><para role="since">Since 0.7.6</para></refsect2>
337
319
<refsect2 id="TpProxyInvokeFunc" role="function" condition="since:0.7.1">
338
320
<title>TpProxyInvokeFunc ()</title>
339
 
<indexterm zone="TpProxyInvokeFunc" role="0.7.1"><primary>TpProxyInvokeFunc</primary></indexterm><programlisting><link linkend="void">void</link>                (*TpProxyInvokeFunc)                (<link linkend="TpProxy">TpProxy</link> *self,
 
321
<indexterm zone="TpProxyInvokeFunc" role="0.7.1"><primary sortas="TpProxyInvokeFunc">TpProxyInvokeFunc</primary></indexterm><programlisting><link linkend="void">void</link>                (*TpProxyInvokeFunc)                (<link linkend="TpProxy">TpProxy</link> *self,
340
322
                                                         <link linkend="GError">GError</link> *error,
341
323
                                                         <link linkend="GValueArray">GValueArray</link> *args,
342
324
                                                         <link linkend="GCallback">GCallback</link> callback,
353
335
rather than from the callback for the reply.
354
336
</para>
355
337
<para>
356
 
At most one of <parameter>args</parameter> and <parameter>error</parameter> can be non-<link linkend="NULL:CAPS"><literal>NULL</literal></link> (implementations may
357
 
assert this). <parameter>args</parameter> and <parameter>error</parameter> may both be <link linkend="NULL:CAPS"><literal>NULL</literal></link> if a method with no
 
338
At most one of <parameter>args</parameter> and <parameter>error</parameter> can be non-<link linkend="NULL--CAPS"><literal>NULL</literal></link> (implementations may
 
339
assert this). <parameter>args</parameter> and <parameter>error</parameter> may both be <link linkend="NULL--CAPS"><literal>NULL</literal></link> if a method with no
358
340
"out" arguments (i.e. a method that returns nothing) was called
359
341
successfully.
360
342
</para>
363
345
and appropriate arguments derived from <parameter>error</parameter> and <parameter>args</parameter>. It is responsible
364
346
for freeing <parameter>error</parameter> and <parameter>args</parameter>, if their ownership has not been transferred.</para>
365
347
<para>
366
 
 
367
348
</para><variablelist role="params">
368
 
<varlistentry><term><parameter>self</parameter>&nbsp;:</term>
 
349
<varlistentry><term><parameter>self</parameter>&#160;:</term>
369
350
<listitem><simpara> the <link linkend="TpProxy"><type>TpProxy</type></link> on which the D-Bus method was invoked
370
351
</simpara></listitem></varlistentry>
371
 
<varlistentry><term><parameter>error</parameter>&nbsp;:</term>
372
 
<listitem><simpara> <link linkend="NULL:CAPS"><literal>NULL</literal></link> if the method call succeeded, or a non-<link linkend="NULL:CAPS"><literal>NULL</literal></link> error if the
 
352
<varlistentry><term><parameter>error</parameter>&#160;:</term>
 
353
<listitem><simpara> <link linkend="NULL--CAPS"><literal>NULL</literal></link> if the method call succeeded, or a non-<link linkend="NULL--CAPS"><literal>NULL</literal></link> error if the
373
354
 method call failed
374
355
</simpara></listitem></varlistentry>
375
 
<varlistentry><term><parameter>args</parameter>&nbsp;:</term>
 
356
<varlistentry><term><parameter>args</parameter>&#160;:</term>
376
357
<listitem><simpara> array of "out" arguments (return values) for the D-Bus method,
377
 
 or <link linkend="NULL:CAPS"><literal>NULL</literal></link> if an error occurred or if there were no "out" arguments
 
358
 or <link linkend="NULL--CAPS"><literal>NULL</literal></link> if an error occurred or if there were no "out" arguments
378
359
</simpara></listitem></varlistentry>
379
 
<varlistentry><term><parameter>callback</parameter>&nbsp;:</term>
 
360
<varlistentry><term><parameter>callback</parameter>&#160;:</term>
380
361
<listitem><simpara> the callback that should be invoked, as passed to
381
362
 <link linkend="tp-proxy-pending-call-v0-new"><function>tp_proxy_pending_call_v0_new()</function></link>
382
363
</simpara></listitem></varlistentry>
383
 
<varlistentry><term><parameter>user_data</parameter>&nbsp;:</term>
 
364
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
384
365
<listitem><simpara> user-supplied data to pass to the callback, as passed to
385
366
 <link linkend="tp-proxy-pending-call-v0-new"><function>tp_proxy_pending_call_v0_new()</function></link>
386
367
</simpara></listitem></varlistentry>
387
 
<varlistentry><term><parameter>weak_object</parameter>&nbsp;:</term>
 
368
<varlistentry><term><parameter>weak_object</parameter>&#160;:</term>
388
369
<listitem><simpara> user-supplied object to pass to the callback, as passed to
389
370
 <link linkend="tp-proxy-pending-call-v0-new"><function>tp_proxy_pending_call_v0_new()</function></link>
390
371
</simpara></listitem></varlistentry>
391
 
</variablelist><para role="since">Since  0.7.1
392
 
</para></refsect2>
 
372
</variablelist><para role="since">Since 0.7.1</para></refsect2>
393
373
<refsect2 id="tp-proxy-pending-call-v0-new" role="function" condition="since:0.7.1">
394
374
<title>tp_proxy_pending_call_v0_new ()</title>
395
 
<indexterm zone="tp-proxy-pending-call-v0-new" role="0.7.1"><primary>tp_proxy_pending_call_v0_new</primary></indexterm><programlisting><link linkend="TpProxyPendingCall">TpProxyPendingCall</link>* tp_proxy_pending_call_v0_new        (<link linkend="TpProxy">TpProxy</link> *self,
 
375
<indexterm zone="tp-proxy-pending-call-v0-new" role="0.7.1"><primary sortas="tp_proxy_pending_call_v0_new">tp_proxy_pending_call_v0_new</primary></indexterm><programlisting><link linkend="TpProxyPendingCall">TpProxyPendingCall</link> * tp_proxy_pending_call_v0_new       (<link linkend="TpProxy">TpProxy</link> *self,
396
376
                                                         <link linkend="GQuark">GQuark</link> interface,
397
377
                                                         const <link linkend="gchar">gchar</link> *member,
398
378
                                                         <link linkend="DBusGProxy">DBusGProxy</link> *iface_proxy,
427
407
should usually only be called from code generated by
428
408
tools/glib-client-gen.py.</para>
429
409
<para>
430
 
 
431
410
</para><variablelist role="params">
432
 
<varlistentry><term><parameter>self</parameter>&nbsp;:</term>
 
411
<varlistentry><term><parameter>self</parameter>&#160;:</term>
433
412
<listitem><simpara> a proxy
434
413
</simpara></listitem></varlistentry>
435
 
<varlistentry><term><parameter>interface</parameter>&nbsp;:</term>
 
414
<varlistentry><term><parameter>interface</parameter>&#160;:</term>
436
415
<listitem><simpara> a quark whose string value is the D-Bus interface
437
416
</simpara></listitem></varlistentry>
438
 
<varlistentry><term><parameter>member</parameter>&nbsp;:</term>
 
417
<varlistentry><term><parameter>member</parameter>&#160;:</term>
439
418
<listitem><simpara> the name of the method being called
440
419
</simpara></listitem></varlistentry>
441
 
<varlistentry><term><parameter>iface_proxy</parameter>&nbsp;:</term>
 
420
<varlistentry><term><parameter>iface_proxy</parameter>&#160;:</term>
442
421
<listitem><simpara> the interface-specific <link linkend="DBusGProxy"><type>DBusGProxy</type></link> for <parameter>interface</parameter>
443
422
</simpara></listitem></varlistentry>
444
 
<varlistentry><term><parameter>invoke_callback</parameter>&nbsp;:</term>
 
423
<varlistentry><term><parameter>invoke_callback</parameter>&#160;:</term>
445
424
<listitem><simpara> an implementation of <link linkend="TpProxyInvokeFunc"><type>TpProxyInvokeFunc</type></link> which will
446
425
 invoke <parameter>callback</parameter> with appropriate arguments
447
426
</simpara></listitem></varlistentry>
448
 
<varlistentry><term><parameter>callback</parameter>&nbsp;:</term>
 
427
<varlistentry><term><parameter>callback</parameter>&#160;:</term>
449
428
<listitem><simpara> a callback to be called when the call completes
450
429
</simpara></listitem></varlistentry>
451
 
<varlistentry><term><parameter>user_data</parameter>&nbsp;:</term>
 
430
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
452
431
<listitem><simpara> user-supplied data for the callback
453
432
</simpara></listitem></varlistentry>
454
 
<varlistentry><term><parameter>destroy</parameter>&nbsp;:</term>
 
433
<varlistentry><term><parameter>destroy</parameter>&#160;:</term>
455
434
<listitem><simpara> user-supplied destructor for the data
456
435
</simpara></listitem></varlistentry>
457
 
<varlistentry><term><parameter>weak_object</parameter>&nbsp;:</term>
458
 
<listitem><simpara> if not <link linkend="NULL:CAPS"><literal>NULL</literal></link>, a <link linkend="GObject"><type>GObject</type></link> which will be weakly referenced by
 
436
<varlistentry><term><parameter>weak_object</parameter>&#160;:</term>
 
437
<listitem><simpara> if not <link linkend="NULL--CAPS"><literal>NULL</literal></link>, a <link linkend="GObject"><type>GObject</type></link> which will be weakly referenced by
459
438
  the signal connection - if it is destroyed, the pending call will
460
439
  automatically be cancelled
461
440
</simpara></listitem></varlistentry>
462
 
<varlistentry><term><parameter>cancel_must_raise</parameter>&nbsp;:</term>
463
 
<listitem><simpara> if <link linkend="TRUE:CAPS"><literal>TRUE</literal></link>, the <parameter>invoke_callback</parameter> will be run with
464
 
 error <link linkend="TP-DBUS-ERROR-CANCELLED:CAPS"><literal>TP_DBUS_ERROR_CANCELLED</literal></link> if the call is cancelled by a call to
 
441
<varlistentry><term><parameter>cancel_must_raise</parameter>&#160;:</term>
 
442
<listitem><simpara> if <link linkend="TRUE--CAPS"><literal>TRUE</literal></link>, the <parameter>invoke_callback</parameter> will be run with
 
443
 error <link linkend="TP-DBUS-ERROR-CANCELLED--CAPS"><literal>TP_DBUS_ERROR_CANCELLED</literal></link> if the call is cancelled by a call to
465
444
 <link linkend="tp-proxy-pending-call-cancel"><function>tp_proxy_pending_call_cancel()</function></link> or by destruction of the <link linkend="weak-object"><function>weak_object()</function></link>;
466
 
 if <link linkend="FALSE:CAPS"><literal>FALSE</literal></link>, the <parameter>invoke_callback</parameter> will not be run at all in these cases
 
445
 if <link linkend="FALSE--CAPS"><literal>FALSE</literal></link>, the <parameter>invoke_callback</parameter> will not be run at all in these cases
467
446
</simpara></listitem></varlistentry>
468
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a new pending call structure
 
447
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a new pending call structure
469
448
 
470
449
</simpara></listitem></varlistentry>
471
 
</variablelist><para role="since">Since  0.7.1
472
 
</para></refsect2>
 
450
</variablelist><para role="since">Since 0.7.1</para></refsect2>
473
451
<refsect2 id="tp-proxy-pending-call-v0-completed" role="function" condition="since:0.7.1">
474
452
<title>tp_proxy_pending_call_v0_completed ()</title>
475
 
<indexterm zone="tp-proxy-pending-call-v0-completed" role="0.7.1"><primary>tp_proxy_pending_call_v0_completed</primary></indexterm><programlisting><link linkend="void">void</link>                tp_proxy_pending_call_v0_completed  (<link linkend="gpointer">gpointer</link> p);</programlisting>
 
453
<indexterm zone="tp-proxy-pending-call-v0-completed" role="0.7.1"><primary sortas="tp_proxy_pending_call_v0_completed">tp_proxy_pending_call_v0_completed</primary></indexterm><programlisting><link linkend="void">void</link>                tp_proxy_pending_call_v0_completed  (<link linkend="gpointer">gpointer</link> p);</programlisting>
476
454
<para>
477
455
Indicate that dbus-glib has finished with this pending call, and therefore
478
456
either <link linkend="tp-proxy-pending-call-v0-take-results"><function>tp_proxy_pending_call_v0_take_results()</function></link> has already been called,
486
464
should usually only be called from code generated by
487
465
tools/glib-client-gen.py.</para>
488
466
<para>
489
 
 
490
467
</para><variablelist role="params">
491
 
<varlistentry><term><parameter>p</parameter>&nbsp;:</term>
 
468
<varlistentry><term><parameter>p</parameter>&#160;:</term>
492
469
<listitem><simpara> a <link linkend="TpProxyPendingCall"><type>TpProxyPendingCall</type></link> allocated with <link linkend="tp-proxy-pending-call-new"><function>tp_proxy_pending_call_new()</function></link>
493
470
</simpara></listitem></varlistentry>
494
 
</variablelist><para role="since">Since  0.7.1
495
 
</para></refsect2>
 
471
</variablelist><para role="since">Since 0.7.1</para></refsect2>
496
472
<refsect2 id="tp-proxy-pending-call-v0-take-pending-call" role="function" condition="since:0.7.1">
497
473
<title>tp_proxy_pending_call_v0_take_pending_call ()</title>
498
 
<indexterm zone="tp-proxy-pending-call-v0-take-pending-call" role="0.7.1"><primary>tp_proxy_pending_call_v0_take_pending_call</primary></indexterm><programlisting><link linkend="void">void</link>                tp_proxy_pending_call_v0_take_pending_call
 
474
<indexterm zone="tp-proxy-pending-call-v0-take-pending-call" role="0.7.1"><primary sortas="tp_proxy_pending_call_v0_take_pending_call">tp_proxy_pending_call_v0_take_pending_call</primary></indexterm><programlisting><link linkend="void">void</link>                tp_proxy_pending_call_v0_take_pending_call
499
475
                                                        (<link linkend="TpProxyPendingCall">TpProxyPendingCall</link> *pc,
500
476
                                                         <link linkend="DBusGProxyCall">DBusGProxyCall</link> *pending_call);</programlisting>
501
477
<para>
507
483
should usually only be called from code generated by
508
484
tools/glib-client-gen.py.</para>
509
485
<para>
510
 
 
511
486
</para><variablelist role="params">
512
 
<varlistentry><term><parameter>pc</parameter>&nbsp;:</term>
 
487
<varlistentry><term><parameter>pc</parameter>&#160;:</term>
513
488
<listitem><simpara> A pending call on which this function has not yet been called
514
489
</simpara></listitem></varlistentry>
515
 
<varlistentry><term><parameter>pending_call</parameter>&nbsp;:</term>
 
490
<varlistentry><term><parameter>pending_call</parameter>&#160;:</term>
516
491
<listitem><simpara> The underlying dbus-glib pending call
517
492
</simpara></listitem></varlistentry>
518
 
</variablelist><para role="since">Since  0.7.1
519
 
</para></refsect2>
 
493
</variablelist><para role="since">Since 0.7.1</para></refsect2>
520
494
<refsect2 id="tp-proxy-pending-call-v0-take-results" role="function" condition="since:0.7.1">
521
495
<title>tp_proxy_pending_call_v0_take_results ()</title>
522
 
<indexterm zone="tp-proxy-pending-call-v0-take-results" role="0.7.1"><primary>tp_proxy_pending_call_v0_take_results</primary></indexterm><programlisting><link linkend="void">void</link>                tp_proxy_pending_call_v0_take_results
 
496
<indexterm zone="tp-proxy-pending-call-v0-take-results" role="0.7.1"><primary sortas="tp_proxy_pending_call_v0_take_results">tp_proxy_pending_call_v0_take_results</primary></indexterm><programlisting><link linkend="void">void</link>                tp_proxy_pending_call_v0_take_results
523
497
                                                        (<link linkend="TpProxyPendingCall">TpProxyPendingCall</link> *pc,
524
498
                                                         <link linkend="GError">GError</link> *error,
525
499
                                                         <link linkend="GValueArray">GValueArray</link> *args);</programlisting>
532
506
should usually only be called from code generated by
533
507
tools/glib-client-gen.py.</para>
534
508
<para>
535
 
 
536
509
</para><variablelist role="params">
537
 
<varlistentry><term><parameter>pc</parameter>&nbsp;:</term>
 
510
<varlistentry><term><parameter>pc</parameter>&#160;:</term>
538
511
<listitem><simpara> A pending call on which this function has not yet been called
539
512
</simpara></listitem></varlistentry>
540
 
<varlistentry><term><parameter>error</parameter>&nbsp;:</term>
541
 
<listitem><simpara> <link linkend="NULL:CAPS"><literal>NULL</literal></link> if the call was successful, or an error (whose ownership
 
513
<varlistentry><term><parameter>error</parameter>&#160;:</term>
 
514
<listitem><simpara> <link linkend="NULL--CAPS"><literal>NULL</literal></link> if the call was successful, or an error (whose ownership
542
515
 is taken over by the pending call object). Because of dbus-glib
543
516
 idiosyncrasies, this must be the error produced by dbus-glib, not a copy.
544
517
</simpara></listitem></varlistentry>
545
 
<varlistentry><term><parameter>args</parameter>&nbsp;:</term>
546
 
<listitem><simpara> <link linkend="NULL:CAPS"><literal>NULL</literal></link> if the call failed or had no "out" arguments, or an array
 
518
<varlistentry><term><parameter>args</parameter>&#160;:</term>
 
519
<listitem><simpara> <link linkend="NULL--CAPS"><literal>NULL</literal></link> if the call failed or had no "out" arguments, or an array
547
520
 of "out" arguments (whose ownership is taken over by the pending call
548
521
 object)
549
522
</simpara></listitem></varlistentry>
550
 
</variablelist><para role="since">Since  0.7.1
551
 
</para></refsect2>
 
523
</variablelist><para role="since">Since 0.7.1</para></refsect2>
552
524
<refsect2 id="tp-proxy-signal-connection-v0-new" role="function" condition="since:0.7.1">
553
525
<title>tp_proxy_signal_connection_v0_new ()</title>
554
 
<indexterm zone="tp-proxy-signal-connection-v0-new" role="0.7.1"><primary>tp_proxy_signal_connection_v0_new</primary></indexterm><programlisting><link linkend="TpProxySignalConnection">TpProxySignalConnection</link>* tp_proxy_signal_connection_v0_new
 
526
<indexterm zone="tp-proxy-signal-connection-v0-new" role="0.7.1"><primary sortas="tp_proxy_signal_connection_v0_new">tp_proxy_signal_connection_v0_new</primary></indexterm><programlisting><link linkend="TpProxySignalConnection">TpProxySignalConnection</link> * tp_proxy_signal_connection_v0_new
555
527
                                                        (<link linkend="TpProxy">TpProxy</link> *self,
556
528
                                                         <link linkend="GQuark">GQuark</link> interface,
557
529
                                                         const <link linkend="gchar">gchar</link> *member,
572
544
should usually only be called from code generated by
573
545
tools/glib-client-gen.py.</para>
574
546
<para>
575
 
 
576
547
</para><variablelist role="params">
577
 
<varlistentry><term><parameter>self</parameter>&nbsp;:</term>
 
548
<varlistentry><term><parameter>self</parameter>&#160;:</term>
578
549
<listitem><simpara> a proxy
579
550
</simpara></listitem></varlistentry>
580
 
<varlistentry><term><parameter>interface</parameter>&nbsp;:</term>
 
551
<varlistentry><term><parameter>interface</parameter>&#160;:</term>
581
552
<listitem><simpara> a quark whose string value is the D-Bus interface
582
553
</simpara></listitem></varlistentry>
583
 
<varlistentry><term><parameter>member</parameter>&nbsp;:</term>
 
554
<varlistentry><term><parameter>member</parameter>&#160;:</term>
584
555
<listitem><simpara> the name of the signal to which we're connecting
585
556
</simpara></listitem></varlistentry>
586
 
<varlistentry><term><parameter>expected_types</parameter>&nbsp;:</term>
 
557
<varlistentry><term><parameter>expected_types</parameter>&#160;:</term>
587
558
<listitem><simpara> an array of expected GTypes for the arguments, terminated
588
 
 by <link linkend="G-TYPE-INVALID:CAPS"><literal>G_TYPE_INVALID</literal></link>
 
559
 by <link linkend="G-TYPE-INVALID--CAPS"><literal>G_TYPE_INVALID</literal></link>
589
560
</simpara></listitem></varlistentry>
590
 
<varlistentry><term><parameter>collect_args</parameter>&nbsp;:</term>
 
561
<varlistentry><term><parameter>collect_args</parameter>&#160;:</term>
591
562
<listitem><simpara> a callback to be given to <link linkend="dbus-g-proxy-connect-signal"><function>dbus_g_proxy_connect_signal()</function></link>,
592
563
 which must marshal the arguments into a <link linkend="GValueArray"><type>GValueArray</type></link> and use them to call
593
564
 <link linkend="tp-proxy-signal-connection-v0-take-results"><function>tp_proxy_signal_connection_v0_take_results()</function></link>; this callback is not
594
565
 guaranteed to be called by future versions of telepathy-glib, which might
595
566
 be able to implement its functionality internally. If no arguments are
596
567
 expected at all (expected_types = { G_TYPE_INVALID }) then this callback
597
 
 should instead be <link linkend="NULL:CAPS"><literal>NULL</literal></link>
 
568
 should instead be <link linkend="NULL--CAPS"><literal>NULL</literal></link>
598
569
</simpara></listitem></varlistentry>
599
 
<varlistentry><term><parameter>invoke_callback</parameter>&nbsp;:</term>
600
 
<listitem><simpara> a function which will be called with <parameter>error</parameter> = <link linkend="NULL:CAPS"><literal>NULL</literal></link>,
 
570
<varlistentry><term><parameter>invoke_callback</parameter>&#160;:</term>
 
571
<listitem><simpara> a function which will be called with <parameter>error</parameter> = <link linkend="NULL--CAPS"><literal>NULL</literal></link>,
601
572
 which should invoke <parameter>callback</parameter> with <parameter>user_data</parameter>, <parameter>weak_object</parameter> and other
602
573
 appropriate arguments taken from <parameter>args</parameter>
603
574
</simpara></listitem></varlistentry>
604
 
<varlistentry><term><parameter>callback</parameter>&nbsp;:</term>
 
575
<varlistentry><term><parameter>callback</parameter>&#160;:</term>
605
576
<listitem><simpara> user callback to be invoked by <parameter>invoke_callback</parameter>
606
577
</simpara></listitem></varlistentry>
607
 
<varlistentry><term><parameter>user_data</parameter>&nbsp;:</term>
 
578
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
608
579
<listitem><simpara> user-supplied data for the callback
609
580
</simpara></listitem></varlistentry>
610
 
<varlistentry><term><parameter>destroy</parameter>&nbsp;:</term>
 
581
<varlistentry><term><parameter>destroy</parameter>&#160;:</term>
611
582
<listitem><simpara> user-supplied destructor for the data, which will be called
612
583
  when the signal connection is disconnected for any reason,
613
584
  or will be called before this function returns if an error occurs
614
585
</simpara></listitem></varlistentry>
615
 
<varlistentry><term><parameter>weak_object</parameter>&nbsp;:</term>
616
 
<listitem><simpara> if not <link linkend="NULL:CAPS"><literal>NULL</literal></link>, a <link linkend="GObject"><type>GObject</type></link> which will be weakly referenced by
 
586
<varlistentry><term><parameter>weak_object</parameter>&#160;:</term>
 
587
<listitem><simpara> if not <link linkend="NULL--CAPS"><literal>NULL</literal></link>, a <link linkend="GObject"><type>GObject</type></link> which will be weakly referenced by
617
588
  the signal connection - if it is destroyed, the signal connection will
618
589
  automatically be disconnected
619
590
</simpara></listitem></varlistentry>
620
 
<varlistentry><term><parameter>error</parameter>&nbsp;:</term>
621
 
<listitem><simpara> If not <link linkend="NULL:CAPS"><literal>NULL</literal></link>, used to raise an error if <link linkend="NULL:CAPS"><literal>NULL</literal></link> is returned
 
591
<varlistentry><term><parameter>error</parameter>&#160;:</term>
 
592
<listitem><simpara> If not <link linkend="NULL--CAPS"><literal>NULL</literal></link>, used to raise an error if <link linkend="NULL--CAPS"><literal>NULL</literal></link> is returned
622
593
</simpara></listitem></varlistentry>
623
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a signal connection structure, or <link linkend="NULL:CAPS"><literal>NULL</literal></link> if the proxy does not
 
594
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a signal connection structure, or <link linkend="NULL--CAPS"><literal>NULL</literal></link> if the proxy does not
624
595
 have the desired interface or has become invalid
625
596
 
626
597
</simpara></listitem></varlistentry>
627
 
</variablelist><para role="since">Since  0.7.1
628
 
</para></refsect2>
 
598
</variablelist><para role="since">Since 0.7.1</para></refsect2>
629
599
<refsect2 id="tp-proxy-signal-connection-v0-take-results" role="function" condition="since:0.7.1">
630
600
<title>tp_proxy_signal_connection_v0_take_results ()</title>
631
 
<indexterm zone="tp-proxy-signal-connection-v0-take-results" role="0.7.1"><primary>tp_proxy_signal_connection_v0_take_results</primary></indexterm><programlisting><link linkend="void">void</link>                tp_proxy_signal_connection_v0_take_results
 
601
<indexterm zone="tp-proxy-signal-connection-v0-take-results" role="0.7.1"><primary sortas="tp_proxy_signal_connection_v0_take_results">tp_proxy_signal_connection_v0_take_results</primary></indexterm><programlisting><link linkend="void">void</link>                tp_proxy_signal_connection_v0_take_results
632
602
                                                        (<link linkend="TpProxySignalConnection">TpProxySignalConnection</link> *sc,
633
603
                                                         <link linkend="GValueArray">GValueArray</link> *args);</programlisting>
634
604
<para>
639
609
This method should only be called from <link linkend="TpProxy"><type>TpProxy</type></link> subclass implementations,
640
610
in the callback that implements <parameter>collect_args</parameter>.</para>
641
611
<para>
642
 
 
643
612
</para><variablelist role="params">
644
 
<varlistentry><term><parameter>sc</parameter>&nbsp;:</term>
 
613
<varlistentry><term><parameter>sc</parameter>&#160;:</term>
645
614
<listitem><simpara> The signal connection
646
615
</simpara></listitem></varlistentry>
647
 
<varlistentry><term><parameter>args</parameter>&nbsp;:</term>
 
616
<varlistentry><term><parameter>args</parameter>&#160;:</term>
648
617
<listitem><simpara> The arguments of the signal
649
618
</simpara></listitem></varlistentry>
650
 
</variablelist><para role="since">Since  0.7.1
651
 
</para></refsect2>
 
619
</variablelist><para role="since">Since 0.7.1</para></refsect2>
652
620
 
653
621
</refsect1>
654
622
 
656
624
 
657
625
<refsect1 id="telepathy-glib-proxy-subclass.see-also">
658
626
<title>See Also</title>
659
 
<link linkend="TpProxy"><type>TpProxy</type></link>
 
627
#TpProxy
660
628
</refsect1>
661
629
 
662
630
</refentry>