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

« back to all changes in this revision

Viewing changes to docs/reference/html/telepathy-glib-observe-channels-context.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:
8
8
<link rel="up" href="ch-service-base.html" title="Service-side implementation">
9
9
<link rel="prev" href="telepathy-glib-base-client.html" title="TpBaseClient">
10
10
<link rel="next" href="telepathy-glib-add-dispatch-operation-context.html" title="TpAddDispatchOperationContext">
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">
48
48
<span class="returnvalue">void</span>                <a class="link" href="telepathy-glib-observe-channels-context.html#tp-observe-channels-context-accept" title="tp_observe_channels_context_accept ()">tp_observe_channels_context_accept</a>  (<em class="parameter"><code><a class="link" href="telepathy-glib-observe-channels-context.html#TpObserveChannelsContext"><span class="type">TpObserveChannelsContext</span></a> *self</code></em>);
49
49
<span class="returnvalue">void</span>                <a class="link" href="telepathy-glib-observe-channels-context.html#tp-observe-channels-context-delay" title="tp_observe_channels_context_delay ()">tp_observe_channels_context_delay</a>   (<em class="parameter"><code><a class="link" href="telepathy-glib-observe-channels-context.html#TpObserveChannelsContext"><span class="type">TpObserveChannelsContext</span></a> *self</code></em>);
50
50
<span class="returnvalue">void</span>                <a class="link" href="telepathy-glib-observe-channels-context.html#tp-observe-channels-context-fail" title="tp_observe_channels_context_fail ()">tp_observe_channels_context_fail</a>    (<em class="parameter"><code><a class="link" href="telepathy-glib-observe-channels-context.html#TpObserveChannelsContext"><span class="type">TpObserveChannelsContext</span></a> *self</code></em>,
51
 
                                                         <em class="parameter"><code>const <span class="type">GError</span> *error</code></em>);
52
 
<span class="returnvalue">gboolean</span>            <a class="link" href="telepathy-glib-observe-channels-context.html#tp-observe-channels-context-is-recovering" title="tp_observe_channels_context_is_recovering ()">tp_observe_channels_context_is_recovering</a>
 
51
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> *error</code></em>);
 
52
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="telepathy-glib-observe-channels-context.html#tp-observe-channels-context-is-recovering" title="tp_observe_channels_context_is_recovering ()">tp_observe_channels_context_is_recovering</a>
53
53
                                                        (<em class="parameter"><code><a class="link" href="telepathy-glib-observe-channels-context.html#TpObserveChannelsContext"><span class="type">TpObserveChannelsContext</span></a> *self</code></em>);
54
 
<span class="returnvalue">GList</span> *             <a class="link" href="telepathy-glib-observe-channels-context.html#tp-observe-channels-context-get-requests" title="tp_observe_channels_context_get_requests ()">tp_observe_channels_context_get_requests</a>
 
54
<a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> *             <a class="link" href="telepathy-glib-observe-channels-context.html#tp-observe-channels-context-get-requests" title="tp_observe_channels_context_get_requests ()">tp_observe_channels_context_get_requests</a>
55
55
                                                        (<em class="parameter"><code><a class="link" href="telepathy-glib-observe-channels-context.html#TpObserveChannelsContext"><span class="type">TpObserveChannelsContext</span></a> *self</code></em>);
56
56
</pre>
57
57
</div>
58
58
<div class="refsect1">
59
59
<a name="telepathy-glib-observe-channels-context.object-hierarchy"></a><h2>Object Hierarchy</h2>
60
60
<pre class="synopsis">
61
 
  GObject
 
61
  <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
62
62
   +----TpObserveChannelsContext
63
63
</pre>
64
64
</div>
66
66
<a name="telepathy-glib-observe-channels-context.properties"></a><h2>Properties</h2>
67
67
<pre class="synopsis">
68
68
  "<a class="link" href="telepathy-glib-observe-channels-context.html#TpObserveChannelsContext--account" title='The "account" property'>account</a>"                  <a class="link" href="telepathy-glib-account.html#TpAccount"><span class="type">TpAccount</span></a>*            : Read / Write / Construct Only
69
 
  "<a class="link" href="telepathy-glib-observe-channels-context.html#TpObserveChannelsContext--channels" title='The "channels" property'>channels</a>"                 <span class="type">GPtrArray</span>*            : Read / Write / Construct Only
 
