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
265
266
267
268
269
270
271
272
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>TpClientChannelFactoryInterface</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-client.html" title="Client-side proxies">
<link rel="prev" href="telepathy-glib-dbus-tube-channel.html" title="TpDBusTubeChannel">
<link rel="next" href="telepathy-glib-basic-proxy-factory.html" title="TpBasicProxyFactory">
<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-tube-channel.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch-client.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-basic-proxy-factory.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-client-channel-factory.synopsis" class="shortcut">Top</a>
|
<a href="#telepathy-glib-client-channel-factory.description" class="shortcut">Description</a>
|
<a href="#telepathy-glib-client-channel-factory.object-hierarchy" class="shortcut">Object Hierarchy</a>
|
<a href="#telepathy-glib-client-channel-factory.prerequisites" class="shortcut">Prerequisites</a>
|
<a href="#telepathy-glib-client-channel-factory.implementations" class="shortcut">Known Implementations</a>
</td></tr>
</table>
<div class="refentry">
<a name="telepathy-glib-client-channel-factory"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="telepathy-glib-client-channel-factory.top_of_page"></a>TpClientChannelFactoryInterface</span></h2>
<p>TpClientChannelFactoryInterface — an interface for client channel factories</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="telepathy-glib-client-channel-factory.synopsis"></a><h2>Synopsis</h2>
<a name="TpClientChannelFactory"></a><pre class="synopsis">
#include <telepathy-glib/telepathy-glib.h>
<a class="link" href="telepathy-glib-client-channel-factory.html#TpClientChannelFactory-struct" title="TpClientChannelFactory">TpClientChannelFactory</a>;
struct <a class="link" href="telepathy-glib-client-channel-factory.html#TpClientChannelFactoryInterface" title="struct TpClientChannelFactoryInterface">TpClientChannelFactoryInterface</a>;
<a class="link" href="telepathy-glib-channel.html#TpChannel"><span class="returnvalue">TpChannel</span></a> * <a class="link" href="telepathy-glib-client-channel-factory.html#tp-client-channel-factory-create-channel" title="tp_client_channel_factory_create_channel ()">tp_client_channel_factory_create_channel</a>
(<em class="parameter"><code><a class="link" href="telepathy-glib-client-channel-factory.html#TpClientChannelFactory"><span class="type">TpClientChannelFactory</span></a> *self</code></em>,
<em class="parameter"><code><a class="link" href="telepathy-glib-connection.html#TpConnection"><span class="type">TpConnection</span></a> *conn</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *path</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Hash-Tables.html#GHashTable"><span class="type">GHashTable</span></a> *properties</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
<a href="http://library.gnome.org/devel/glib/unstable/glib-Arrays.html#GArray"><span class="returnvalue">GArray</span></a> * <a class="link" href="telepathy-glib-client-channel-factory.html#tp-client-channel-factory-dup-channel-features" title="tp_client_channel_factory_dup_channel_features ()">tp_client_channel_factory_dup_channel_features</a>
(<em class="parameter"><code><a class="link" href="telepathy-glib-client-channel-factory.html#TpClientChannelFactory"><span class="type">TpClientChannelFactory</span></a> *self</code></em>,
<em class="parameter"><code><a class="link" href="telepathy-glib-channel.html#TpChannel"><span class="type">TpChannel</span></a> *channel</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="telepathy-glib-client-channel-factory.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
GInterface
+----TpClientChannelFactory
</pre>
</div>
<div class="refsect1">
<a name="telepathy-glib-client-channel-factory.prerequisites"></a><h2>Prerequisites</h2>
<p>
TpClientChannelFactory requires
<a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>.</p>
</div>
<div class="refsect1">
<a name="telepathy-glib-client-channel-factory.implementations"></a><h2>Known Implementations</h2>
<p>
TpClientChannelFactory is implemented by
<a class="link" href="telepathy-glib-automatic-proxy-factory.html#TpAutomaticProxyFactory">TpAutomaticProxyFactory</a> and <a class="link" href="telepathy-glib-basic-proxy-factory.html#TpBasicProxyFactory">TpBasicProxyFactory</a>.</p>
</div>
<div class="refsect1">
<a name="telepathy-glib-client-channel-factory.description"></a><h2>Description</h2>
<p>
Client channel factories are used to create channel proxies. An application
wanting to use its own <a class="link" href="telepathy-glib-channel.html#TpChannel"><span class="type">TpChannel</span></a> subclass has to implement an object
implementing the <a class="link" href="telepathy-glib-client-channel-factory.html#TpClientChannelFactoryInterface" title="struct TpClientChannelFactoryInterface"><span class="type">TpClientChannelFactoryInterface</span></a> interface.
</p>
<p>
Once a channel has been created by a factory using
<a class="link" href="telepathy-glib-client-channel-factory.html#tp-client-channel-factory-create-channel" title="tp_client_channel_factory_create_channel ()"><code class="function">tp_client_channel_factory_create_channel()</code></a>, the caller should then prepare
on it the channel features returned by
<a class="link" href="telepathy-glib-client-channel-factory.html#tp-client-channel-factory-dup-channel-features" title="tp_client_channel_factory_dup_channel_features ()"><code class="function">tp_client_channel_factory_dup_channel_features()</code></a> using
<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>.
</p>
</div>
<div class="refsect1">
<a name="telepathy-glib-client-channel-factory.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="TpClientChannelFactory-struct"></a><h3>TpClientChannelFactory</h3>
<pre class="programlisting">typedef struct _TpClientChannelFactory TpClientChannelFactory;</pre>
<p>
Opaque typedef representing a <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a> that implements
the <code class="literal">TP_TYPE_CLIENT_CHANNEL_FACTORY</code> interface.
</p>
<p class="since">Since 0.13.6</p>
</div>
<hr>
<div class="refsect2">
<a name="TpClientChannelFactoryInterface"></a><h3>struct TpClientChannelFactoryInterface</h3>
<pre class="programlisting">struct TpClientChannelFactoryInterface {
GTypeInterface parent;
TpChannel * (* create_channel) (TpClientChannelFactoryInterface *self,
TpConnection *conn,
const gchar *path,
GHashTable *properties,
GError **error);
GArray * (* dup_channel_features) (TpClientChannelFactoryInterface *self,
TpChannel *channel);
TpChannel *(*obj_create_channel) (TpClientChannelFactory *self,
TpConnection *conn,
const gchar *path,
GHashTable *properties,
GError **error);
GArray *(*obj_dup_channel_features) (TpClientChannelFactory *self,
TpChannel *channel);
};
</pre>
<p>
Interface for a channel factory
</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="TpClientChannelFactoryInterface.parent"></a>parent</code></em>;</span></p></td>
<td>the parent</td>
</tr>
<tr>
<td><p><span class="term"><em class="structfield"><code><a name="TpClientChannelFactoryInterface.create-channel"></a>create_channel</code></em> ()</span></p></td>
<td>obsolete version of <em class="parameter"><code>obj_create_channel</code></em> which does not
receive the object instance as an argument</td>
</tr>
<tr>
<td><p><span class="term"><em class="structfield"><code><a name="TpClientChannelFactoryInterface.dup-channel-features"></a>dup_channel_features</code></em> ()</span></p></td>
<td>obsolete version of <em class="parameter"><code>obj_dup_channel_features</code></em> which
does not receive the object instance as an argument</td>
</tr>
<tr>
<td><p><span class="term"><em class="structfield"><code><a name="TpClientChannelFactoryInterface.obj-create-channel"></a>obj_create_channel</code></em> ()</span></p></td>
<td>virtual method used to create channels;
see <a class="link" href="telepathy-glib-client-channel-factory.html#tp-client-channel-factory-create-channel" title="tp_client_channel_factory_create_channel ()"><code class="function">tp_client_channel_factory_create_channel()</code></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="structfield"><code><a name="TpClientChannelFactoryInterface.obj-dup-channel-features"></a>obj_dup_channel_features</code></em> ()</span></p></td>
<td>virtual method returning channel features that
have to be prepared on newly created channels;
see <a class="link" href="telepathy-glib-client-channel-factory.html#tp-client-channel-factory-dup-channel-features" title="tp_client_channel_factory_dup_channel_features ()"><code class="function">tp_client_channel_factory_dup_channel_features()</code></a>
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.13.2</p>
</div>
<hr>
<div class="refsect2">
<a name="tp-client-channel-factory-create-channel"></a><h3>tp_client_channel_factory_create_channel ()</h3>
<pre class="programlisting"><a class="link" href="telepathy-glib-channel.html#TpChannel"><span class="returnvalue">TpChannel</span></a> * tp_client_channel_factory_create_channel
(<em class="parameter"><code><a class="link" href="telepathy-glib-client-channel-factory.html#TpClientChannelFactory"><span class="type">TpClientChannelFactory</span></a> *self</code></em>,
<em class="parameter"><code><a class="link" href="telepathy-glib-connection.html#TpConnection"><span class="type">TpConnection</span></a> *conn</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *path</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Hash-Tables.html#GHashTable"><span class="type">GHashTable</span></a> *properties</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>
Function called when a channel need to be created.
Implementation can return a subclass of <a class="link" href="telepathy-glib-channel.html#TpChannel"><span class="type">TpChannel</span></a> if they need to.
</p>
<p>
Changed in 0.13.6: the function's signature was previously wrong;
it expected an object instance as its first parameter, but the type of the
parameter was the type of the interface vtable.
</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>self</code></em> :</span></p></td>
<td>a client channel factory</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>conn</code></em> :</span></p></td>
<td>a <a class="link" href="telepathy-glib-connection.html#TpConnection"><span class="type">TpConnection</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>path</code></em> :</span></p></td>
<td>the object path of the channel</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>properties</code></em> :</span></p></td>
<td>the immutable properties of the channel. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>][<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> utf8 GObject.Value]</span>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>used to indicate the error if <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> is returned</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a new channel proxy, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> on invalid arguments. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.13.2</p>
</div>
<hr>
<div class="refsect2">
<a name="tp-client-channel-factory-dup-channel-features"></a><h3>tp_client_channel_factory_dup_channel_features ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Arrays.html#GArray"><span class="returnvalue">GArray</span></a> * tp_client_channel_factory_dup_channel_features
(<em class="parameter"><code><a class="link" href="telepathy-glib-client-channel-factory.html#TpClientChannelFactory"><span class="type">TpClientChannelFactory</span></a> *self</code></em>,
<em class="parameter"><code><a class="link" href="telepathy-glib-channel.html#TpChannel"><span class="type">TpChannel</span></a> *channel</code></em>);</pre>
<p>
Return a zero terminated <a href="http://library.gnome.org/devel/glib/unstable/glib-Arrays.html#GArray"><span class="type">GArray</span></a> containing the <a class="link" href="telepathy-glib-channel.html#TpChannel"><span class="type">TpChannel</span></a> features that
should be prepared on <em class="parameter"><code>channel</code></em>.
</p>
<p>
Changed in 0.13.6: the function's signature was previously wrong;
it expected an object instance as its first parameter, but the type of the
parameter was the type of the interface vtable.
</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>self</code></em> :</span></p></td>
<td>a client channel factory</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>channel</code></em> :</span></p></td>
<td>a <a class="link" href="telepathy-glib-channel.html#TpChannel"><span class="type">TpChannel</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a newly allocated <a href="http://library.gnome.org/devel/glib/unstable/glib-Arrays.html#GArray"><span class="type">GArray</span></a>. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>][<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> GQuark]</span>
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.13.3</p>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.19</div>
</body>
</html>
|
