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
251
252
253
254
255
256
257
258
259
260
261
262
263
264
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>TpChannelIface: telepathy-glib API Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="telepathy-glib API Reference Manual">
<link rel="up" href="ch-protocol.html" title="The Telepathy protocol">
<link rel="prev" href="telepathy-glib-gtypes.html" title="GType factory functions">
<link rel="next" href="ch-client.html" title="Client-side proxies">
<meta name="generator" content="GTK-Doc V1.32 (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="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span>
<a href="#TpChannelIface.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
<a href="#TpChannelIface.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_implementations"> <span class="dim">|</span>
<a href="#TpChannelIface.implementations" class="shortcut">Known Implementations</a></span><span id="nav_properties"> <span class="dim">|</span>
<a href="#TpChannelIface.properties" class="shortcut">Properties</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="ch-protocol.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="telepathy-glib-gtypes.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="ch-client.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="TpChannelIface"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="TpChannelIface.top_of_page"></a>TpChannelIface</span></h2>
<p>TpChannelIface — interface representing basic channel properties</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="TpChannelIface.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_proto_type">
<col class="functions_proto_name">
</colgroup>
<tbody><tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<span class="c_punctuation">(</span><a class="link" href="TpChannelIface.html#TpChannelFunc" title="TpChannelFunc ()">*TpChannelFunc</a><span class="c_punctuation">)</span> <span class="c_punctuation">()</span>
</td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="TpChannelIface.properties"></a><h2>Properties</h2>
<div class="informaltable"><table class="informaltable" border="0">
<colgroup>
<col width="150px" class="properties_type">
<col width="300px" class="properties_name">
<col width="200px" class="properties_flags">
</colgroup>
<tbody>
<tr>
<td class="property_type">
<span class="type">gchar</span> *</td>
<td class="property_name"><a class="link" href="TpChannelIface.html#TpChannelIface--channel-type" title="The “channel-type” property">channel-type</a></td>
<td class="property_flags">Read / Write / Construct Only</td>
</tr>
<tr>
<td class="property_type"><span class="type">guint</span></td>
<td class="property_name"><a class="link" href="TpChannelIface.html#TpChannelIface--handle" title="The “handle” property">handle</a></td>
<td class="property_flags">Read / Write / Construct Only</td>
</tr>
<tr>
<td class="property_type"><span class="type">guint</span></td>
<td class="property_name"><a class="link" href="TpChannelIface.html#TpChannelIface--handle-type" title="The “handle-type” property">handle-type</a></td>
<td class="property_flags">Read / Write / Construct Only</td>
</tr>
<tr>
<td class="property_type">
<span class="type">gchar</span> *</td>
<td class="property_name"><a class="link" href="TpChannelIface.html#TpChannelIface--object-path" title="The “object-path” property">object-path</a></td>
<td class="property_flags">Read / Write / Construct Only</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="TpChannelIface.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="other_proto_type">
<col class="other_proto_name">
</colgroup>
<tbody>
<tr>
<td class="datatype_keyword"> </td>
<td class="function_name"><a class="link" href="TpChannelIface.html#TpChannelIface-struct" title="TpChannelIface">TpChannelIface</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="TpChannelIface.html#TpChannelIfaceClass" title="struct TpChannelIfaceClass">TpChannelIfaceClass</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="TpChannelIface.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen"> <a href="/usr/share/gtk-doc/html/gobject/GTypeModule.html">GInterface</a>
<span class="lineart">╰──</span> TpChannelIface
</pre>
</div>
<div class="refsect1">
<a name="TpChannelIface.implementations"></a><h2>Known Implementations</h2>
<p>
TpChannelIface is implemented by
<a class="link" href="TpBaseCallChannel.html" title="TpBaseCallChannel">TpBaseCallChannel</a>, <a class="link" href="TpBaseChannel.html" title="TpBaseChannel">TpBaseChannel</a>, <a class="link" href="TpBaseMediaCallChannel.html" title="TpBaseMediaCallChannel">TpBaseMediaCallChannel</a>, <a class="link" href="telepathy-glib-base-password-channel.html#TpBasePasswordChannel">TpBasePasswordChannel</a>, <a class="link" href="telepathy-glib-call-channel.html#TpCallChannel">TpCallChannel</a>, <a class="link" href="telepathy-glib-channel.html#TpChannel">TpChannel</a>, <a class="link" href="telepathy-glib-dbus-tube-channel.html#TpDBusTubeChannel">TpDBusTubeChannel</a>, <a class="link" href="telepathy-glib-file-transfer-channel.html#TpFileTransferChannel">TpFileTransferChannel</a>, <a class="link" href="telepathy-glib-stream-tube-channel.html#TpStreamTubeChannel">TpStreamTubeChannel</a> and <a class="link" href="telepathy-glib-text-channel.html#TpTextChannel">TpTextChannel</a>.</p>
</div>
<div class="refsect1">
<a name="TpChannelIface.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include <telepathy-glib/telepathy-glib.h>
</pre>
</div>
<div class="refsect1">
<a name="TpChannelIface.description"></a><h2>Description</h2>
<p>This interface defines a basic set of channel properties. It's mainly
used in <a class="link" href="TpChannelFactoryIface.html" title="TpChannelFactoryIface"><span class="type">TpChannelFactoryIface</span></a> to represent the returned channel objects.</p>
</div>
<div class="refsect1">
<a name="TpChannelIface.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="TpChannelFunc"></a><h3>TpChannelFunc ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
<span class="c_punctuation">(</span>*TpChannelFunc<span class="c_punctuation">)</span> (<em class="parameter"><code><a class="link" href="TpChannelIface.html" title="TpChannelIface"><span class="type">TpChannelIface</span></a> *self</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> userdata</code></em>);</pre>
<p>A callback for functions which act on channels.</p>
<div class="refsect3">
<a name="TpChannelFunc.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>An object implementing the channel interface</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>userdata</p></td>
<td class="parameter_description"><p>Arbitrary user-supplied data</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="TpChannelIface.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="TpChannelIface-struct"></a><h3>TpChannelIface</h3>
<pre class="programlisting">typedef struct _TpChannelIface TpChannelIface;</pre>
<p>Opaque typedef representing a channel.</p>
</div>
<hr>
<div class="refsect2">
<a name="TpChannelIfaceClass"></a><h3>struct TpChannelIfaceClass</h3>
<pre class="programlisting">struct TpChannelIfaceClass {
GTypeInterface parent_class;
};
</pre>
<p>The class of the <a class="link" href="TpChannelIface.html" title="TpChannelIface"><span class="type">TpChannelIface</span></a> interface.</p>
<div class="refsect3">
<a name="TpChannelIfaceClass.members"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="struct_members_name">
<col class="struct_members_description">
<col width="200px" class="struct_members_annotations">
</colgroup>
<tbody></tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="TpChannelIface.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="TpChannelIface--channel-type"></a><h3>The <code class="literal">“channel-type”</code> property</h3>
<pre class="programlisting"> “channel-type” <span class="type">gchar</span> *</pre>
<p>The D-Bus interface representing the type of this channel. Read-only
except during construction.</p>
<p>In <a class="link" href="telepathy-glib-channel.html#TpChannel"><span class="type">TpChannel</span></a> this property is read-only except during construction;
if <code class="literal">NULL</code> during construction (the default), we ask the remote D-Bus
object what its channel type is, and reading this property will yield
<code class="literal">NULL</code> until a reply is received. This is not guaranteed to have happened
until <a class="link" href="telepathy-glib-proxy.html#tp-proxy-prepare-async" title="tp_proxy_prepare_async ()"><code class="function">tp_proxy_prepare_async()</code></a> has finished preparing
<a class="link" href="telepathy-glib-channel.html#TP-CHANNEL-FEATURE-CORE:CAPS" title="TP_CHANNEL_FEATURE_CORE"><code class="literal">TP_CHANNEL_FEATURE_CORE</code></a>.</p>
<p>In connection manager implementations, attempts to set this property
during construction will usually be ignored or treated as an
error.</p>
<p>Owner: TpChannelIface</p>
<p>Flags: Read / Write / Construct Only</p>
<p>Default value: NULL</p>
</div>
<hr>
<div class="refsect2">
<a name="TpChannelIface--handle"></a><h3>The <code class="literal">“handle”</code> property</h3>
<pre class="programlisting"> “handle” <span class="type">guint</span></pre>
<p>This channel's associated handle, or 0 if no handle or unknown.
Read-only except during construction.</p>
<p>In <a class="link" href="telepathy-glib-channel.html#TpChannel"><span class="type">TpChannel</span></a>, if this is 0
during construction, and handle-type is not TP_HANDLE_TYPE_NONE (== 0),
we ask the remote D-Bus object what its handle type is; reading this
property will yield 0 until we get the reply, or if <code class="function">GetHandle()</code>
fails. This is not guaranteed to be set until <a class="link" href="telepathy-glib-proxy.html#tp-proxy-prepare-async" title="tp_proxy_prepare_async ()"><code class="function">tp_proxy_prepare_async()</code></a>
has finished preparing <a class="link" href="telepathy-glib-channel.html#TP-CHANNEL-FEATURE-CORE:CAPS" title="TP_CHANNEL_FEATURE_CORE"><code class="literal">TP_CHANNEL_FEATURE_CORE</code></a>.</p>
<p>In connection manager implementations, attempts to set this during
construction might be ignored, depending on the channel type.</p>
<p>Owner: TpChannelIface</p>
<p>Flags: Read / Write / Construct Only</p>
<p>Default value: 0</p>
</div>
<hr>
<div class="refsect2">
<a name="TpChannelIface--handle-type"></a><h3>The <code class="literal">“handle-type”</code> property</h3>
<pre class="programlisting"> “handle-type” <span class="type">guint</span></pre>
<p>The <a class="link" href="telepathy-glib-enums.html#TpHandleType" title="enum TpHandleType"><span class="type">TpHandleType</span></a> of this channel's associated handle, or
<a class="link" href="telepathy-glib-enums.html#TP-HANDLE-TYPE-NONE:CAPS"><code class="literal">TP_HANDLE_TYPE_NONE</code></a> (which is numerically 0) if no handle.</p>
<p>In <a class="link" href="telepathy-glib-channel.html#TpChannel"><span class="type">TpChannel</span></a>, if this is TP_UNKNOWN_HANDLE_TYPE
during construction, we ask the remote D-Bus object what its
handle type is; reading this property will yield TP_UNKNOWN_HANDLE_TYPE
until we get the reply. This is not guaranteed to be have happened
until <a class="link" href="telepathy-glib-proxy.html#tp-proxy-prepare-async" title="tp_proxy_prepare_async ()"><code class="function">tp_proxy_prepare_async()</code></a> has finished preparing
<a class="link" href="telepathy-glib-channel.html#TP-CHANNEL-FEATURE-CORE:CAPS" title="TP_CHANNEL_FEATURE_CORE"><code class="literal">TP_CHANNEL_FEATURE_CORE</code></a>.</p>
<p>In connection manager implementations, attempts to set this during
construction might also be ignored.</p>
<p>Owner: TpChannelIface</p>
<p>Flags: Read / Write / Construct Only</p>
<p>Default value: 4294967295</p>
</div>
<hr>
<div class="refsect2">
<a name="TpChannelIface--object-path"></a><h3>The <code class="literal">“object-path”</code> property</h3>
<pre class="programlisting"> “object-path” <span class="type">gchar</span> *</pre>
<p>The D-Bus object path used for this object on the bus. Read-only
except during construction.</p>
<p>Owner: TpChannelIface</p>
<p>Flags: Read / Write / Construct Only</p>
<p>Default value: NULL</p>
</div>
</div>
<div class="refsect1">
<a name="TpChannelIface.see-also"></a><h2>See Also</h2>
<p><a class="link" href="telepathy-glib-svc-channel.html#TpSvcChannel"><span class="type">TpSvcChannel</span></a>, <a class="link" href="TpChannelFactoryIface.html" title="TpChannelFactoryIface"><span class="type">TpChannelFactoryIface</span></a></p>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.32</div>
</body>
</html>
|
