~ubuntu-branches/ubuntu/precise/telepathy-glib/precise-201202222208

« back to all changes in this revision

Viewing changes to docs/reference/html/telepathy-glib-connection-contact-list.html

  • Committer: Ken VanDine
  • Date: 2012-02-22 18:08:37 UTC
  • mfrom: (1.6.39)
  • Revision ID: ken.vandine@canonical.com-20120222180837-02um6fex0eg073lf
New upstream release.

Show diffs side-by-side

added added

removed removed

Lines of Context:
255
255
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>,
256
256
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Datasets.html#GDestroyNotify"><span class="type">GDestroyNotify</span></a> destroy</code></em>,
257
257
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a> *weak_object</code></em>);
 
258
<a class="link" href="telepathy-glib-proxy.html#TpProxyPendingCall" title="TpProxyPendingCall"><span class="returnvalue">TpProxyPendingCall</span></a> * <a class="link" href="telepathy-glib-connection-contact-list.html#tp-cli-connection-interface-contact-list-call-download" title="tp_cli_connection_interface_contact_list_call_download ()">tp_cli_connection_interface_contact_list_call_download</a>
 
259
                                                        (<em class="parameter"><code><a class="link" href="telepathy-glib-connection.html#TpConnection"><span class="type">TpConnection</span></a> *proxy</code></em>,
 
260
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> timeout_ms</code></em>,
 
261
                                                         <em class="parameter"><code><a class="link" href="telepathy-glib-connection-contact-list.html#tp-cli-connection-interface-contact-list-callback-for-download" title="tp_cli_connection_interface_contact_list_callback_for_download ()"><span class="type">tp_cli_connection_interface_contact_list_callback_for_download</span></a> callback</code></em>,
 
262
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>,
 
263
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Datasets.html#GDestroyNotify"><span class="type">GDestroyNotify</span></a> destroy</code></em>,
 
264
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a> *weak_object</code></em>);
258
265
<a class="link" href="telepathy-glib-proxy.html#TpProxyPendingCall" title="TpProxyPendingCall"><span class="returnvalue">TpProxyPendingCall</span></a> * <a class="link" href="telepathy-glib-connection-contact-list.html#tp-cli-connection-interface-contact-list-call-remove-contacts" title="tp_cli_connection_interface_contact_list_call_remove_contacts ()">tp_cli_connection_interface_contact_list_call_remove_contacts</a>
259
266
                                                        (<em class="parameter"><code><a class="link" href="telepathy-glib-connection.html#TpConnection"><span class="type">TpConnection</span></a> *proxy</code></em>,
260
267
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> timeout_ms</code></em>,
293
300
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> *error</code></em>,
294
301
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>,
295
302
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a> *weak_object</code></em>);
 
303
<span class="returnvalue">void</span>                (<a class="link" href="telepathy-glib-connection-contact-list.html#tp-cli-connection-interface-contact-list-callback-for-download" title="tp_cli_connection_interface_contact_list_callback_for_download ()">*tp_cli_connection_interface_contact_list_callback_for_download</a>)
 