69
  "<a class="link" href="telepathy-glib-observe-channels-context.html#TpObserveChannelsContext--channels" title='The "channels" property'>channels</a>"                 <a href="http://library.gnome.org/devel/glib/unstable/glib-Pointer-Arrays.html#GPtrArray"><span class="type">GPtrArray</span></a>*            : Read / Write / Construct Only
70
70
  "<a class="link" href="telepathy-glib-observe-channels-context.html#TpObserveChannelsContext--connection" title='The "connection" property'>connection</a>"               <a class="link" href="telepathy-glib-connection.html#TpConnection"><span class="type">TpConnection</span></a>*         : Read / Write / Construct Only
71
 
  "<a class="link" href="telepathy-glib-observe-channels-context.html#TpObserveChannelsContext--dbus-context" title='The "dbus-context" property'>dbus-context</a>"             <span class="type">gpointer</span>              : Write / Construct Only
 
71
  "<a class="link" href="telepathy-glib-observe-channels-context.html#TpObserveChannelsContext--dbus-context" title='The "dbus-context" property'>dbus-context</a>"             <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>              : Write / Construct Only
72
72
  "<a class="link" href="telepathy-glib-observe-channels-context.html#TpObserveChannelsContext--dispatch-operation" title='The "dispatch-operation" property'>dispatch-operation</a>"       <a class="link" href="telepathy-glib-channel-dispatch-operation.html#TpChannelDispatchOperation"><span class="type">TpChannelDispatchOperation</span></a>*  : Read / Write / Construct Only
73
73
  "<a class="link" href="telepathy-glib-observe-channels-context.html#TpObserveChannelsContext--observer-info" title='The "observer-info" property'>observer-info</a>"            <span class="type">GHashTable_gchararray+GValue_*</span>  : Read / Write / Construct Only
74
 
  "<a class="link" href="telepathy-glib-observe-channels-context.html#TpObserveChannelsContext--requests" title='The "requests" property'>requests</a>"                 <span class="type">GPtrArray</span>*            : Read / Write / Construct Only
 
74
  "<a class="link" href="telepathy-glib-observe-channels-context.html#TpObserveChannelsContext--requests" title='The "requests" property'>requests</a>"                 <a href="http://library.gnome.org/devel/glib/unstable/glib-Pointer-Arrays.html#GPtrArray"><span class="type">GPtrArray</span></a>*            : Read / Write / Construct Only
75
75
</pre>
76
76
</div>
77
77
<div class="refsect1">
135
135
<div class="refsect2">
136
136
<a name="tp-observe-channels-context-fail"></a><h3>tp_observe_channels_context_fail ()</h3>
137
137
<pre class="programlisting"><span class="returnvalue">void</span>                tp_observe_channels_context_fail    (<em class="parameter"><code><a class="link" href="telepathy-glib-observe-channels-context.html#TpObserveChannelsContext"><span class="type">TpObserveChannelsContext</span></a> *self</code></em>,
138
 
                                                         <em class="parameter"><code>const <span class="type">GError</span> *error</code></em>);</pre>
 
138
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> *error</code></em>);</pre>
139
139
<p>
140
140
Called by <a class="link" href="telepathy-glib-base-client.html#TpBaseClientClassObserveChannelsImpl" title="TpBaseClientClassObserveChannelsImpl ()"><span class="type">TpBaseClientClassObserveChannelsImpl</span></a> to raise a D-Bus error.
141
141
</p>
158
158
<hr>
159
159
<div class="refsect2">
160
160
<a name="tp-observe-channels-context-is-recovering"></a><h3>tp_observe_channels_context_is_recovering ()</h3>
161
 
<pre class="programlisting"><span class="returnvalue">gboolean</span>            tp_observe_channels_context_is_recovering
 
161
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            tp_observe_channels_context_is_recovering
162
162
                                                        (<em class="parameter"><code><a class="link" href="telepathy-glib-observe-channels-context.html#TpObserveChannelsContext"><span class="type">TpObserveChannelsContext</span></a> *self</code></em>);</pre>
163
163
<p>
164
164
If this call to ObserveChannels is for channels that already
165
165
existed before this observer started (because the observer used
166
 
<a class="link" href="telepathy-glib-base-client.html#tp-base-client-set-observer-recover" title="tp_base_client_set_observer_recover ()"><code class="function">tp_base_client_set_observer_recover()</code></a>), return <code class="literal">TRUE</code>.
 
