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
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>TpExportableChannel</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="telepathy-glib-dbus-properties-mixin.html" title="TpDBusPropertiesMixin">
<link rel="next" href="TpBaseChannel.html" title="TpBaseChannel">
<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="telepathy-glib-dbus-properties-mixin.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="TpBaseChannel.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#TpExportableChannel.synopsis" class="shortcut">Top</a>
|
<a href="#TpExportableChannel.description" class="shortcut">Description</a>
|
<a href="#TpExportableChannel.object-hierarchy" class="shortcut">Object Hierarchy</a>
|
<a href="#TpExportableChannel.prerequisites" class="shortcut">Prerequisites</a>
|
<a href="#TpExportableChannel.implementations" class="shortcut">Known Implementations</a>
|
<a href="#TpExportableChannel.properties" class="shortcut">Properties</a>
</td></tr>
</table>
<div class="refentry">
<a name="TpExportableChannel"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="TpExportableChannel.top_of_page"></a>TpExportableChannel</span></h2>
<p>TpExportableChannel — interface representing channels with several standard
properties</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="TpExportableChannel.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include <telepathy-glib/telepathy-glib.h>
<span class="returnvalue">void</span> (<a class="link" href="TpExportableChannel.html#TpExportableChannelFunc" title="TpExportableChannelFunc ()">*TpExportableChannelFunc</a>) (<em class="parameter"><code><a class="link" href="TpExportableChannel.html" title="TpExportableChannel"><span class="type">TpExportableChannel</span></a> *channel</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);
<a class="link" href="TpExportableChannel.html#TpExportableChannel-struct" title="TpExportableChannel">TpExportableChannel</a>;
struct <a class="link" href="TpExportableChannel.html#TpExportableChannelIface" title="struct TpExportableChannelIface">TpExportableChannelIface</a>;
</pre>
</div>
<div class="refsect1">
<a name="TpExportableChannel.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
GInterface
+----TpExportableChannel
</pre>
</div>
<div class="refsect1">
<a name="TpExportableChannel.prerequisites"></a><h2>Prerequisites</h2>
<p>
TpExportableChannel requires
<a class="link" href="telepathy-glib-svc-channel.html#TpSvcChannel">TpSvcChannel</a>.</p>
</div>
<div class="refsect1">
<a name="TpExportableChannel.implementations"></a><h2>Known Implementations</h2>
<p>
TpExportableChannel 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> and <a class="link" href="telepathy-glib-base-password-channel.html#TpBasePasswordChannel">TpBasePasswordChannel</a>.</p>
</div>
<div class="refsect1">
<a name="TpExportableChannel.properties"></a><h2>Properties</h2>
<pre class="synopsis">
"<a class="link" href="TpExportableChannel.html#TpExportableChannel--channel-destroyed" title='The "channel-destroyed" property'>channel-destroyed</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="TpExportableChannel.html#TpExportableChannel--channel-properties" title='The "channel-properties" property'>channel-properties</a>" <span class="type">GHashTable_gchararray+GValue_*</span> : Read
"<a class="link" href="TpExportableChannel.html#TpExportableChannel--object-path" title='The "object-path" property'>object-path</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write / Construct Only
</pre>
</div>
<div class="refsect1">
<a name="TpExportableChannel.description"></a><h2>Description</h2>
<p>
This interface defines a set of channel properties on top of those of
<a class="link" href="TpChannelIface.html" title="TpChannelIface"><span class="type">TpChannelIface</span></a>. It's mainly used by <a class="link" href="TpChannelManager.html" title="TpChannelManager"><span class="type">TpChannelManager</span></a> to represent the
returned and managed channel objects.
</p>
</div>
<div class="refsect1">
<a name="TpExportableChannel.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="TpExportableChannelFunc"></a><h3>TpExportableChannelFunc ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> (*TpExportableChannelFunc) (<em class="parameter"><code><a class="link" href="TpExportableChannel.html" title="TpExportableChannel"><span class="type">TpExportableChannel</span></a> *channel</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);</pre>
<p>
A callback for functions which act on exportable channels.
</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>channel</code></em> :</span></p></td>
<td>An object implementing the exportable channel interface</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>Arbitrary user-supplied data</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="TpExportableChannel-struct"></a><h3>TpExportableChannel</h3>
<pre class="programlisting">typedef struct _TpExportableChannel TpExportableChannel;</pre>
<p>
Opaque typedef representing a channel with several standard properties.
</p>
</div>
<hr>
<div class="refsect2">
<a name="TpExportableChannelIface"></a><h3>struct TpExportableChannelIface</h3>
<pre class="programlisting">struct TpExportableChannelIface {
GTypeInterface parent;
};
</pre>
<p>
The interface for <a class="link" href="TpExportableChannel.html" title="TpExportableChannel"><span class="type">TpExportableChannel</span></a> objects.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term"><a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GTypeInterface"><span class="type">GTypeInterface</span></a> <em class="structfield"><code><a name="TpExportableChannelIface.parent"></a>parent</code></em>;</span></p></td>
<td>The parent interface</td>
</tr></tbody>
</table></div>
</div>
</div>
<div class="refsect1">
<a name="TpExportableChannel.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="TpExportableChannel--channel-destroyed"></a><h3>The <code class="literal">"channel-destroyed"</code> property</h3>
<pre class="programlisting"> "channel-destroyed" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read</pre>
<p>
If true, the closed signal on the Channel interface indicates that
the channel can go away.
</p>
<p>
If false, the closed signal indicates to the channel manager that the
channel should appear to go away and be re-created, by emitting Closed
followed by NewChannel. (This is to support the "respawning" of Text
channels which are closed with unacknowledged messages.)
</p>
<p>Default value: FALSE</p>
</div>
<hr>
<div class="refsect2">
<a name="TpExportableChannel--channel-properties"></a><h3>The <code class="literal">"channel-properties"</code> property</h3>
<pre class="programlisting"> "channel-properties" <span class="type">GHashTable_gchararray+GValue_*</span> : Read</pre>
<p>
The D-Bus properties to be announced in the NewChannels signal
and in the Channels property, as a map from
interface.name.propertyname to GValue.
</p>
<p>
A channel's immutable properties are constant for its lifetime on the
bus, so this property should only change when the closed signal is
emitted (so that respawned channels can reappear on the bus with
different properties). All of the D-Bus properties mentioned here
should be exposed through the D-Bus properties interface; additional
(possibly mutable) properties not included here may also be exposed
via the D-Bus properties interface.
</p>
<p>
If the channel implementation uses
<a class="link" href="telepathy-glib-dbus-properties-mixin.html" title="TpDBusPropertiesMixin">TpDBusPropertiesMixin</a>,
this property can implemented using
<a class="link" href="telepathy-glib-dbus-properties-mixin.html#tp-dbus-properties-mixin-make-properties-hash" title="tp_dbus_properties_mixin_make_properties_hash ()"><code class="function">tp_dbus_properties_mixin_make_properties_hash()</code></a> as follows:
</p>
<p>
</p>
<div class="informalexample">
<table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
<tbody>
<tr>
<td class="listing_lines" align="right"><pre>1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19</pre></td>
<td class="listing_code"><pre class="programlisting"><span class="keyword">case</span><span class="normal"> PROP_CHANNEL_PROPERTIES</span><span class="symbol">:</span>
<span class="normal"> </span><span class="function"><a href="http://library.gnome.org/devel/gobject/unstable/gobject-Standard-Parameter-and-Value-Types.html#g-value-take-boxed">g_value_take_boxed</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">value</span><span class="symbol">,</span>
<span class="normal"> </span><span class="function"><a href="telepathy-glib-dbus-properties-mixin.html#tp-dbus-properties-mixin-make-properties-hash">tp_dbus_properties_mixin_make_properties_hash</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">object</span><span class="symbol">,</span>
<span class="normal"> </span><span class="comment">// The spec says these properties MUST be included:</span>
<span class="normal"> <a href="telepathy-glib-interfaces.html#TP-IFACE-CHANNEL:CAPS">TP_IFACE_CHANNEL</a></span><span class="symbol">,</span><span class="normal"> </span><span class="string">"TargetHandle"</span><span class="symbol">,</span>
<span class="normal"> <a href="telepathy-glib-interfaces.html#TP-IFACE-CHANNEL:CAPS">TP_IFACE_CHANNEL</a></span><span class="symbol">,</span><span class="normal"> </span><span class="string">"TargetHandleType"</span><span class="symbol">,</span>
<span class="normal"> <a href="telepathy-glib-interfaces.html#TP-IFACE-CHANNEL:CAPS">TP_IFACE_CHANNEL</a></span><span class="symbol">,</span><span class="normal"> </span><span class="string">"ChannelType"</span><span class="symbol">,</span>
<span class="normal"> <a href="telepathy-glib-interfaces.html#TP-IFACE-CHANNEL:CAPS">TP_IFACE_CHANNEL</a></span><span class="symbol">,</span><span class="normal"> </span><span class="string">"TargetID"</span><span class="symbol">,</span>
<span class="normal"> <a href="telepathy-glib-interfaces.html#TP-IFACE-CHANNEL:CAPS">TP_IFACE_CHANNEL</a></span><span class="symbol">,</span><span class="normal"> </span><span class="string">"Requested"</span><span class="symbol">,</span>
<span class="normal"> </span><span class="comment">// These aren't mandatory as of spec 0.17.17</span>
<span class="normal"> </span><span class="comment">// (but they should be):</span>
<span class="normal"> <a href="telepathy-glib-interfaces.html#TP-IFACE-CHANNEL:CAPS">TP_IFACE_CHANNEL</a></span><span class="symbol">,</span><span class="normal"> </span><span class="string">"InitiatorHandle"</span><span class="symbol">,</span>
<span class="normal"> <a href="telepathy-glib-interfaces.html#TP-IFACE-CHANNEL:CAPS">TP_IFACE_CHANNEL</a></span><span class="symbol">,</span><span class="normal"> </span><span class="string">"InitiatorID"</span><span class="symbol">,</span>
<span class="normal"> <a href="telepathy-glib-interfaces.html#TP-IFACE-CHANNEL:CAPS">TP_IFACE_CHANNEL</a></span><span class="symbol">,</span><span class="normal"> </span><span class="string">"Interfaces"</span><span class="symbol">,</span>
<span class="normal"> </span><span class="comment">// Perhaps your channel has some other immutable properties:</span>
<span class="normal"> <a href="telepathy-glib-interfaces.html#TP-IFACE-CHANNEL-INTERFACE-MESSAGES:CAPS">TP_IFACE_CHANNEL_INTERFACE_MESSAGES</a></span><span class="symbol">,</span><span class="normal"> </span><span class="string">"SupportedContentTypes"</span><span class="symbol">,</span>
<span class="normal"> </span><span class="comment">// etc.</span>
<span class="normal"> <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS">NULL</a></span><span class="symbol">));</span>
<span class="normal"> </span><span class="keyword">break</span><span class="symbol">;</span></pre></td>
</tr>
</tbody>
</table>
</div>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="TpExportableChannel--object-path"></a><h3>The <code class="literal">"object-path"</code> property</h3>
<pre class="programlisting"> "object-path" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write / Construct Only</pre>
<p>
The D-Bus object path used for this object on the bus. Read-only
except during construction.
</p>
<p>Default value: NULL</p>
</div>
</div>
<div class="refsect1">
<a name="TpExportableChannel.see-also"></a><h2>See Also</h2>
<a class="link" href="TpChannelIface.html" title="TpChannelIface"><span class="type">TpChannelIface</span></a>, <a class="link" href="TpChannelManager.html" title="TpChannelManager"><span class="type">TpChannelManager</span></a>, <a class="link" href="telepathy-glib-svc-channel.html#TpSvcChannel"><span class="type">TpSvcChannel</span></a>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.19</div>
</body>
</html>
|