304
                                                        (<em class="parameter"><code><a class="link" href="telepathy-glib-connection.html#TpConnection"><span class="type">TpConnection</span></a> *proxy</code></em>,
 
305
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> *error</code></em>,
 
306
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>,
 
307
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a> *weak_object</code></em>);
296
308
<span class="returnvalue">void</span>                (<a class="link" href="telepathy-glib-connection-contact-list.html#tp-cli-connection-interface-contact-list-callback-for-remove-contacts" title="tp_cli_connection_interface_contact_list_callback_for_remove_contacts ()">*tp_cli_connection_interface_contact_list_callback_for_remove_contacts</a>)
297
309
                                                        (<em class="parameter"><code><a class="link" href="telepathy-glib-connection.html#TpConnection"><span class="type">TpConnection</span></a> *proxy</code></em>,
298
310
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> *error</code></em>,
2096
2108
</div>
2097
2109
<hr>
2098
2110
<div class="refsect2">
 
2111
<a name="tp-cli-connection-interface-contact-list-call-download"></a><h3>tp_cli_connection_interface_contact_list_call_download ()</h3>
 
2112
<pre class="programlisting"><a class="link" href="telepathy-glib-proxy.html#TpProxyPendingCall" title="TpProxyPendingCall"><span class="returnvalue">TpProxyPendingCall</span></a> * tp_cli_connection_interface_contact_list_call_download
 
2113
                                                        (<em class="parameter"><code><a class="link" href="telepathy-glib-connection.html#TpConnection"><span class="type">TpConnection</span></a> *proxy</code></em>,
 
2114
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> timeout_ms</code></em>,
 
2115
                                                         <em class="parameter"><code><a class="link" href="telepathy-glib-connection-contact-list.html#tp-cli-connection-interface-contact-list-callback-for-download" title="tp_cli_connection_interface_contact_list_callback_for_download ()"><span class="type">tp_cli_connection_interface_contact_list_callback_for_download</span></a> callback</code></em>,
 
2116
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>,
 
2117
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Datasets.html#GDestroyNotify"><span class="type">GDestroyNotify</span></a> destroy</code></em>,
 
2118
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a> *weak_object</code></em>);</pre>
 
2119
<p>
 
2120
Start a Download method call.
 
2121
</p>
 
2122
<p>
 
2123
&lt;tp:docstring xmlns="http://www.w3.org/1999/xhtml"&gt;         &lt;p&gt;Download the contact list from the server. If           &lt;tp:member-ref&gt;DownloadAtConnection&lt;/tp:member-ref&gt; is true,           Download does nothing.&lt;/p&gt;
 
2124
</p>
 
2125
<div class="variablelist"><table border="0">
 
2126
<col align="left" valign="top">
 
2127
<tbody>
 
2128
<tr>
 
2129
<td><p><span class="term"><em class="parameter"><code>proxy</code></em> :</span></p></td>
 
2130
<td>the <a class="link" href="telepathy-glib-proxy.html#TpProxy"><span class="type">TpProxy</span></a>
 
2131
</td>
 
2132
</tr>
 
2133
<tr>
 
2134
<td><p><span class="term"><em class="parameter"><code>timeout_ms</code></em> :</span></p></td>
 
2135
<td>the timeout in milliseconds, or -1 to use the
 
2136
default</td>
 
2137
</tr>
 
2138
<tr>
 
2139
<td><p><span class="term"><em class="parameter"><code>callback</code></em> :</span></p></td>
 
2140
<td>called when the method call succeeds or fails;
 
2141
may be <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to make a "fire and forget" call with no
 
2142
reply tracking</td>
 
2143
</tr>
 
2144
<tr>
 
2145
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
 
2146
<td>user-supplied data passed to the callback;
 
2147
must be <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if <em class="parameter"><code>callback</code></em> is <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
 
2148
</td>
 
2149
</tr>
 
2150
<tr>
 
2151
<td><p><span class="term"><em class="parameter"><code>destroy</code></em> :</span></p></td>
 
2152
<td>called with the user_data as argument, after the
 
2153
call has succeeded, failed or been cancelled;
 
2154
must be <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if <em class="parameter"><code>callback</code></em> is <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
 
2155
</td>
 
2156
</tr>
 
2157
<tr>
 
2158
<td><p><span class="term"><em class="parameter"><code>weak_object</code></em> :</span></p></td>
 
2159
<td>If not <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, a <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a> which will be
 
2160
weakly referenced; if it is destroyed, this call
 
2161
will automatically be cancelled. Must be <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if
 
2162
<em class="parameter"><code>callback</code></em> is <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
 
2163
</td>
 
2164
</tr>
 
2165
<tr>
 
2166
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
2167
<td>a <a class="link" href="telepathy-glib-proxy.html#TpProxyPendingCall" title="TpProxyPendingCall"><span class="type">TpProxyPendingCall</span></a> representing the call in
 
2168
progress. It is borrowed from the object, and will become
 
2169
invalid when the callback is called, the call is
 
2170
cancelled or the <a class="link" href="telepathy-glib-proxy.html#TpProxy"><span class="type">TpProxy</span></a> becomes invalid.</td>
 
2171
</tr>
 
2172
</tbody>
 
2173
</table></div>
 
2174
</div>
 
2175
<hr>
 
2176
<div class="refsect2">
2099
2177
<a name="tp-cli-connection-interface-contact-list-call-remove-contacts"></a><h3>tp_cli_connection_interface_contact_list_call_remove_contacts ()</h3>
2100
2178
<pre class="programlisting"><a class="link" href="telepathy-glib-proxy.html#TpProxyPendingCall" title="TpProxyPendingCall"><span class="returnvalue">TpProxyPendingCall</span></a> * tp_cli_connection_interface_contact_list_call_remove_contacts
2101
2179
                                                        (<em class="parameter"><code><a class="link" href="telepathy-glib-connection.html#TpConnection"><span class="type">TpConnection</span></a> *proxy</code></em>,
2420
2498
</div>
2421
2499
<hr>
2422
2500
<div class="refsect2">
 
2501
<a name="tp-cli-connection-interface-contact-list-callback-for-download"></a><h3>tp_cli_connection_interface_contact_list_callback_for_download ()</h3>
 
2502
<pre class="programlisting"><span class="returnvalue">void</span>                (*tp_cli_connection_interface_contact_list_callback_for_download)
 
2503
                                                        (<em class="parameter"><code><a class="link" href="telepathy-glib-connection.html#TpConnection"><span class="type">TpConnection</span></a> *proxy</code></em>,
 
2504
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> *error</code></em>,
 
2505
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>,
 
2506
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a> *weak_object</code></em>);</pre>
 
2507
<p>
 
2508
Signature of the callback called when a Download method call
 
2509
succeeds or fails.
 
2510
</p>
 
2511
<div class="variablelist"><table border="0">
 
2512
<col align="left" valign="top">
 
2513
<tbody>
 
2514
<tr>
 
2515
<td><p><span class="term"><em class="parameter"><code>proxy</code></em> :</span></p></td>
 
2516
<td>the proxy on which the call was made</td>
 
2517
</tr>
 
2518
<tr>
 
2519
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
 
2520
<td>
 
2521
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> on success, or an error on failure</td>
 
2522
</tr>
 
2523
<tr>
 
2524
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
 
2525
<td>user-supplied data</td>
 
2526
</tr>
 
2527
<tr>
 
2528
<td><p><span class="term"><em class="parameter"><code>weak_object</code></em> :</span></p></td>
 
2529
<td>user-supplied object</td>
 
2530
</tr>
 
2531
</tbody>
 
2532
</table></div>
 
2533
</div>
 
2534
<hr>
 
2535
<div class="refsect2">
2423
2536
<a name="tp-cli-connection-interface-contact-list-callback-for-remove-contacts"></a><h3>tp_cli_connection_interface_contact_list_callback_for_remove_contacts ()</h3>
2424
2537
<pre class="programlisting"><span class="returnvalue">void</span>                (*tp_cli_connection_interface_contact_list_callback_for_remove_contacts)
2425
2538
                                                        (<em class="parameter"><code><a class="link" href="telepathy-glib-connection.html#TpConnection"><span class="type">TpConnection</span></a> *proxy</code></em>,