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

« back to all changes in this revision

Viewing changes to docs/reference/html/telepathy-glib-connection.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:
47
47
#include <telepathy-glib/telepathy-glib.h>
48
48
 
49
49
<span class="returnvalue">void</span>                (<a class="link" href="telepathy-glib-connection.html#TpConnectionNameListCb" title="TpConnectionNameListCb ()">*TpConnectionNameListCb</a>)           (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> * const *names</code></em>,
50
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gsize"><span class="type">gsize</span></a> n</code></em>,
 
50
                                                         <em class="parameter"><code><span class="type">gsize</span> n</code></em>,
51
51
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> * const *cms</code></em>,
52
52
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> * const *protocols</code></em>,
53
53
                                                         <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>,
86
86
                                                         <em class="parameter"><code><a class="link" href="telepathy-glib-connection.html#TpConnectionWhenReadyCb" title="TpConnectionWhenReadyCb ()"><span class="type">TpConnectionWhenReadyCb</span></a> callback</code></em>,
87
87
                                                         <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>);
88
88
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="telepathy-glib-connection.html#tp-connection-is-ready" title="tp_connection_is_ready ()">tp_connection_is_ready</a>              (<em class="parameter"><code><a class="link" href="telepathy-glib-connection.html#TpConnection"><span class="type">TpConnection</span></a> *self</code></em>);
 
89
<span class="returnvalue">void</span>                <a class="link" href="telepathy-glib-connection.html#tp-connection-disconnect-async" title="tp_connection_disconnect_async ()">tp_connection_disconnect_async</a>      (<em class="parameter"><code><a class="link" href="telepathy-glib-connection.html#TpConnection"><span class="type">TpConnection</span></a> *self</code></em>,
 
90
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/gio/unstable/GAsyncResult.html#GAsyncReadyCallback"><span class="type">GAsyncReadyCallback</span></a> callback</code></em>,
 
91
                                                         <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>);
 