166
<a class="link" href="telepathy-glib-base-client.html#tp-base-client-set-observer-recover" title="tp_base_client_set_observer_recover ()"><code class="function">tp_base_client_set_observer_recover()</code></a>), return <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>.
167
167
</p>
168
168
<p>
169
 
In most cases, the result is <code class="literal">FALSE</code>.
 
169
In most cases, the result is <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>.
170
170
</p>
171
171
<div class="variablelist"><table border="0">
172
172
<col align="left" valign="top">
179
179
<tr>
180
180
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
181
181
<td>
182
 
<code class="literal">TRUE</code> for pre-existing channels, <code class="literal">FALSE</code> for new channels</td>
 
182
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> for pre-existing channels, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> for new channels</td>
183
183
</tr>
184
184
</tbody>
185
185
</table></div>
188
188
<hr>
189
189
<div class="refsect2">
190
190
<a name="tp-observe-channels-context-get-requests"></a><h3>tp_observe_channels_context_get_requests ()</h3>
191
 
<pre class="programlisting"><span class="returnvalue">GList</span> *             tp_observe_channels_context_get_requests
 
191
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> *             tp_observe_channels_context_get_requests
192
192
                                                        (<em class="parameter"><code><a class="link" href="telepathy-glib-observe-channels-context.html#TpObserveChannelsContext"><span class="type">TpObserveChannelsContext</span></a> *self</code></em>);</pre>
193
193
<p>
194
194
Return a list of the <a class="link" href="telepathy-glib-channel-request.html#TpChannelRequest"><span class="type">TpChannelRequest</span></a> which have been satisfied by the
204
204
</tr>
205
205
<tr>
206
206
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
207
 
<td>a newly allocated <span class="type">GList</span> of reffed <a class="link" href="telepathy-glib-channel-request.html#TpChannelRequest"><span class="type">TpChannelRequest</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> TelepathyGLib.ChannelRequest]</span>
 
207
<td>a newly allocated <a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="type">GList</span></a> of reffed <a class="link" href="telepathy-glib-channel-request.html#TpChannelRequest"><span class="type">TpChannelRequest</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> TelepathyGLib.ChannelRequest]</span>
208
208
</td>
209
209
</tr>
210
210
</tbody>
223
223
Read-only except during construction.
224
224
</p>
225
225
<p>
226
 
This property can't be <code class="literal">NULL</code>.
 
226
This property can't be <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.
227
227
</p>
228
228
<p class="since">Since 0.11.5</p>
229
229
</div>
230
230
<hr>
231
231
<div class="refsect2">
232
232
<a name="TpObserveChannelsContext--channels"></a><h3>The <code class="literal">"channels"</code> property</h3>
233
 
<pre class="programlisting">  "channels"                 <span class="type">GPtrArray</span>*            : Read / Write / Construct Only</pre>
 
233
<pre class="programlisting">  "channels"                 <a href="http://library.gnome.org/devel/glib/unstable/glib-Pointer-Arrays.html#GPtrArray"><span class="type">GPtrArray</span></a>*            : Read / Write / Construct Only</pre>
234
234
<p>
235
 
A <span class="type">GPtrArray</span> containing <a class="link" href="telepathy-glib-channel.html#TpChannel"><span class="type">TpChannel</span></a> objects representing the channels
 
235
A <a href="http://library.gnome.org/devel/glib/unstable/glib-Pointer-Arrays.html#GPtrArray"><span class="type">GPtrArray</span></a> containing <a class="link" href="telepathy-glib-channel.html#TpChannel"><span class="type">TpChannel</span></a> objects representing the channels
236
236
that have been passed to ObserveChannels.
237
237
Read-only except during construction.
238
238
</p>
239
239
<p>
240
 
This property can't be <code class="literal">NULL</code>.
 
240
This property can't be <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.
241
241
</p>
242
242
<p class="since">Since 0.11.5</p>
243
243
</div>
251
251
Read-only except during construction.
252
252
</p>
253
253
<p>
254
 
This property can't be <code class="literal">NULL</code>.
 
