1
<?xml version="1.0" encoding="iso-8859-1"?>
3
PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "DTD/xhtml1-strict.dtd">
4
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
6
<title>Tp::Client::ConnectionInterfaceClientTypesInterface Class Reference</title>
7
<link href="doxygen.css" rel="stylesheet" type="text/css" />
10
<table border="0" cellpadding="0" cellspacing="0" width="100%">
12
<td width="1"> </td>
13
<td class="postheader" valign="center">
15
<font color="#004faf">Home</font></a> ·
16
<a href="classes.html">
17
<font color="#004faf">All Classes</font></a> ·
18
<a href="namespaces.html">
19
<font color="#004faf">All Namespaces</font></a> ·
20
<a href="modules.html">
21
<font color="#004faf">Modules</font></a> ·
22
<a href="functions.html">
23
<font color="#004faf">Functions</font></a> ·
25
<font color="#004faf">Files</font></a>
29
<!-- Generated by Doxygen 1.7.6.1 -->
30
<div id="nav-path" class="navpath">
32
<li class="navelem"><a class="el" href="a00724.html">Tp</a> </li>
33
<li class="navelem"><a class="el" href="a00728.html">Client</a> </li>
34
<li class="navelem"><a class="el" href="a00172.html">ConnectionInterfaceClientTypesInterface</a> </li>
40
<a href="#pub-slots">Public Slots</a> |
41
<a href="#signals">Signals</a> |
42
<a href="#pub-methods">Public Member Functions</a> |
43
<a href="#pub-static-methods">Static Public Member Functions</a> |
44
<a href="#pro-methods">Protected Member Functions</a> </div>
45
<div class="headertitle">
46
<div class="title">Tp::Client::ConnectionInterfaceClientTypesInterface Class Reference<div class="ingroups"><a class="el" href="a00745.html">Connection proxies</a></div></div> </div>
48
<div class="contents">
49
<!-- doxytag: class="Tp::Client::ConnectionInterfaceClientTypesInterface" --><!-- doxytag: inherits="Tp::AbstractInterface" -->
50
<p><code>#include <<a class="el" href="a00508_source.html">TelepathyQt/Connection</a>></code></p>
52
<p>Inherits <a class="el" href="a00037.html">Tp::AbstractInterface</a>.</p>
54
<p><a href="a01130.html">List of all members.</a></p>
55
<h2><a name="pub-slots"></a>
58
<li>QDBusPendingReply<br class="typebreak"/>
59
< <a class="el" href="a00195.html">Tp::ContactClientTypes</a> > <a class="el" href="a00172.html#adfee9ef78f3f9f4f569c01e5dd4aef5c">GetClientTypes</a> (const <a class="el" href="a00414.html">Tp::UIntList</a> &contacts, int timeout=-1)
60
<li>QDBusPendingReply< QStringList > <a class="el" href="a00172.html#af72cd23c79c5f53e4ede75cd8bdb7f2f">RequestClientTypes</a> (uint contact, int timeout=-1)
62
<h2><a name="signals"></a>
65
<li>void <a class="el" href="a00172.html#abb34363bdafe17f4f4dbcef20b7c4eb7">ClientTypesUpdated</a> (uint contact, const QStringList &clientTypes)
67
<h2><a name="pub-methods"></a>
68
Public Member Functions</h2>
70
<li><a class="el" href="a00172.html#ac243f5452b0d159b51e0d15d242ab610">ConnectionInterfaceClientTypesInterface</a> (const QString &busName, const QString &objectPath, QObject *parent=0)
71
<li><a class="el" href="a00172.html#a53cf7e054216bae8117e4605f08e1d02">ConnectionInterfaceClientTypesInterface</a> (const QDBusConnection &connection, const QString &busName, const QString &objectPath, QObject *parent=0)
72
<li><a class="el" href="a00172.html#ac8dc73bff5ea332b8ee75a8af96a7464">ConnectionInterfaceClientTypesInterface</a> (<a class="el" href="a00216.html">Tp::DBusProxy</a> *proxy)
73
<li><a class="el" href="a00172.html#a20fdc3fecf336b3d8b20156b582b6bfd">ConnectionInterfaceClientTypesInterface</a> (const <a class="el" href="a00164.html">Tp::Client::ConnectionInterface</a> &mainInterface)
74
<li><a class="el" href="a00172.html#a0b47b8efc0dcc8e55268f684983ebe0d">ConnectionInterfaceClientTypesInterface</a> (const <a class="el" href="a00164.html">Tp::Client::ConnectionInterface</a> &mainInterface, QObject *parent)
75
<li><a class="el" href="a00330.html">Tp::PendingVariantMap</a> * <a class="el" href="a00172.html#af5c537f0eb1d37874cc0d0af917aaef4">requestAllProperties</a> () const
77
<h2><a name="pub-static-methods"></a>
78
Static Public Member Functions</h2>
80
<li>static QLatin1String <a class="el" href="a00172.html#af22964dc6eb45c5166122f84718bf1fc">staticInterfaceName</a> ()
82
<h2><a name="pro-methods"></a>
83
Protected Member Functions</h2>
85
<li>virtual void <a class="el" href="a00172.html#ae78ace26fb1a50fbded487fbf9c1a5f5">invalidate</a> (<a class="el" href="a00216.html">Tp::DBusProxy</a> *, const QString &, const QString &)
87
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
88
<div class="textblock"><p>Proxy class providing a 1:1 mapping of the D-Bus interface "org.freedesktop.Telepathy.Connection.Interface.ClientTypes". </p>
89
</div><hr/><h2>Constructor & Destructor Documentation</h2>
90
<a class="anchor" id="ac243f5452b0d159b51e0d15d242ab610"></a><!-- doxytag: member="Tp::Client::ConnectionInterfaceClientTypesInterface::ConnectionInterfaceClientTypesInterface" ref="ac243f5452b0d159b51e0d15d242ab610" args="(const QString &busName, const QString &objectPath, QObject *parent=0)" -->
92
<div class="memproto">
93
<table class="memname">
95
<td class="memname"><a class="el" href="a00172.html#ac243f5452b0d159b51e0d15d242ab610">Tp::Client::ConnectionInterfaceClientTypesInterface::ConnectionInterfaceClientTypesInterface</a> </td>
97
<td class="paramtype">const QString & </td>
98
<td class="paramname"><em>busName</em>, </td>
101
<td class="paramkey"></td>
103
<td class="paramtype">const QString & </td>
104
<td class="paramname"><em>objectPath</em>, </td>
107
<td class="paramkey"></td>
109
<td class="paramtype">QObject * </td>
110
<td class="paramname"><em>parent</em> = <code>0</code> </td>
120
<p>Creates a <a class="el" href="a00172.html">ConnectionInterfaceClientTypesInterface</a> associated with the given object on the session bus.</p>
121
<dl class="params"><dt><b>Parameters:</b></dt><dd>
122
<table class="params">
123
<tr><td class="paramname">busName</td><td>Name of the service the object is on. </td></tr>
124
<tr><td class="paramname">objectPath</td><td>Path to the object on the service. </td></tr>
125
<tr><td class="paramname">parent</td><td>Passed to the parent class constructor. </td></tr>
132
<a class="anchor" id="a53cf7e054216bae8117e4605f08e1d02"></a><!-- doxytag: member="Tp::Client::ConnectionInterfaceClientTypesInterface::ConnectionInterfaceClientTypesInterface" ref="a53cf7e054216bae8117e4605f08e1d02" args="(const QDBusConnection &connection, const QString &busName, const QString &objectPath, QObject *parent=0)" -->
133
<div class="memitem">
134
<div class="memproto">
135
<table class="memname">
137
<td class="memname"><a class="el" href="a00172.html#ac243f5452b0d159b51e0d15d242ab610">Tp::Client::ConnectionInterfaceClientTypesInterface::ConnectionInterfaceClientTypesInterface</a> </td>
139
<td class="paramtype">const QDBusConnection & </td>
140
<td class="paramname"><em>connection</em>, </td>
143
<td class="paramkey"></td>
145
<td class="paramtype">const QString & </td>
146
<td class="paramname"><em>busName</em>, </td>
149
<td class="paramkey"></td>
151
<td class="paramtype">const QString & </td>
152
<td class="paramname"><em>objectPath</em>, </td>
155
<td class="paramkey"></td>
157
<td class="paramtype">QObject * </td>
158
<td class="paramname"><em>parent</em> = <code>0</code> </td>
168
<p>Creates a <a class="el" href="a00172.html">ConnectionInterfaceClientTypesInterface</a> associated with the given object on the given bus.</p>
169
<dl class="params"><dt><b>Parameters:</b></dt><dd>
170
<table class="params">
171
<tr><td class="paramname">connection</td><td>The bus via which the object can be reached. </td></tr>
172
<tr><td class="paramname">busName</td><td>Name of the service the object is on. </td></tr>
173
<tr><td class="paramname">objectPath</td><td>Path to the object on the service. </td></tr>
174
<tr><td class="paramname">parent</td><td>Passed to the parent class constructor. </td></tr>
181
<a class="anchor" id="ac8dc73bff5ea332b8ee75a8af96a7464"></a><!-- doxytag: member="Tp::Client::ConnectionInterfaceClientTypesInterface::ConnectionInterfaceClientTypesInterface" ref="ac8dc73bff5ea332b8ee75a8af96a7464" args="(Tp::DBusProxy *proxy)" -->
182
<div class="memitem">
183
<div class="memproto">
184
<table class="memname">
186
<td class="memname"><a class="el" href="a00172.html#ac243f5452b0d159b51e0d15d242ab610">Tp::Client::ConnectionInterfaceClientTypesInterface::ConnectionInterfaceClientTypesInterface</a> </td>
188
<td class="paramtype"><a class="el" href="a00216.html">Tp::DBusProxy</a> * </td>
189
<td class="paramname"><em>proxy</em></td><td>)</td>
195
<p>Creates a <a class="el" href="a00172.html">ConnectionInterfaceClientTypesInterface</a> associated with the same object as the given proxy.</p>
196
<dl class="params"><dt><b>Parameters:</b></dt><dd>
197
<table class="params">
198
<tr><td class="paramname">proxy</td><td>The proxy to use. It will also be the QObject::parent() for this object. </td></tr>
205
<a class="anchor" id="a20fdc3fecf336b3d8b20156b582b6bfd"></a><!-- doxytag: member="Tp::Client::ConnectionInterfaceClientTypesInterface::ConnectionInterfaceClientTypesInterface" ref="a20fdc3fecf336b3d8b20156b582b6bfd" args="(const Tp::Client::ConnectionInterface &mainInterface)" -->
206
<div class="memitem">
207
<div class="memproto">
208
<table class="memname">
210
<td class="memname"><a class="el" href="a00172.html#ac243f5452b0d159b51e0d15d242ab610">Tp::Client::ConnectionInterfaceClientTypesInterface::ConnectionInterfaceClientTypesInterface</a> </td>
212
<td class="paramtype">const <a class="el" href="a00164.html">Tp::Client::ConnectionInterface</a> & </td>
213
<td class="paramname"><em>mainInterface</em></td><td>)</td>
214
<td><code> [explicit]</code></td>
219
<p>Creates a <a class="el" href="a00172.html">ConnectionInterfaceClientTypesInterface</a> associated with the same object as the given proxy. Additionally, the created proxy will have the same parent as the given proxy.</p>
220
<dl class="params"><dt><b>Parameters:</b></dt><dd>
221
<table class="params">
222
<tr><td class="paramname">mainInterface</td><td>The proxy to use. </td></tr>
229
<a class="anchor" id="a0b47b8efc0dcc8e55268f684983ebe0d"></a><!-- doxytag: member="Tp::Client::ConnectionInterfaceClientTypesInterface::ConnectionInterfaceClientTypesInterface" ref="a0b47b8efc0dcc8e55268f684983ebe0d" args="(const Tp::Client::ConnectionInterface &mainInterface, QObject *parent)" -->
230
<div class="memitem">
231
<div class="memproto">
232
<table class="memname">
234
<td class="memname"><a class="el" href="a00172.html#ac243f5452b0d159b51e0d15d242ab610">Tp::Client::ConnectionInterfaceClientTypesInterface::ConnectionInterfaceClientTypesInterface</a> </td>
236
<td class="paramtype">const <a class="el" href="a00164.html">Tp::Client::ConnectionInterface</a> & </td>
237
<td class="paramname"><em>mainInterface</em>, </td>
240
<td class="paramkey"></td>
242
<td class="paramtype">QObject * </td>
243
<td class="paramname"><em>parent</em> </td>
253
<p>Creates a <a class="el" href="a00172.html">ConnectionInterfaceClientTypesInterface</a> associated with the same object as the given proxy. However, a different parent object can be specified.</p>
254
<dl class="params"><dt><b>Parameters:</b></dt><dd>
255
<table class="params">
256
<tr><td class="paramname">mainInterface</td><td>The proxy to use. </td></tr>
257
<tr><td class="paramname">parent</td><td>Passed to the parent class constructor. </td></tr>
264
<hr/><h2>Member Function Documentation</h2>
265
<a class="anchor" id="af22964dc6eb45c5166122f84718bf1fc"></a><!-- doxytag: member="Tp::Client::ConnectionInterfaceClientTypesInterface::staticInterfaceName" ref="af22964dc6eb45c5166122f84718bf1fc" args="()" -->
266
<div class="memitem">
267
<div class="memproto">
268
<table class="memname">
270
<td class="memname">static QLatin1String <a class="el" href="a00172.html#af22964dc6eb45c5166122f84718bf1fc">Tp::Client::ConnectionInterfaceClientTypesInterface::staticInterfaceName</a> </td>
272
<td class="paramname"></td><td>)</td>
273
<td><code> [inline, static]</code></td>
278
<p>Returns the name of the interface "org.freedesktop.Telepathy.Connection.Interface.ClientTypes", which this class represents.</p>
279
<dl class="return"><dt><b>Returns:</b></dt><dd>The D-Bus interface name. </dd></dl>
283
<a class="anchor" id="af5c537f0eb1d37874cc0d0af917aaef4"></a><!-- doxytag: member="Tp::Client::ConnectionInterfaceClientTypesInterface::requestAllProperties" ref="af5c537f0eb1d37874cc0d0af917aaef4" args="() const " -->
284
<div class="memitem">
285
<div class="memproto">
286
<table class="memname">
288
<td class="memname"><a class="el" href="a00330.html">Tp::PendingVariantMap</a>* <a class="el" href="a00172.html#af5c537f0eb1d37874cc0d0af917aaef4">Tp::Client::ConnectionInterfaceClientTypesInterface::requestAllProperties</a> </td>
290
<td class="paramname"></td><td>)</td>
291
<td> const<code> [inline]</code></td>
296
<p>Request all of the <a class="el" href="a00729.html">DBus</a> properties on the interface.</p>
297
<dl class="return"><dt><b>Returns:</b></dt><dd>A pending variant map which will emit finished when the properties have been retrieved. </dd></dl>
301
<a class="anchor" id="adfee9ef78f3f9f4f569c01e5dd4aef5c"></a><!-- doxytag: member="Tp::Client::ConnectionInterfaceClientTypesInterface::GetClientTypes" ref="adfee9ef78f3f9f4f569c01e5dd4aef5c" args="(const Tp::UIntList &contacts, int timeout=-1)" -->
302
<div class="memitem">
303
<div class="memproto">
304
<table class="memname">
306
<td class="memname">QDBusPendingReply<<a class="el" href="a00195.html">Tp::ContactClientTypes</a>> <a class="el" href="a00172.html#adfee9ef78f3f9f4f569c01e5dd4aef5c">Tp::Client::ConnectionInterfaceClientTypesInterface::GetClientTypes</a> </td>
308
<td class="paramtype">const <a class="el" href="a00414.html">Tp::UIntList</a> & </td>
309
<td class="paramname"><em>contacts</em>, </td>
312
<td class="paramkey"></td>
314
<td class="paramtype">int </td>
315
<td class="paramname"><em>timeout</em> = <code>-1</code> </td>
320
<td></td><td><code> [inline, slot]</code></td>
325
<p>Begins a call to the D-Bus method <code>GetClientTypes</code> on the remote object.</p>
326
<p>Return the client types of the given contacts, if they are already known. If any of the given contacts' client types are not known, request their current client types, but return immediately without waiting for a reply; if a reply with a non-empty client type array is later received for those contacts, the ClientTypesUpdated signal will be emitted for them. This method is appropriate for "lazy" client type finding, for instance displaying the client types (if available) of everyone in your contact list.</p>
327
<p>Note that <em>timeout</em> is ignored as of now. It will be used once <a href="http://bugreports.qt.nokia.com/browse/QTBUG-11775">http://bugreports.qt.nokia.com/browse/QTBUG-11775</a> is fixed.</p>
328
<dl class="params"><dt><b>Parameters:</b></dt><dd>
329
<table class="params">
330
<tr><td class="paramname">contacts</td><td>The contacts whose client types should be returned or signalled. </td></tr>
331
<tr><td class="paramname">timeout</td><td>The timeout in milliseconds.</td></tr>
335
<dl class="return"><dt><b>Returns:</b></dt><dd></dd></dl>
336
<p>The contacts' client types, if already known. Contacts whose client types are not already known are omitted from the mapping; contacts known to have no client type information appear in the mapping with an empty list. </p>
340
<a class="anchor" id="af72cd23c79c5f53e4ede75cd8bdb7f2f"></a><!-- doxytag: member="Tp::Client::ConnectionInterfaceClientTypesInterface::RequestClientTypes" ref="af72cd23c79c5f53e4ede75cd8bdb7f2f" args="(uint contact, int timeout=-1)" -->
341
<div class="memitem">
342
<div class="memproto">
343
<table class="memname">
345
<td class="memname">QDBusPendingReply<QStringList> <a class="el" href="a00172.html#af72cd23c79c5f53e4ede75cd8bdb7f2f">Tp::Client::ConnectionInterfaceClientTypesInterface::RequestClientTypes</a> </td>
347
<td class="paramtype">uint </td>
348
<td class="paramname"><em>contact</em>, </td>
351
<td class="paramkey"></td>
353
<td class="paramtype">int </td>
354
<td class="paramname"><em>timeout</em> = <code>-1</code> </td>
359
<td></td><td><code> [inline, slot]</code></td>
364
<p>Begins a call to the D-Bus method <code>RequestClientTypes</code> on the remote object.</p>
365
<p>Return the current client types of the given contact. If necessary, make a request to the server for up-to-date information, and wait for a reply. This method is appropriate for use in a "<a class="el" href="a00190.html" title="The Contact class represents a Telepathy contact.">Contact</a> Information..." dialog; it can be used to show progress information (while waiting for the method to return), and can distinguish between various error conditions.</p>
366
<p>Note that <em>timeout</em> is ignored as of now. It will be used once <a href="http://bugreports.qt.nokia.com/browse/QTBUG-11775">http://bugreports.qt.nokia.com/browse/QTBUG-11775</a> is fixed.</p>
367
<dl class="params"><dt><b>Parameters:</b></dt><dd>
368
<table class="params">
369
<tr><td class="paramname">contact</td><td>The contact whose client types should be returned. </td></tr>
370
<tr><td class="paramname">timeout</td><td>The timeout in milliseconds.</td></tr>
374
<dl class="return"><dt><b>Returns:</b></dt><dd></dd></dl>
375
<p>The contact's client types. It MAY be empty, indicating that no client type information was found. </p>
379
<a class="anchor" id="abb34363bdafe17f4f4dbcef20b7c4eb7"></a><!-- doxytag: member="Tp::Client::ConnectionInterfaceClientTypesInterface::ClientTypesUpdated" ref="abb34363bdafe17f4f4dbcef20b7c4eb7" args="(uint contact, const QStringList &clientTypes)" -->
380
<div class="memitem">
381
<div class="memproto">
382
<table class="memname">
384
<td class="memname">void <a class="el" href="a00172.html#abb34363bdafe17f4f4dbcef20b7c4eb7">Tp::Client::ConnectionInterfaceClientTypesInterface::ClientTypesUpdated</a> </td>
386
<td class="paramtype">uint </td>
387
<td class="paramname"><em>contact</em>, </td>
390
<td class="paramkey"></td>
392
<td class="paramtype">const QStringList & </td>
393
<td class="paramname"><em>clientTypes</em> </td>
398
<td></td><td><code> [signal]</code></td>
403
<p>Represents the signal <code>ClientTypesUpdated</code> on the remote object.</p>
404
<p>Emitted when a contact's client types change or become known.</p>
405
<dl class="params"><dt><b>Parameters:</b></dt><dd>
406
<table class="params">
407
<tr><td class="paramname">contact</td><td>The contact.</td></tr>
408
<tr><td class="paramname">clientTypes</td><td>The contact's client types, or an empty list to indicate that nothing is known about the contact's client types. </td></tr>
415
<a class="anchor" id="ae78ace26fb1a50fbded487fbf9c1a5f5"></a><!-- doxytag: member="Tp::Client::ConnectionInterfaceClientTypesInterface::invalidate" ref="ae78ace26fb1a50fbded487fbf9c1a5f5" args="(Tp::DBusProxy *, const QString &, const QString &)" -->
416
<div class="memitem">
417
<div class="memproto">
418
<table class="memname">
420
<td class="memname">void <a class="el" href="a00172.html#ae78ace26fb1a50fbded487fbf9c1a5f5">Tp::Client::ConnectionInterfaceClientTypesInterface::invalidate</a> </td>
422
<td class="paramtype"><a class="el" href="a00216.html">Tp::DBusProxy</a> * </td>
423
<td class="paramname"><em>proxy</em>, </td>
426
<td class="paramkey"></td>
428
<td class="paramtype">const QString & </td>
429
<td class="paramname"><em>error</em>, </td>
432
<td class="paramkey"></td>
434
<td class="paramtype">const QString & </td>
435
<td class="paramname"><em>message</em> </td>
440
<td></td><td><code> [protected, virtual]</code></td>
446
<p>Reimplemented from <a class="el" href="a00037.html#a79dde56ba44455f47c7c354ada07467a">Tp::AbstractInterface</a>.</p>
450
</div><!-- contents -->
451
<p /><address><hr /><div align="center">
452
<table width="100%" cellspacing="0" border="0"><tr class="address">
453
<td width="30%">Copyright © 2008-2011 Collabora Ltd. and Nokia Corporation</td>
454
<td width="30%" align="right"><div align="right">Telepathy-Qt 0.9.3</div></td>
455
</tr></table></div></address>