← Back to branch summary

~ubuntu-branches/ubuntu/maverick/telepathy-glib/maverick

« back to all changes in this revision

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

  • Committer: Bazaar Package Importer
  • Author(s): Simon McVittie
  • Date: 2010-05-25 16:57:39 UTC
  • mfrom: (1.6.2 upstream) (30.1.1 experimental)
  • Revision ID: james.westby@ubuntu.com-20100525165739-kted5mhm904f8lwj
Tags: 0.11.6-1
* New upstream version
  - requires gtk-doc 1.15
  - requires gobject-introspection 0.6.11
  - new ABI, API
* Merge from experimental
  - add gir1.0-telepathyglib-0.12 binary package

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/html/telepathy-glib-connection.html
8
8
<link rel="up" href="ch-client.html" title="Client-side proxies">
9
9
<link rel="prev" href="telepathy-glib-connection-manager.html" title="TpConnectionManager">
10
10
<link rel="next" href="telepathy-glib-contact.html" title="TpContact">
11
 
<meta name="generator" content="GTK-Doc V1.14 (XML mode)">
 
11
<meta name="generator" content="GTK-Doc V1.15 (XML mode)">
12
12
<link rel="stylesheet" href="style.css" type="text/css">
13
13
</head>
14
14
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
504
504
<tr>
505
505
<td><p><span class="term"><em class="parameter"><code>names</code></em> :</span></p></td>
506
506
<td> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>-terminated array of <em class="parameter"><code>n</code></em>
507
 
 connection bus names, or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> on error. <acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> zero-terminated=1. </td>
 
507
 connection bus names, or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> on error. <span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> zero-terminated=1]</span>
 
508
</td>
508
509
</tr>
509
510
<tr>
510
511
<td><p><span class="term"><em class="parameter"><code>n</code></em> :</span></p></td>
515
516
<td><p><span class="term"><em class="parameter"><code>cms</code></em> :</span></p></td>
516
517
<td> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>-terminated array of <em class="parameter"><code>n</code></em>
517
518
 connection manager names (e.g. "gabble") in the same order as <em class="parameter"><code>names</code></em>, or
518
 
 <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> on error. <acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> zero-terminated=1. </td>
 
519
 <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> on error. <span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> zero-terminated=1]</span>
 
520
</td>
519
521
</tr>
520
522
<tr>
521
523
<td><p><span class="term"><em class="parameter"><code>protocols</code></em> :</span></p></td>
522
524
<td> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>-terminated array of
523
525
 <em class="parameter"><code>n</code></em> protocol names as defined in the Telepathy spec (e.g. "jabber") in the
524
 
 same order as <em class="parameter"><code>names</code></em>, or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> on error. <acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> zero-terminated=1. </td>
 
526
 same order as <em class="parameter"><code>names</code></em>, or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> on error. <span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> zero-terminated=1]</span>
 
527
</td>
525
528
</tr>
526
529
<tr>
527
530
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
590
593
<tr>
591
594
<td><p><span class="term"><em class="parameter"><code>weak_object</code></em> :</span></p></td>
592
595
<td> if not <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, will be weakly referenced; the callback will
593
 
  not be called if the object has vanished. <acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>. </td>
 
596
  not be called if the object has vanished. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
 
597
</td>
594
598
</tr>
595
599
</tbody>
596
600
</table></div>
658
662
<td> the well-known or unique name of the connection
659
663
 process; if well-known, this function will make a blocking call to the bus
660
664
 daemon to resolve the unique name. May be <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if <em class="parameter"><code>object_path</code></em> is not, in
661
 
 which case a well-known name will be derived from <em class="parameter"><code>object_path</code></em>.. <acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>. </td>
 
665
 which case a well-known name will be derived from <em class="parameter"><code>object_path</code></em>. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
 
666
</td>
662
667
</tr>
663
668
<tr>
664
669
<td><p><span class="term"><em class="parameter"><code>object_path</code></em> :</span></p></td>
665
670
<td> the object path of the connection process.
666
671
 May be <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if <em class="parameter"><code>bus_name</code></em> is a well-known name, in which case the object
667
 
 path will be derived from <em class="parameter"><code>bus_name</code></em>.. <acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>. </td>
 
672
 path will be derived from <em class="parameter"><code>bus_name</code></em>. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
 
673
</td>
668
674
</tr>
669
675
<tr>
670
676
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
992
998
</tr>
993
999
<tr>
994
1000
<td><p><span class="term"><em class="parameter"><code>reason</code></em> :</span></p></td>
995
 
<td> a TpConnectionStatusReason, or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. <acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>. </td>
 
1001
<td> a TpConnectionStatusReason, or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span>
 
1002
</td>
996
1003
</tr>
997
1004
<tr>
998
1005
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1087
1094
</tr>
1088
1095
<tr>
1089
1096
<td><p><span class="term"><em class="parameter"><code>handles</code></em> :</span></p></td>
1090
 
<td> the <em class="parameter"><code>n_handles</code></em> handles corresponding to
1091
 
 <em class="parameter"><code>ids</code></em>, in the same order, or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> on failure. <acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> length=n_handles. </td>
 
1097
<td> the <em class="parameter"><code>n_handles</code></em>
 
1098
 handles corresponding to <em class="parameter"><code>ids</code></em>, in the same order, or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> on failure. <span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> uint][<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> length=n_handles]</span>
 
