1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
|
<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html
PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title>TelepathyQt4: Tp::ProtocolInfo Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr>
<td width="1"> </td>
<td class="postheader" valign="center">
<a href="index.html">
<font color="#004faf">Home</font></a> ·
<a href="classes.html">
<font color="#004faf">All Classes</font></a> ·
<a href="namespaces.html">
<font color="#004faf">All Namespaces</font></a> ·
<a href="modules.html">
<font color="#004faf">Modules</font></a> ·
<a href="functions.html">
<font color="#004faf">Functions</font></a> ·
<a href="files.html">
<font color="#004faf">Files</font></a>
</td>
</tr>
</table>
</body>
</html>
<!-- Generated by Doxygen 1.6.3 -->
<div class="navpath"><a class="el" href="namespaceTp.html">Tp</a>::<a class="el" href="classTp_1_1ProtocolInfo.html">ProtocolInfo</a>
</div>
<div class="contents">
<h1>Tp::ProtocolInfo Class Reference<br/>
<small>
[<a class="el" href="group__clientcm.html">Connection manager proxies</a>]</small>
</h1><!-- doxytag: class="Tp::ProtocolInfo" -->
<p>Object representing a Telepathy protocol info.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="connection-manager_8h_source.html">TelepathyQt4/ConnectionManager</a>></code></p>
<p><a href="classTp_1_1ProtocolInfo-members.html">List of all members.</a></p>
<h2>Public Member Functions</h2>
<ul>
<li><a class="el" href="classTp_1_1ProtocolInfo.html#a91408a030f9229026d34c5aafda95b78">~ProtocolInfo</a> ()
<li>QString <a class="el" href="classTp_1_1ProtocolInfo.html#aad7b00d30e5715a76bd8bc9207ba9256">cmName</a> () const
<li>QString <a class="el" href="classTp_1_1ProtocolInfo.html#a19ca863d985faa451355ff02ad273c4c">name</a> () const
<li>const <a class="el" href="namespaceTp.html#ae96d226ed4aa5452a752f4f3147520a1">ProtocolParameterList</a> & <a class="el" href="classTp_1_1ProtocolInfo.html#a262586adb2c487218c9a8ffd43264fc1">parameters</a> () const
<li>bool <a class="el" href="classTp_1_1ProtocolInfo.html#a29925747aeafb70c778be86f4c5cb029">hasParameter</a> (const QString &name) const
<li>bool <a class="el" href="classTp_1_1ProtocolInfo.html#af9a83845e067e872d25caa95491c3289">canRegister</a> () const
</ul>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Object representing a Telepathy protocol info. </p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a91408a030f9229026d34c5aafda95b78"></a><!-- doxytag: member="Tp::ProtocolInfo::~ProtocolInfo" ref="a91408a030f9229026d34c5aafda95b78" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Tp::ProtocolInfo::~ProtocolInfo </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Class destructor. </p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="aad7b00d30e5715a76bd8bc9207ba9256"></a><!-- doxytag: member="Tp::ProtocolInfo::cmName" ref="aad7b00d30e5715a76bd8bc9207ba9256" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">QString Tp::ProtocolInfo::cmName </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the short name of the connection manager (e.g. "gabble").</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>The name of the connection manager. </dd></dl>
</div>
</div>
<a class="anchor" id="a19ca863d985faa451355ff02ad273c4c"></a><!-- doxytag: member="Tp::ProtocolInfo::name" ref="a19ca863d985faa451355ff02ad273c4c" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">QString Tp::ProtocolInfo::name </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the string identifying the protocol as described in the Telepathy D-Bus API Specification (e.g. "jabber").</p>
<p>This identifier is not intended to be displayed to users directly; user interfaces are responsible for mapping them to localized strings.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>A string identifying the protocol. </dd></dl>
</div>
</div>
<a class="anchor" id="a262586adb2c487218c9a8ffd43264fc1"></a><!-- doxytag: member="Tp::ProtocolInfo::parameters" ref="a262586adb2c487218c9a8ffd43264fc1" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="namespaceTp.html#ae96d226ed4aa5452a752f4f3147520a1">ProtocolParameterList</a> & Tp::ProtocolInfo::parameters </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return all supported parameters. The parameters' names may either be the well-known strings specified by the Telepathy D-Bus API Specification (e.g. "account" and "password"), or implementation-specific strings.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>A list of parameters. </dd></dl>
</div>
</div>
<a class="anchor" id="a29925747aeafb70c778be86f4c5cb029"></a><!-- doxytag: member="Tp::ProtocolInfo::hasParameter" ref="a29925747aeafb70c778be86f4c5cb029" args="(const QString &name) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Tp::ProtocolInfo::hasParameter </td>
<td>(</td>
<td class="paramtype">const QString & </td>
<td class="paramname"> <em>name</em></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return whether a given parameter can be passed to the connection manager when creating a connection to this protocol.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>The name of a parameter. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if the given parameter exists. </dd></dl>
</div>
</div>
<a class="anchor" id="af9a83845e067e872d25caa95491c3289"></a><!-- doxytag: member="Tp::ProtocolInfo::canRegister" ref="af9a83845e067e872d25caa95491c3289" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Tp::ProtocolInfo::canRegister </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return whether it might be possible to register new accounts on this protocol, by setting the special parameter named <code>register</code> to <code>true</code>.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>The same thing as hasParameter("register"). </dd></dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classTp_1_1ProtocolInfo.html#a29925747aeafb70c778be86f4c5cb029">hasParameter()</a> </dd></dl>
</div>
</div>
</div>
<p /><address><hr /><div align="center">
<table width="100%" cellspacing="0" border="0"><tr class="address">
<td width="30%">Copyright © 2008-2010 Collabora Ltd. and Nokia Corporation</td>
<td width="30%" align="right"><div align="right">Telepathy-Qt4 0.3.6</div></td>
</tr></table></div></address>
</body>
</html>
|