254
This property can't be <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.
255
255
</p>
256
256
<p class="since">Since 0.11.5</p>
257
257
</div>
258
258
<hr>
259
259
<div class="refsect2">
260
260
<a name="TpObserveChannelsContext--dbus-context"></a><h3>The <code class="literal">"dbus-context"</code> property</h3>
261
 
<pre class="programlisting">  "dbus-context"             <span class="type">gpointer</span>              : Write / Construct Only</pre>
 
261
<pre class="programlisting">  "dbus-context"             <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>              : Write / Construct Only</pre>
262
262
<p>
263
 
The <span class="type">DBusGMethodInvocation</span> representing the D-Bus context of the
 
263
The <a href="/usr/share/gtk-doc/html/dbus-glib/dbus-glib-DBusGMethod.html#DBusGMethodInvocation"><span class="type">DBusGMethodInvocation</span></a> representing the D-Bus context of the
264
264
ObserveChannels call.
265
265
Can only be written during construction.
266
266
</p>
273
273
<p>
274
274
A <a class="link" href="telepathy-glib-channel-dispatch-operation.html#TpChannelDispatchOperation"><span class="type">TpChannelDispatchOperation</span></a> object representing the
275
275
ChannelDispatchOperation that has been passed to ObserveChannels,
276
 
or <code class="literal">NULL</code> if none has been passed.
 
276
or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if none has been passed.
277
277
Read-only except during construction.
278
278
</p>
279
279
<p class="since">Since 0.11.5</p>
283
283
<a name="TpObserveChannelsContext--observer-info"></a><h3>The <code class="literal">"observer-info"</code> property</h3>
284
284
<pre class="programlisting">  "observer-info"            <span class="type">GHashTable_gchararray+GValue_*</span>  : Read / Write / Construct Only</pre>
285
285
<p>
286
 
A <span class="type">GHashTable</span> where the keys are string and values are GValue instances.
 
286
A <a href="http://library.gnome.org/devel/glib/unstable/glib-Hash-Tables.html#GHashTable"><span class="type">GHashTable</span></a> where the keys are string and values are GValue instances.
287
287
It represents the Observer_Info hash table that has been passed to
288
288
ObserveChannels.
289
289
It's recommended to use high-level method such as
290
290
<a class="link" href="telepathy-glib-observe-channels-context.html#tp-observe-channels-context-is-recovering" title="tp_observe_channels_context_is_recovering ()"><code class="function">tp_observe_channels_context_is_recovering()</code></a> to access to its content.
291
291
</p>
292
292
<p>
293
 
This property can't be <code class="literal">NULL</code>.
 
293
This property can't be <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.
294
294
</p>
295
295
<p class="since">Since 0.11.5</p>
296
296
</div>
297
297
<hr>
298
298
<div class="refsect2">
299
299
<a name="TpObserveChannelsContext--requests"></a><h3>The <code class="literal">"requests"</code> property</h3>
300
 
<pre class="programlisting">  "requests"                 <span class="type">GPtrArray</span>*            : Read / Write / Construct Only</pre>
 
300
<pre class="programlisting">  "requests"                 <a href="http://library.gnome.org/devel/glib/unstable/glib-Pointer-Arrays.html#GPtrArray"><span class="type">GPtrArray</span></a>*            : Read / Write / Construct Only</pre>
301
301
<p>
302
 
A <span class="type">GPtrArray</span> containing <a class="link" href="telepathy-glib-channel-request.html#TpChannelRequest"><span class="type">TpChannelRequest</span></a> objects representing the
 
302
A <a href="http://library.gnome.org/devel/glib/unstable/glib-Pointer-Arrays.html#GPtrArray"><span class="type">GPtrArray</span></a> containing <a class="link" href="telepathy-glib-channel-request.html#TpChannelRequest"><span class="type">TpChannelRequest</span></a> objects representing the
303
303
requests that have been passed to ObserveChannels.
304
304
Read-only except during construction.
305
305
</p>
306
306
<p>
307
 
This property can't be <code class="literal">NULL</code>.
 
307
This property can't be <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.
308
308
</p>
309
309
<p class="since">Since 0.11.5</p>
310
310
</div>
312
312
</div>
313
313
<div class="footer">
314
314
<hr>
315
 
          Generated by GTK-Doc V1.17</div>
 
315
          Generated by GTK-Doc V1.18</div>
316
316
</body>
317
317
</html>
 
 
b'\\ No newline at end of file'