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
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>TpBasePasswordChannel</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="telepathy-glib API Reference Manual">
<link rel="up" href="ch-service-base.html" title="Service-side implementation">
<link rel="prev" href="TpCMMessage.html" title="TpCMMessage">
<link rel="next" href="telepathy-glib-simple-password-manager.html" title="TpSimplePasswordManager">
<meta name="generator" content="GTK-Doc V1.19 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="TpCMMessage.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch-service-base.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">telepathy-glib API Reference Manual</th>
<td><a accesskey="n" href="telepathy-glib-simple-password-manager.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#telepathy-glib-base-password-channel.synopsis" class="shortcut">Top</a>
|
<a href="#telepathy-glib-base-password-channel.description" class="shortcut">Description</a>
|
<a href="#telepathy-glib-base-password-channel.object-hierarchy" class="shortcut">Object Hierarchy</a>
|
<a href="#telepathy-glib-base-password-channel.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
|
<a href="#telepathy-glib-base-password-channel.properties" class="shortcut">Properties</a>
|
<a href="#telepathy-glib-base-password-channel.signals" class="shortcut">Signals</a>
</td></tr>
</table>
<div class="refentry">
<a name="telepathy-glib-base-password-channel"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="telepathy-glib-base-password-channel.top_of_page"></a>TpBasePasswordChannel</span></h2>
<p>TpBasePasswordChannel — a simple X-TELEPATHY-PASSWORD channel</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="telepathy-glib-base-password-channel.synopsis"></a><h2>Synopsis</h2>
<a name="TpBasePasswordChannel"></a><pre class="synopsis">
#include <telepathy-glib/telepathy-glib.h>
<a class="link" href="telepathy-glib-base-password-channel.html#TpBasePasswordChannel-struct" title="TpBasePasswordChannel">TpBasePasswordChannel</a>;
</pre>
</div>
<div class="refsect1">
<a name="telepathy-glib-base-password-channel.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
<a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
+----<a class="link" href="TpBaseChannel.html" title="TpBaseChannel">TpBaseChannel</a>
+----TpBasePasswordChannel
</pre>
</div>
<div class="refsect1">
<a name="telepathy-glib-base-password-channel.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
TpBasePasswordChannel implements
<a class="link" href="telepathy-glib-svc-generic.html#TpSvcDBusProperties">TpSvcDBusProperties</a>, <a class="link" href="telepathy-glib-svc-channel.html#TpSvcChannel">TpSvcChannel</a>, <a class="link" href="TpChannelIface.html" title="TpChannelIface">TpChannelIface</a>, <a class="link" href="TpExportableChannel.html" title="TpExportableChannel">TpExportableChannel</a>, <a class="link" href="telepathy-glib-svc-channel-auth.html#TpSvcChannelTypeServerAuthentication">TpSvcChannelTypeServerAuthentication</a> and <a class="link" href="telepathy-glib-svc-channel-auth.html#TpSvcChannelInterfaceSASLAuthentication">TpSvcChannelInterfaceSASLAuthentication</a>.</p>
</div>
<div class="refsect1">
<a name="telepathy-glib-base-password-channel.properties"></a><h2>Properties</h2>
<pre class="synopsis">
"<a class="link" href="telepathy-glib-base-password-channel.html#TpBasePasswordChannel--authentication-method" title='The "authentication-method" property'>authentication-method</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read
"<a class="link" href="telepathy-glib-base-password-channel.html#TpBasePasswordChannel--authorization-identity" title='The "authorization-identity" property'>authorization-identity</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read
"<a class="link" href="telepathy-glib-base-password-channel.html#TpBasePasswordChannel--available-mechanisms" title='The "available-mechanisms" property'>available-mechanisms</a>" <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Boxed-Types.html#GStrv"><span class="type">GStrv</span></a> : Read
"<a class="link" href="telepathy-glib-base-password-channel.html#TpBasePasswordChannel--can-try-again" title='The "can-try-again" property'>can-try-again</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read
"<a class="link" href="telepathy-glib-base-password-channel.html#TpBasePasswordChannel--default-realm" title='The "default-realm" property'>default-realm</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read
"<a class="link" href="telepathy-glib-base-password-channel.html#TpBasePasswordChannel--default-username" title='The "default-username" property'>default-username</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read
"<a class="link" href="telepathy-glib-base-password-channel.html#TpBasePasswordChannel--has-initial-data" title='The "has-initial-data" property'>has-initial-data</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read
"<a class="link" href="telepathy-glib-base-password-channel.html#TpBasePasswordChannel--may-save-response" title='The "may-save-response" property'>may-save-response</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read / Write / Construct Only
"<a class="link" href="telepathy-glib-base-password-channel.html#TpBasePasswordChannel--sasl-error" title='The "sasl-error" property'>sasl-error</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read
"<a class="link" href="telepathy-glib-base-password-channel.html#TpBasePasswordChannel--sasl-error-details" title='The "sasl-error-details" property'>sasl-error-details</a>" <span class="type">GHashTable_gchararray+GValue_*</span> : Read
"<a class="link" href="telepathy-glib-base-password-channel.html#TpBasePasswordChannel--sasl-status" title='The "sasl-status" property'>sasl-status</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> : Read
</pre>
</div>
<div class="refsect1">
<a name="telepathy-glib-base-password-channel.signals"></a><h2>Signals</h2>
<pre class="synopsis">
"<a class="link" href="telepathy-glib-base-password-channel.html#TpBasePasswordChannel-finished" title='The "finished" signal'>finished</a>" : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a>
</pre>
</div>
<div class="refsect1">
<a name="telepathy-glib-base-password-channel.description"></a><h2>Description</h2>
<p>
This class implements a SASL Authentication channel with the
X-TELEPATHY-PASSWORD SASL mechanism. Most of the time, you should
not use or instantiate this class directly. It is used by
<a class="link" href="telepathy-glib-simple-password-manager.html#TpSimplePasswordManager"><span class="type">TpSimplePasswordManager</span></a> behind the scenes. In some special
circumstances (e.g. when the authentication channel needs to
implement additional interfaces), it may be necessary to create
your own custom authentication channels instead of letting
<a class="link" href="telepathy-glib-simple-password-manager.html#TpSimplePasswordManager"><span class="type">TpSimplePasswordManager</span></a> create them automatically. In this case,
you should derive your channel from this class and then pass the
channel as an argument to
<a class="link" href="telepathy-glib-simple-password-manager.html#tp-simple-password-manager-prompt-for-channel-async" title="tp_simple_password_manager_prompt_for_channel_async ()"><code class="function">tp_simple_password_manager_prompt_for_channel_async()</code></a>.
</p>
</div>
<div class="refsect1">
<a name="telepathy-glib-base-password-channel.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="TpBasePasswordChannel-struct"></a><h3>TpBasePasswordChannel</h3>
<pre class="programlisting">typedef struct _TpBasePasswordChannel TpBasePasswordChannel;</pre>
<p>
Data structure representing a channel implementing a SASL Authentication
channel with the X-TELEPATHY-PASSWORD SASL mechanism.
</p>
<p class="since">Since 0.13.15</p>
</div>
</div>
<div class="refsect1">
<a name="telepathy-glib-base-password-channel.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="TpBasePasswordChannel--authentication-method"></a><h3>The <code class="literal">"authentication-method"</code> property</h3>
<pre class="programlisting"> "authentication-method" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read</pre>
<p>Interface of authentication method.</p>
<p>Default value: ""</p>
</div>
<hr>
<div class="refsect2">
<a name="TpBasePasswordChannel--authorization-identity"></a><h3>The <code class="literal">"authorization-identity"</code> property</h3>
<pre class="programlisting"> "authorization-identity" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read</pre>
<p>Authorization identity.</p>
<p>Default value: ""</p>
</div>
<hr>
<div class="refsect2">
<a name="TpBasePasswordChannel--available-mechanisms"></a><h3>The <code class="literal">"available-mechanisms"</code> property</h3>
<pre class="programlisting"> "available-mechanisms" <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Boxed-Types.html#GStrv"><span class="type">GStrv</span></a> : Read</pre>
<p>The set of mechanisms the server advertised.</p>
</div>
<hr>
<div class="refsect2">
<a name="TpBasePasswordChannel--can-try-again"></a><h3>The <code class="literal">"can-try-again"</code> property</h3>
<pre class="programlisting"> "can-try-again" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read</pre>
<p>Whether StartMechanism will work in failed states.</p>
<p>Default value: FALSE</p>
</div>
<hr>
<div class="refsect2">
<a name="TpBasePasswordChannel--default-realm"></a><h3>The <code class="literal">"default-realm"</code> property</h3>
<pre class="programlisting"> "default-realm" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read</pre>
<p>DefaultRealm.</p>
<p>Default value: ""</p>
</div>
<hr>
<div class="refsect2">
<a name="TpBasePasswordChannel--default-username"></a><h3>The <code class="literal">"default-username"</code> property</h3>
<pre class="programlisting"> "default-username" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read</pre>
<p>DefaultUsername.</p>
<p>Default value: ""</p>
</div>
<hr>
<div class="refsect2">
<a name="TpBasePasswordChannel--has-initial-data"></a><h3>The <code class="literal">"has-initial-data"</code> property</h3>
<pre class="programlisting"> "has-initial-data" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read</pre>
<p>Whether the StartMechanismWithData can be called.</p>
<p>Default value: FALSE</p>
</div>
<hr>
<div class="refsect2">
<a name="TpBasePasswordChannel--may-save-response"></a><h3>The <code class="literal">"may-save-response"</code> property</h3>
<pre class="programlisting"> "may-save-response" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read / Write / Construct Only</pre>
<p>Whether the client may save the authentication response.</p>
<p>Default value: TRUE</p>
</div>
<hr>
<div class="refsect2">
<a name="TpBasePasswordChannel--sasl-error"></a><h3>The <code class="literal">"sasl-error"</code> property</h3>
<pre class="programlisting"> "sasl-error" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read</pre>
<p>SASL error.</p>
<p>Default value: ""</p>
</div>
<hr>
<div class="refsect2">
<a name="TpBasePasswordChannel--sasl-error-details"></a><h3>The <code class="literal">"sasl-error-details"</code> property</h3>
<pre class="programlisting"> "sasl-error-details" <span class="type">GHashTable_gchararray+GValue_*</span> : Read</pre>
<p>SASL error details.</p>
</div>
<hr>
<div class="refsect2">
<a name="TpBasePasswordChannel--sasl-status"></a><h3>The <code class="literal">"sasl-status"</code> property</h3>
<pre class="programlisting"> "sasl-status" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> : Read</pre>
<p>The status of the current SASL authentication.</p>
<p>Allowed values: <= 7</p>
<p>Default value: 0</p>
</div>
</div>
<div class="refsect1">
<a name="telepathy-glib-base-password-channel.signal-details"></a><h2>Signal Details</h2>
<div class="refsect2">
<a name="TpBasePasswordChannel-finished"></a><h3>The <code class="literal">"finished"</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="telepathy-glib-base-password-channel.html#TpBasePasswordChannel"><span class="type">TpBasePasswordChannel</span></a> *password,
<a href="http://library.gnome.org/devel/glib/unstable/glib-Strings.html#GString"><span class="type">GString</span></a> *domain,
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> code,
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> message,
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *arg4,
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data) : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a></pre>
<p>
Emitted when either the password has been provided by the user or the
authentication has been aborted.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>password</code></em> :</span></p></td>
<td>the password provided by the user, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if the
authentication has been aborted</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>domain</code></em> :</span></p></td>
<td>domain of a <a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> indicating why the authentication has been
aborted, or 0</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>code</code></em> :</span></p></td>
<td>error code of a GError indicating why the authentication has been
aborted, or 0</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>message</code></em> :</span></p></td>
<td>a message associated with the error, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>user data set when the signal handler was connected.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.13.15</p>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.19</div>
</body>
</html>
|