92
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="telepathy-glib-connection.html#tp-connection-disconnect-finish" title="tp_connection_disconnect_finish ()">tp_connection_disconnect_finish</a>     (<em class="parameter"><code><a class="link" href="telepathy-glib-connection.html#TpConnection"><span class="type">TpConnection</span></a> *self</code></em>,
 
93
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/gio/unstable/GAsyncResult.html"><span class="type">GAsyncResult</span></a> *result</code></em>,
 
94
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
89
95
<a class="link" href="telepathy-glib-account.html#TpAccount"><span class="returnvalue">TpAccount</span></a> *         <a class="link" href="telepathy-glib-connection.html#tp-connection-get-account" title="tp_connection_get_account ()">tp_connection_get_account</a>           (<em class="parameter"><code><a class="link" href="telepathy-glib-connection.html#TpConnection"><span class="type">TpConnection</span></a> *self</code></em>);
90
96
<a class="link" href="telepathy-glib-enums.html#TpConnectionStatus" title="enum TpConnectionStatus"><span class="returnvalue">TpConnectionStatus</span></a>  <a class="link" href="telepathy-glib-connection.html#tp-connection-get-status" title="tp_connection_get_status ()">tp_connection_get_status</a>            (<em class="parameter"><code><a class="link" href="telepathy-glib-connection.html#TpConnection"><span class="type">TpConnection</span></a> *self</code></em>,
91
97
                                                         <em class="parameter"><code><a class="link" href="telepathy-glib-enums.html#TpConnectionStatusReason" title="enum TpConnectionStatusReason"><span class="type">TpConnectionStatusReason</span></a> *reason</code></em>);
756
762
<div class="refsect2">
757
763
<a name="TpConnectionNameListCb"></a><h3>TpConnectionNameListCb ()</h3>
758
764
<pre class="programlisting"><span class="returnvalue">void</span>                (*TpConnectionNameListCb)           (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> * const *names</code></em>,
759
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gsize"><span class="type">gsize</span></a> n</code></em>,
 
765
                                                         <em class="parameter"><code><span class="type">gsize</span> n</code></em>,
760
766
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> * const *cms</code></em>,
761
767
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> * const *protocols</code></em>,
762
768
                                                         <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>,
1382
1388
</div>
1383
1389
<hr>
1384
1390
<div class="refsect2">
 
1391
<a name="tp-connection-disconnect-async"></a><h3>tp_connection_disconnect_async ()</h3>
 
1392
<pre class="programlisting"><span class="returnvalue">void</span>                tp_connection_disconnect_async      (<em class="parameter"><code><a class="link" href="telepathy-glib-connection.html#TpConnection"><span class="type">TpConnection</span></a> *self</code></em>,
 
1393
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/gio/unstable/GAsyncResult.html#GAsyncReadyCallback"><span class="type">GAsyncReadyCallback</span></a> callback</code></em>,
 
1394
                                                         <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>);</pre>
 
1395
<p>
 
1396
Disconnect the connection.
 
1397
</p>
 
1398
<p>
 
1399
This method is intended for use by AccountManager implementations,
 
1400
such as Mission Control. To disconnect a connection managed by an
 
1401
AccountManager, either use <a class="link" href="telepathy-glib-account.html#tp-account-request-presence-async" title="tp_account_request_presence_async ()"><code class="function">tp_account_request_presence_async()</code></a>
 
1402
or <a class="link" href="telepathy-glib-account.html#tp-account-set-enabled-async" title="tp_account_set_enabled_async ()"><code class="function">tp_account_set_enabled_async()</code></a>, depending whether the intention is
 
1403
to put the account offline temporarily, or disable it longer-term.
 
1404
</p>
 
1405
<div class="variablelist"><table border="0">
 
1406
<col align="left" valign="top">
 
1407
<tbody>
 
1408
<tr>
 
1409
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
 
1410
<td>a <a class="link" href="telepathy-glib-connection.html#TpConnection"><span class="type">TpConnection</span></a>
 
1411
</td>
 
1412
</tr>
 
1413
<tr>
 
1414
<td><p><span class="term"><em class="parameter"><code>callback</code></em> :</span></p></td>
 
1415
<td>a callback to call when the request is satisfied</td>
 
1416
</tr>
 
1417
<tr>
 
1418
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
 
1419
<td>data to pass to <em class="parameter"><code>callback</code></em>
 
1420
</td>
 
1421
</tr>
 
1422
</tbody>
 
1423
</table></div>
 
1424
<p class="since">Since 0.17.5</p>
 
1425
</div>
 
1426
<hr>
 
1427
<div class="refsect2">
 
1428
<a name="tp-connection-disconnect-finish"></a><h3>tp_connection_disconnect_finish ()</h3>
 
1429
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            tp_connection_disconnect_finish     (<em class="parameter"><code><a class="link" href="telepathy-glib-connection.html#TpConnection"><span class="type">TpConnection</span></a> *self</code></em>,
 
1430
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/gio/unstable/GAsyncResult.html"><span class="type">GAsyncResult</span></a> *result</code></em>,
 
1431
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
 
1432
<p>
 
1433
Interpret the result of <a class="link" href="telepathy-glib-connection.html#tp-connection-disconnect-async" title="tp_connection_disconnect_async ()"><code class="function">tp_connection_disconnect_async()</code></a>.
 
1434
</p>
 
1435
<div class="variablelist"><table border="0">
 
1436
<col align="left" valign="top">
 
1437
<tbody>
 
1438
<tr>
 
1439
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
 
1440
<td>a <a class="link" href="telepathy-glib-connection.html#TpConnection"><span class="type">TpConnection</span></a>
 
1441
</td>
 
1442
</tr>
 
1443
<tr>
 
1444
<td><p><span class="term"><em class="parameter"><code>result</code></em> :</span></p></td>
 
1445
<td>a <a href="http://library.gnome.org/devel/gio/unstable/GAsyncResult.html"><span class="type">GAsyncResult</span></a>
 
1446
</td>
 
1447
</tr>
 
1448
<tr>
 
1449
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
 
1450
<td>a <a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> to fill</td>
 
1451
</tr>
 
1452
<tr>
 
1453
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
1454
<td>
 
1455
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the call was successful, otherwise <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>
 
1456
</td>
 
1457
</tr>
 
1458
</tbody>
 
1459
</table></div>
 
1460
<p class="since">Since 0.17.5</p>
 
1461
</div>
 
1462
<hr>
 
1463
<div class="refsect2">
1385
1464
<a name="tp-connection-get-account"></a><h3>tp_connection_get_account ()</h3>
1386
1465
<pre class="programlisting"><a class="link" href="telepathy-glib-account.html#TpAccount"><span class="returnvalue">TpAccount</span></a> *         tp_connection_get_account           (<em class="parameter"><code><a class="link" href="telepathy-glib-connection.html#TpConnection"><span class="type">TpConnection</span></a> *self</code></em>);</pre>
1387
1466
<p>