1099
</td>
1092
1100
</tr>
1093
1101
<tr>
1094
1102
<td><p><span class="term"><em class="parameter"><code>ids</code></em> :</span></p></td>
1158
1166
<tr>
1159
1167
<td><p><span class="term"><em class="parameter"><code>ids</code></em> :</span></p></td>
1160
1168
<td> an array of string identifiers for which
1161
 
 handles are required, terminated by <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> (must not be <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> or empty). <acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> zero-terminated=1. </td>
 
1169
 handles are required, terminated by <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> (must not be <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> or empty). <span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> zero-terminated=1]</span>
 
1170
</td>
1162
1171
</tr>
1163
1172
<tr>
1164
1173
<td><p><span class="term"><em class="parameter"><code>callback</code></em> :</span></p></td>
1316
1325
</tr>
1317
1326
<tr>
1318
1327
<td><p><span class="term"><em class="parameter"><code>handles</code></em> :</span></p></td>
1319
 
<td> an array of handles. <acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> length=n_handles. </td>
 
1328
<td> an array of handles. <span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> length=n_handles]</span>
 
1329
</td>
1320
1330
</tr>
1321
1331
<tr>
1322
1332
<td><p><span class="term"><em class="parameter"><code>interfaces</code></em> :</span></p></td>
1331
1341
<tr>
1332
1342
<td><p><span class="term"><em class="parameter"><code>callback</code></em> :</span></p></td>
1333
1343
<td> called on success or
1334
 
 failure (unless <em class="parameter"><code>weak_object</code></em> has become unreferenced). type GObject.Callback</td>
 
1344
 failure (unless <em class="parameter"><code>weak_object</code></em> has become unreferenced). <span class="annotation">[type GObject.Callback]</span>
 
1345
</td>
1335
1346
</tr>
1336
1347
<tr>
1337
1348
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
1405
1416
</tr>
1406
1417
<tr>
1407
1418
<td><p><span class="term"><em class="parameter"><code>handles</code></em> :</span></p></td>
1408
 
<td> an array of handles. <acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> length=n_handles. </td>
 
1419
<td> an array of handles. <span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> length=n_handles]</span>
 
1420
</td>
1409
1421
</tr>
1410
1422
<tr>
1411
1423
<td><p><span class="term"><em class="parameter"><code>callback</code></em> :</span></p></td>
1480
1492
</tr>
1481
1493
<tr>
1482
1494
<td><p><span class="term"><em class="parameter"><code>handles</code></em> :</span></p></td>
1483
 
<td> an array of <em class="parameter"><code>n_handles</code></em> handles. <acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> length=n_handles. </td>
 
1495
<td> an array of <em class="parameter"><code>n_handles</code></em> handles. <span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> length=n_handles]</span>
 
1496
</td>
1484
1497
</tr>
1485
1498
</tbody>
1486
1499
</table></div>
1558
1571
<tr>
1559
1572
<td><p><span class="term"><em class="parameter"><code>protocol</code></em> :</span></p></td>
1560
1573
<td> If not NULL, used to return the protocol
1561
 
 of the connection. <acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>. <acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>. </td>
 
1574
 of the connection. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
 
1575
</td>
1562
1576
</tr>
1563
1577
<tr>
1564
1578
<td><p><span class="term"><em class="parameter"><code>cm_name</code></em> :</span></p></td>
1565
1579
<td> If not NULL, used to return the connection
1566
 
 manager name of the connection. <acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>. <acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>. </td>
 
1580
 manager name of the connection. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
 
1581
</td>
1567
1582
</tr>
1568
1583
<tr>
1569
1584
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1624
1639
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1625
1640
<td> a <a class="link" href="telepathy-glib-connection.html#TpAvatarRequirements" title="TpAvatarRequirements"><span class="type">TpAvatarRequirements</span></a> struct, or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if the
1626
1641
 feature is not yet prepared or the connection doesn't have the necessary
1627
 
 properties.. <acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>. </td>
 
1642
 properties. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
 
1643
</td>
1628
1644
</tr>
1629
1645
</tbody>
1630
1646
</table></div>
1685
1701
<td><p><span class="term"><em class="parameter"><code>details</code></em> :</span></p></td>
1686
1702
<td>
1687
1703
 optionally used to return a map from string to <a href="/usr/share/gtk-doc/html/gobject/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a>, which must not be
1688
 
 modified or destroyed by the caller. <acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>. <acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>. <acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> utf8 GObject.Value. <acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym> utf8 GObject.Value. </td>
 
1704
 modified or destroyed by the caller. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>][<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> utf8 GObject.Value][<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym> utf8 GObject.Value]</span>
 
1705
</td>
1689
1706
</tr>
1690
1707
<tr>
1691
1708
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1692
 
<td> a D-Bus error name, or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.
1693
 
. <acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>. <acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>. </td>
 
1709
<td> a D-Bus error name, or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>][<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
 
1710
</td>
1694
1711
</tr>
1695
1712
</tbody>
1696
1713
</table></div>
4688
4705
</div>
4689
4706
<div class="footer">
4690
4707
<hr>
4691
 
          Generated by GTK-Doc V1.14</div>
 
4708
          Generated by GTK-Doc V1.15</div>
4692
4709
</body>
4693
4710
</html>
 
 
b'\\ No newline at end of file'