← Back to branch summary

~ubuntu-branches/ubuntu/precise/telepathy-glib/precise-201111172307

« back to all changes in this revision

Viewing changes to docs/reference/html/telepathy-glib-client-channel-factory.html

  • Committer: Ken VanDine
  • Date: 2011-11-17 20:53:21 UTC
  • mfrom: (1.6.34 upstream)
  • Revision ID: ken.vandine@canonical.com-20111117205321-l704j7kr1zgw5v9h
New upstream release.

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/html/telepathy-glib-client-channel-factory.html
8
8
<link rel="up" href="ch-client.html" title="Client-side proxies">
9
9
<link rel="prev" href="telepathy-glib-dbus-tube-channel.html" title="TpDBusTubeChannel">
10
10
<link rel="next" href="telepathy-glib-basic-proxy-factory.html" title="TpBasicProxyFactory">
11
 
<meta name="generator" content="GTK-Doc V1.17 (XML mode)">
 
11
<meta name="generator" content="GTK-Doc V1.18 (XML mode)">
12
12
<link rel="stylesheet" href="style.css" type="text/css">
13
13
</head>
14
14
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
51
51
<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>
52
52
                                                        (<em class="parameter"><code><a class="link" href="telepathy-glib-client-channel-factory.html#TpClientChannelFactory"><span class="type">TpClientChannelFactory</span></a> *self</code></em>,
53
53
                                                         <em class="parameter"><code><a class="link" href="telepathy-glib-connection.html#TpConnection"><span class="type">TpConnection</span></a> *conn</code></em>,
54
 
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *path</code></em>,
55
 
                                                         <em class="parameter"><code><span class="type">GHashTable</span> *properties</code></em>,
56
 
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);
57
 
<span class="returnvalue">GArray</span> *            <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>
 
54
                                                         <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>,
 
55
                                                         <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>,
 
56
                                                         <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>);
 
57
<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>
58
58
                                                        (<em class="parameter"><code><a class="link" href="telepathy-glib-client-channel-factory.html#TpClientChannelFactory"><span class="type">TpClientChannelFactory</span></a> *self</code></em>,
59
59
                                                         <em class="parameter"><code><a class="link" href="telepathy-glib-channel.html#TpChannel"><span class="type">TpChannel</span></a> *channel</code></em>);
60
60
</pre>
70
70
<a name="telepathy-glib-client-channel-factory.prerequisites"></a><h2>Prerequisites</h2>
71
71
<p>
72
72
TpClientChannelFactory requires
73
 
 GObject.</p>
 
73
 <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>.</p>
74
74
</div>
75
75
<div class="refsect1">
76
76
<a name="telepathy-glib-client-channel-factory.implementations"></a><h2>Known Implementations</h2>
99
99
<a name="TpClientChannelFactory-struct"></a><h3>TpClientChannelFactory</h3>
100
100
<pre class="programlisting">typedef struct _TpClientChannelFactory TpClientChannelFactory;</pre>
101
101
<p>
102
 
Opaque typedef representing a <span class="type">GObject</span> that implements
 
102
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
103
103
the <code class="literal">TP_TYPE_CLIENT_CHANNEL_FACTORY</code> interface.
104
104
</p>
105
105
<p class="since">Since 0.13.6</p>
136
136
<col align="left" valign="top">
137
137
<tbody>
138
138
<tr>
139
 
<td><p><span class="term"><span class="type">GTypeInterface</span> <em class="structfield"><code><a name="TpClientChannelFactoryInterface.parent"></a>parent</code></em>;</span></p></td>
 
139
<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>
140
140
<td>the parent</td>
141
141
</tr>
142
142
<tr>
172
172
<pre class="programlisting"><a class="link" href="telepathy-glib-channel.html#TpChannel"><span class="returnvalue">TpChannel</span></a> *         tp_client_channel_factory_create_channel
173
173
                                                        (<em class="parameter"><code><a class="link" href="telepathy-glib-client-channel-factory.html#TpClientChannelFactory"><span class="type">TpClientChannelFactory</span></a> *self</code></em>,
174
174
                                                         <em class="parameter"><code><a class="link" href="telepathy-glib-connection.html#TpConnection"><span class="type">TpConnection</span></a> *conn</code></em>,
175
 
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *path</code></em>,
176
 
                                                         <em class="parameter"><code><span class="type">GHashTable</span> *properties</code></em>,
177
 
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
 
175
                                                         <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>,
 
176
                                                         <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>,
 
177
                                                         <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>
178
178
<p>
179
179
Function called when a channel need to be created.
180
180
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.
207
207
</tr>
208
208
<tr>
209
209
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
210
 
<td>used to indicate the error if <code class="literal">NULL</code> is returned</td>
 
210
<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>
211
211
</tr>
212
212
<tr>
213
213
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
214
 
<td>a new channel proxy, or <code class="literal">NULL</code> on invalid arguments. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
 
214
<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>
215
215
</td>
216
216
</tr>
217
217
</tbody>
221
221
<hr>
222
222
<div class="refsect2">
223
223
<a name="tp-client-channel-factory-dup-channel-features"></a><h3>tp_client_channel_factory_dup_channel_features ()</h3>
224
 
<pre class="programlisting"><span class="returnvalue">GArray</span> *            tp_client_channel_factory_dup_channel_features
 
224
<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
225
225
                                                        (<em class="parameter"><code><a class="link" href="telepathy-glib-client-channel-factory.html#TpClientChannelFactory"><span class="type">TpClientChannelFactory</span></a> *self</code></em>,
226
226
                                                         <em class="parameter"><code><a class="link" href="telepathy-glib-channel.html#TpChannel"><span class="type">TpChannel</span></a> *channel</code></em>);</pre>
227
227
<p>
228
 
Return a zero terminated <span class="type">GArray</span> containing the <a class="link" href="telepathy-glib-channel.html#TpChannel"><span class="type">TpChannel</span></a> features that
 
228
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
229
229
should be prepared on <em class="parameter"><code>channel</code></em>.
230
230
</p>
231
231
<p>
247
247
</tr>
248
248
<tr>
249
249
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
250
 
<td>a newly allocated <span class="type">GArray</span>. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
 
250
<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>]</span>
251
251
</td>
252
252
</tr>
253
253
</tbody>
258
258
</div>
259
259
<div class="footer">
260
260
<hr>
261
 
          Generated by GTK-Doc V1.17</div>
 
261
          Generated by GTK-Doc V1.18</div>
262
262
</body>
263
263
</html>
 
 
b'\\ No newline at end of file'