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

« back to all changes in this revision

Viewing changes to docs/reference/html/telepathy-glib-capabilities.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-client.html" title="Client-side proxies">
9
9
<link rel="prev" href="telepathy-glib-contact.html" title="TpContact">
10
10
<link rel="next" href="telepathy-glib-connection-aliasing.html" title="Connection Aliasing interface">
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">
45
45
#include &lt;telepathy-glib/capabilities.h&gt;
46
46
 
47
47
                    <a class="link" href="telepathy-glib-capabilities.html#TpCapabilities-struct" title="TpCapabilities">TpCapabilities</a>;
48
 
<span class="returnvalue">GPtrArray</span> *         <a class="link" href="telepathy-glib-capabilities.html#tp-capabilities-get-channel-classes" title="tp_capabilities_get_channel_classes ()">tp_capabilities_get_channel_classes</a> (<em class="parameter"><code><a class="link" href="telepathy-glib-capabilities.html#TpCapabilities"><span class="type">TpCapabilities</span></a> *self</code></em>);
49
 
<span class="returnvalue">gboolean</span>            <a class="link" href="telepathy-glib-capabilities.html#tp-capabilities-is-specific-to-contact" title="tp_capabilities_is_specific_to_contact ()">tp_capabilities_is_specific_to_contact</a>
50
 
                                                        (<em class="parameter"><code><a class="link" href="telepathy-glib-capabilities.html#TpCapabilities"><span class="type">TpCapabilities</span></a> *self</code></em>);
51
 
<span class="returnvalue">gboolean</span>            <a class="link" href="telepathy-glib-capabilities.html#tp-capabilities-supports-text-chatrooms" title="tp_capabilities_supports_text_chatrooms ()">tp_capabilities_supports_text_chatrooms</a>
52
 
                                                        (<em class="parameter"><code><a class="link" href="telepathy-glib-capabilities.html#TpCapabilities"><span class="type">TpCapabilities</span></a> *self</code></em>);
53
 
<span class="returnvalue">gboolean</span>            <a class="link" href="telepathy-glib-capabilities.html#tp-capabilities-supports-text-chats" title="tp_capabilities_supports_text_chats ()">tp_capabilities_supports_text_chats</a> (<em class="parameter"><code><a class="link" href="telepathy-glib-capabilities.html#TpCapabilities"><span class="type">TpCapabilities</span></a> *self</code></em>);
54
 
<span class="returnvalue">gboolean</span>            <a class="link" href="telepathy-glib-capabilities.html#tp-capabilities-supports-stream-tubes" title="tp_capabilities_supports_stream_tubes ()">tp_capabilities_supports_stream_tubes</a>
55
 
                                                        (<em class="parameter"><code><a class="link" href="telepathy-glib-capabilities.html#TpCapabilities"><span class="type">TpCapabilities</span></a> *self</code></em>,
56
 
                                                         <em class="parameter"><code><a class="link" href="telepathy-glib-enums.html#TpHandleType" title="enum TpHandleType"><span class="type">TpHandleType</span></a> handle_type</code></em>,
57
 
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *service</code></em>);
58
 
<span class="returnvalue">gboolean</span>            <a class="link" href="telepathy-glib-capabilities.html#tp-capabilities-supports-dbus-tubes" title="tp_capabilities_supports_dbus_tubes ()">tp_capabilities_supports_dbus_tubes</a> (<em class="parameter"><code><a class="link" href="telepathy-glib-capabilities.html#TpCapabilities"><span class="type">TpCapabilities</span></a> *self</code></em>,
59
 
                                                         <em class="parameter"><code><a class="link" href="telepathy-glib-enums.html#TpHandleType" title="enum TpHandleType"><span class="type">TpHandleType</span></a> handle_type</code></em>,
60
 
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *service_name</code></em>);
61
 
<span class="returnvalue">gboolean</span>            <a class="link" href="telepathy-glib-capabilities.html#tp-capabilities-supports-contact-search" title="tp_capabilities_supports_contact_search ()">tp_capabilities_supports_contact_search</a>
62
 
                                                        (<em class="parameter"><code><a class="link" href="telepathy-glib-capabilities.html#TpCapabilities"><span class="type">TpCapabilities</span></a> *self</code></em>,
63
 
                                                         <em class="parameter"><code><span class="type">gboolean</span> *with_limit</code></em>,
64
 
                                                         <em class="parameter"><code><span class="type">gboolean</span> *with_server</code></em>);
65
 
<span class="returnvalue">gboolean</span>            <a class="link" href="telepathy-glib-capabilities.html#tp-capabilities-supports-room-list" title="tp_capabilities_supports_room_list ()">tp_capabilities_supports_room_list</a>  (<em class="parameter"><code><a class="link" href="telepathy-glib-capabilities.html#TpCapabilities"><span class="type">TpCapabilities</span></a> *self</code></em>,
66
 
                                                         <em class="parameter"><code><span class="type">gboolean</span> *with_server</code></em>);
 
48
<a href="http://library.gnome.org/devel/glib/unstable/glib-Pointer-Arrays.html#GPtrArray"><span class="returnvalue">GPtrArray</span></a> *         <a class="link" href="telepathy-glib-capabilities.html#tp-capabilities-get-channel-classes" title="tp_capabilities_get_channel_classes ()">tp_capabilities_get_channel_classes</a> (<em class="parameter"><code><a class="link" href="telepathy-glib-capabilities.html#TpCapabilities"><span class="type">TpCapabilities</span></a> *self</code></em>);
 
49
<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-capabilities.html#tp-capabilities-is-specific-to-contact" title="tp_capabilities_is_specific_to_contact ()">tp_capabilities_is_specific_to_contact</a>
 
50
                                                        (<em class="parameter"><code><a class="link" href="telepathy-glib-capabilities.html#TpCapabilities"><span class="type">TpCapabilities</span></a> *self</code></em>);
 
51
<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-capabilities.html#tp-capabilities-supports-text-chatrooms" title="tp_capabilities_supports_text_chatrooms ()">tp_capabilities_supports_text_chatrooms</a>
 
52
                                                        (<em class="parameter"><code><a class="link" href="telepathy-glib-capabilities.html#TpCapabilities"><span class="type">TpCapabilities</span></a> *self</code></em>);
 
53
<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-capabilities.html#tp-capabilities-supports-text-chats" title="tp_capabilities_supports_text_chats ()">tp_capabilities_supports_text_chats</a> (<em class="parameter"><code><a class="link" href="telepathy-glib-capabilities.html#TpCapabilities"><span class="type">TpCapabilities</span></a> *self</code></em>);
 
54
<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-capabilities.html#tp-capabilities-supports-stream-tubes" title="tp_capabilities_supports_stream_tubes ()">tp_capabilities_supports_stream_tubes</a>
 
55
                                                        (<em class="parameter"><code><a class="link" href="telepathy-glib-capabilities.html#TpCapabilities"><span class="type">TpCapabilities</span></a> *self</code></em>,
 
56
                                                         <em class="parameter"><code><a class="link" href="telepathy-glib-enums.html#TpHandleType" title="enum TpHandleType"><span class="type">TpHandleType</span></a> handle_type</code></em>,
 
57
                                                         <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> *service</code></em>);
 
58
<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-capabilities.html#tp-capabilities-supports-dbus-tubes" title="tp_capabilities_supports_dbus_tubes ()">tp_capabilities_supports_dbus_tubes</a> (<em class="parameter"><code><a class="link" href="telepathy-glib-capabilities.html#TpCapabilities"><span class="type">TpCapabilities</span></a> *self</code></em>,
 
59
                                                         <em class="parameter"><code><a class="link" href="telepathy-glib-enums.html#TpHandleType" title="enum TpHandleType"><span class="type">TpHandleType</span></a> handle_type</code></em>,
 
60
                                                         <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> *service_name</code></em>);
 
61
<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-capabilities.html#tp-capabilities-supports-contact-search" title="tp_capabilities_supports_contact_search ()">tp_capabilities_supports_contact_search</a>
 
62
                                                        (<em class="parameter"><code><a class="link" href="telepathy-glib-capabilities.html#TpCapabilities"><span class="type">TpCapabilities</span></a> *self</code></em>,
 
63
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> *with_limit</code></em>,
 
64
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> *with_server</code></em>);
 
65
<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-capabilities.html#tp-capabilities-supports-room-list" title="tp_capabilities_supports_room_list ()">tp_capabilities_supports_room_list</a>  (<em class="parameter"><code><a class="link" href="telepathy-glib-capabilities.html#TpCapabilities"><span class="type">TpCapabilities</span></a> *self</code></em>,
 
66
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> *with_server</code></em>);
67
67
</pre>
68
68
</div>
69
69
<div class="refsect1">
70
70
<a name="telepathy-glib-capabilities.object-hierarchy"></a><h2>Object Hierarchy</h2>
71
71
<pre class="synopsis">
72
 
  GObject
 
72
  <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
73
73
   +----TpCapabilities
74
74
</pre>
75
75
</div>
77
77
<a name="telepathy-glib-capabilities.properties"></a><h2>Properties</h2>
78
78
<pre class="synopsis">
79
79
  "<a class="link" href="telepathy-glib-capabilities.html#TpCapabilities--channel-classes" title='The "channel-classes" property'>channel-classes</a>"          <span class="type">GPtrArray_GValueArray_GHashTable_gchararray+GValue_+GStrv__*</span>  : Read / Write / Construct Only
80
 
  "<a class="link" href="telepathy-glib-capabilities.html#TpCapabilities--contact-specific" title='The "contact-specific" property'>contact-specific</a>"         <span class="type">gboolean</span>              : Read / Write / Construct Only
 
80
  "<a class="link" href="telepathy-glib-capabilities.html#TpCapabilities--contact-specific" title='The "contact-specific" property'>contact-specific</a>"         <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write / Construct Only
81
81
</pre>
82
82
</div>
83
83
<div class="refsect1">
100
100
<hr>
101
101
<div class="refsect2">
102
102
<a name="tp-capabilities-get-channel-classes"></a><h3>tp_capabilities_get_channel_classes ()</h3>
103
 
<pre class="programlisting"><span class="returnvalue">GPtrArray</span> *         tp_capabilities_get_channel_classes (<em class="parameter"><code><a class="link" href="telepathy-glib-capabilities.html#TpCapabilities"><span class="type">TpCapabilities</span></a> *self</code></em>);</pre>
 
103
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Pointer-Arrays.html#GPtrArray"><span class="returnvalue">GPtrArray</span></a> *         tp_capabilities_get_channel_classes (<em class="parameter"><code><a class="link" href="telepathy-glib-capabilities.html#TpCapabilities"><span class="type">TpCapabilities</span></a> *self</code></em>);</pre>
104
104
<p>
105
105
 
106
106
</p>
113
113
</tr>
114
114
<tr>
115
115
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
116
 
<td>the same <span class="type">GPtrArray</span> as the
 
116
<td>the same <a href="http://library.gnome.org/devel/glib/unstable/glib-Pointer-Arrays.html#GPtrArray"><span class="type">GPtrArray</span></a> as the
117
117
<a class="link" href="telepathy-glib-capabilities.html#TpCapabilities--channel-classes" title='The "channel-classes" property'><span class="type">"channel-classes"</span></a> property. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
118
118
</td>
119
119
</tr>
124
124
<hr>
125
125
<div class="refsect2">
126
126
<a name="tp-capabilities-is-specific-to-contact"></a><h3>tp_capabilities_is_specific_to_contact ()</h3>
127
 
<pre class="programlisting"><span class="returnvalue">gboolean</span>            tp_capabilities_is_specific_to_contact
 
127
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            tp_capabilities_is_specific_to_contact
128
128
                                                        (<em class="parameter"><code><a class="link" href="telepathy-glib-capabilities.html#TpCapabilities"><span class="type">TpCapabilities</span></a> *self</code></em>);</pre>
129
129
<p>
130
130
 
138
138
</tr>
139
139
<tr>
140
140
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
141
 
<td>the same <span class="type">gboolean</span> as the <a class="link" href="telepathy-glib-capabilities.html#TpCapabilities--contact-specific" title='The "contact-specific" property'><span class="type">"contact-specific"</span></a> property</td>
 
141
<td>the same <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> as the <a class="link" href="telepathy-glib-capabilities.html#TpCapabilities--contact-specific" title='The "contact-specific" property'><span class="type">"contact-specific"</span></a> property</td>
142
142
</tr>
143
143
</tbody>
144
144
</table></div>
147
147
<hr>
148
148
<div class="refsect2">
149
149
<a name="tp-capabilities-supports-text-chatrooms"></a><h3>tp_capabilities_supports_text_chatrooms ()</h3>
150
 
<pre class="programlisting"><span class="returnvalue">gboolean</span>            tp_capabilities_supports_text_chatrooms
 
150
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            tp_capabilities_supports_text_chatrooms
151
151
                                                        (<em class="parameter"><code><a class="link" href="telepathy-glib-capabilities.html#TpCapabilities"><span class="type">TpCapabilities</span></a> *self</code></em>);</pre>
152
152
<p>
153
 
If the <a class="link" href="telepathy-glib-capabilities.html#TpCapabilities--contact-specific" title='The "contact-specific" property'><span class="type">"contact-specific"</span></a> property is <code class="literal">FALSE</code>, this function
 
153
If the <a class="link" href="telepathy-glib-capabilities.html#TpCapabilities--contact-specific" title='The "contact-specific" property'><span class="type">"contact-specific"</span></a> property is <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>, this function
154
154
checks if named text chatrooms can be joined by providing a chatroom
155
155
identifier.
156
156
</p>
157
157
<p>
158
 
If the <a class="link" href="telepathy-glib-capabilities.html#TpCapabilities--contact-specific" title='The "contact-specific" property'><span class="type">"contact-specific"</span></a> property is <code class="literal">TRUE</code>, this function
 
158
If the <a class="link" href="telepathy-glib-capabilities.html#TpCapabilities--contact-specific" title='The "contact-specific" property'><span class="type">"contact-specific"</span></a> property is <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>, this function
159
159
checks if the contact associated with this <a class="link" href="telepathy-glib-capabilities.html#TpCapabilities"><span class="type">TpCapabilities</span></a> can be invited
160
160
to named text chatrooms.
161
161
</p>
162
162
<p>
163
163
If the protocol is such that chatrooms can be joined or contacts can be
164
164
invited, but only via a more elaborate D-Bus API than normal
165
 
(because more information is needed), then this method will return <code class="literal">FALSE</code>.
 
165
(because more information is needed), then this method will return <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>.
166
166
</p>
167
167
<div class="variablelist"><table border="0">
168
168
<col align="left" valign="top">
174
174
<tr>
175
175
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
176
176
<td>
177
 
<code class="literal">TRUE</code> if a channel request containing Text as ChannelType,
 
177
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if a channel request containing Text as ChannelType,
178
178
HandleTypeRoom as TargetHandleType and a channel identifier can be
179
 
expected to work, <code class="literal">FALSE</code> otherwise.</td>
 
179
expected to work, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise.</td>
180
180
</tr>
181
181
</tbody>
182
182
</table></div>
185
185
<hr>
186
186
<div class="refsect2">
187
187
<a name="tp-capabilities-supports-text-chats"></a><h3>tp_capabilities_supports_text_chats ()</h3>
188
 
<pre class="programlisting"><span class="returnvalue">gboolean</span>            tp_capabilities_supports_text_chats (<em class="parameter"><code><a class="link" href="telepathy-glib-capabilities.html#TpCapabilities"><span class="type">TpCapabilities</span></a> *self</code></em>);</pre>
 
188
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            tp_capabilities_supports_text_chats (<em class="parameter"><code><a class="link" href="telepathy-glib-capabilities.html#TpCapabilities"><span class="type">TpCapabilities</span></a> *self</code></em>);</pre>
189
189
<p>
190
190
Return whether private text channels can be established by providing
191
191
a contact identifier.
193
193
<p>
194
194
If the protocol is such that text chats can be established, but only via a
195
195
more elaborate D-Bus API than normal (because more information is needed),
196
 
then this method will return <code class="literal">FALSE</code>.
 
196
then this method will return <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>.
197
197
</p>
198
198
<div class="variablelist"><table border="0">
199
199
<col align="left" valign="top">
205
205
<tr>
206
206
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
207
207
<td>
208
 
<code class="literal">TRUE</code> if a channel request containing Text as ChannelType,
 
208
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if a channel request containing Text as ChannelType,
209
209
HandleTypeContact as TargetHandleType and a contact identifier can be
210
 
expected to work, <code class="literal">FALSE</code> otherwise.</td>
 
210
expected to work, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise.</td>
211
211
</tr>
212
212
</tbody>
213
213
</table></div>
216
216
<hr>
217
217
<div class="refsect2">
218
218
<a name="tp-capabilities-supports-stream-tubes"></a><h3>tp_capabilities_supports_stream_tubes ()</h3>
219
 
<pre class="programlisting"><span class="returnvalue">gboolean</span>            tp_capabilities_supports_stream_tubes
 
219
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            tp_capabilities_supports_stream_tubes
220
220
                                                        (<em class="parameter"><code><a class="link" href="telepathy-glib-capabilities.html#TpCapabilities"><span class="type">TpCapabilities</span></a> *self</code></em>,
221
221
                                                         <em class="parameter"><code><a class="link" href="telepathy-glib-enums.html#TpHandleType" title="enum TpHandleType"><span class="type">TpHandleType</span></a> handle_type</code></em>,
222
 
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *service</code></em>);</pre>
 
222
                                                         <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> *service</code></em>);</pre>
223
223
<p>
224
 
If the <a class="link" href="telepathy-glib-capabilities.html#TpCapabilities--contact-specific" title='The "contact-specific" property'><span class="type">"contact-specific"</span></a> property is <code class="literal">TRUE</code>, this function
 
224
If the <a class="link" href="telepathy-glib-capabilities.html#TpCapabilities--contact-specific" title='The "contact-specific" property'><span class="type">"contact-specific"</span></a> property is <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>, this function
225
225
checks if the contact associated with this <a class="link" href="telepathy-glib-capabilities.html#TpCapabilities"><span class="type">TpCapabilities</span></a> supports
226
226
stream tubes with <em class="parameter"><code>handle_type</code></em> as TargetHandleType.
227
 
If <em class="parameter"><code>service</code></em> is not <code class="literal">NULL</code>, it also checks if it supports stream tubes
 
227
If <em class="parameter"><code>service</code></em> is not <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, it also checks if it supports stream tubes
228
228
with <em class="parameter"><code>service</code></em> as <a class="link" href="telepathy-glib-interfaces.html#TP-PROP-CHANNEL-TYPE-STREAM-TUBE-SERVICE:CAPS" title="TP_PROP_CHANNEL_TYPE_STREAM_TUBE_SERVICE"><span class="type">TP_PROP_CHANNEL_TYPE_STREAM_TUBE_SERVICE</span></a>.
229
229
</p>
230
230
<p>
231
 
If the <a class="link" href="telepathy-glib-capabilities.html#TpCapabilities--contact-specific" title='The "contact-specific" property'><span class="type">"contact-specific"</span></a> property is <code class="literal">FALSE</code>, this function
 
231
If the <a class="link" href="telepathy-glib-capabilities.html#TpCapabilities--contact-specific" title='The "contact-specific" property'><span class="type">"contact-specific"</span></a> property is <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>, this function
232
232
checks if the connection supports requesting stream tube channels with
233
233
<em class="parameter"><code>handle_type</code></em> as ChannelType. The <em class="parameter"><code>service</code></em> argument is unused in this case.
234
234
</p>
246
246
</tr>
247
247
<tr>
248
248
<td><p><span class="term"><em class="parameter"><code>service</code></em> :</span></p></td>
249
 
<td>the service of the tube, or <code class="literal">NULL</code>
 
249
<td>the service of the tube, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
250
250
</td>
251
251
</tr>
252
252
<tr>
253
253
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
254
254
<td>
255
 
<code class="literal">TRUE</code> if the contact or connection supports this type of stream
 
255
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the contact or connection supports this type of stream
256
256
tubes.</td>
257
257
</tr>
258
258
</tbody>
262
262
<hr>
263
263
<div class="refsect2">
264
264
<a name="tp-capabilities-supports-dbus-tubes"></a><h3>tp_capabilities_supports_dbus_tubes ()</h3>
265
 
<pre class="programlisting"><span class="returnvalue">gboolean</span>            tp_capabilities_supports_dbus_tubes (<em class="parameter"><code><a class="link" href="telepathy-glib-capabilities.html#TpCapabilities"><span class="type">TpCapabilities</span></a> *self</code></em>,
 
265
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            tp_capabilities_supports_dbus_tubes (<em class="parameter"><code><a class="link" href="telepathy-glib-capabilities.html#TpCapabilities"><span class="type">TpCapabilities</span></a> *self</code></em>,
266
266
                                                         <em class="parameter"><code><a class="link" href="telepathy-glib-enums.html#TpHandleType" title="enum TpHandleType"><span class="type">TpHandleType</span></a> handle_type</code></em>,
267
 
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *service_name</code></em>);</pre>
 
267
                                                         <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> *service_name</code></em>);</pre>
268
268
<p>
269
 
If the <a class="link" href="telepathy-glib-capabilities.html#TpCapabilities--contact-specific" title='The "contact-specific" property'><span class="type">"contact-specific"</span></a> property is <code class="literal">TRUE</code>, this function
 
269
If the <a class="link" href="telepathy-glib-capabilities.html#TpCapabilities--contact-specific" title='The "contact-specific" property'><span class="type">"contact-specific"</span></a> property is <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>, this function
270
270
checks if the contact associated with this <a class="link" href="telepathy-glib-capabilities.html#TpCapabilities"><span class="type">TpCapabilities</span></a> supports
271
271
D-Bus tubes with <em class="parameter"><code>handle_type</code></em> as TargetHandleType.
272
 
If <em class="parameter"><code>service_name</code></em> is not <code class="literal">NULL</code>, it also checks if it supports stream tubes
 
272
If <em class="parameter"><code>service_name</code></em> is not <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, it also checks if it supports stream tubes
273
273
with <em class="parameter"><code>service</code></em> as <a class="link" href="telepathy-glib-interfaces.html#TP-PROP-CHANNEL-TYPE-DBUS-TUBE-SERVICE-NAME:CAPS" title="TP_PROP_CHANNEL_TYPE_DBUS_TUBE_SERVICE_NAME"><span class="type">TP_PROP_CHANNEL_TYPE_DBUS_TUBE_SERVICE_NAME</span></a>.
274
274
</p>
275
275
<p>
276
 
If the <a class="link" href="telepathy-glib-capabilities.html#TpCapabilities--contact-specific" title='The "contact-specific" property'><span class="type">"contact-specific"</span></a> property is <code class="literal">FALSE</code>, this function
 
276
If the <a class="link" href="telepathy-glib-capabilities.html#TpCapabilities--contact-specific" title='The "contact-specific" property'><span class="type">"contact-specific"</span></a> property is <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>, this function
277
277
checks if the connection supports requesting D-Bus tube channels with
278
278
<em class="parameter"><code>handle_type</code></em> as ChannelType. The <em class="parameter"><code>service_name</code></em> argument is unused in
279
279
this case.
292
292
</tr>
293
293
<tr>
294
294
<td><p><span class="term"><em class="parameter"><code>service_name</code></em> :</span></p></td>
295
 
<td>the service name of the tube, or <code class="literal">NULL</code>
 
295
<td>the service name of the tube, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
296
296
</td>
297
297
</tr>
298
298
<tr>
299
299
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
300
300
<td>
301
 
<code class="literal">TRUE</code> if the contact or connection supports this type of D-Bus
 
301
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the contact or connection supports this type of D-Bus
302
302
tubes.</td>
303
303
</tr>
304
304
</tbody>
308
308
<hr>
309
309
<div class="refsect2">
310
310
<a name="tp-capabilities-supports-contact-search"></a><h3>tp_capabilities_supports_contact_search ()</h3>
311
 
<pre class="programlisting"><span class="returnvalue">gboolean</span>            tp_capabilities_supports_contact_search
 
311
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            tp_capabilities_supports_contact_search
312
312
                                                        (<em class="parameter"><code><a class="link" href="telepathy-glib-capabilities.html#TpCapabilities"><span class="type">TpCapabilities</span></a> *self</code></em>,
313
 
                                                         <em class="parameter"><code><span class="type">gboolean</span> *with_limit</code></em>,
314
 
                                                         <em class="parameter"><code><span class="type">gboolean</span> *with_server</code></em>);</pre>
 
313
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> *with_limit</code></em>,
 
314
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> *with_server</code></em>);</pre>
315
315
<p>
316
316
Return whether this protocol or connection can perform contact
317
317
searches. Optionally, also return whether a limited number of
327
327
</tr>
328
328
<tr>
329
329
<td><p><span class="term"><em class="parameter"><code>with_limit</code></em> :</span></p></td>
330
 
<td>if not <code class="literal">NULL</code>, used to return <code class="literal">TRUE</code> if the limit
 
330
<td>if not <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, used to return <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the limit
331
331
parameter to <a class="link" href="telepathy-glib-contact-search.html#tp-contact-search-new-async" title="tp_contact_search_new_async ()"><code class="function">tp_contact_search_new_async()</code></a> and
332
332
<a class="link" href="telepathy-glib-contact-search.html#tp-contact-search-reset-async" title="tp_contact_search_reset_async ()"><code class="function">tp_contact_search_reset_async()</code></a> can be nonzero. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span>
333
333
</td>
334
334
</tr>
335
335
<tr>
336
336
<td><p><span class="term"><em class="parameter"><code>with_server</code></em> :</span></p></td>
337
 
<td>if not <code class="literal">NULL</code>, used to return <code class="literal">TRUE</code> if the server
 
337
<td>if not <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, used to return <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the server
338
338
parameter to <a class="link" href="telepathy-glib-contact-search.html#tp-contact-search-new-async" title="tp_contact_search_new_async ()"><code class="function">tp_contact_search_new_async()</code></a> and
339
 
<a class="link" href="telepathy-glib-contact-search.html#tp-contact-search-reset-async" title="tp_contact_search_reset_async ()"><code class="function">tp_contact_search_reset_async()</code></a> can be non-<code class="literal">NULL</code>. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span>
 
339
<a class="link" href="telepathy-glib-contact-search.html#tp-contact-search-reset-async" title="tp_contact_search_reset_async ()"><code class="function">tp_contact_search_reset_async()</code></a> can be non-<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span>
340
340
</td>
341
341
</tr>
342
342
<tr>
343
343
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
344
344
<td>
345
 
<code class="literal">TRUE</code> if <a class="link" href="telepathy-glib-contact-search.html#TpContactSearch"><span class="type">TpContactSearch</span></a> can be used.</td>
 
345
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if <a class="link" href="telepathy-glib-contact-search.html#TpContactSearch"><span class="type">TpContactSearch</span></a> can be used.</td>
346
346
</tr>
347
347
</tbody>
348
348
</table></div>
351
351
<hr>
352
352
<div class="refsect2">
353
353
<a name="tp-capabilities-supports-room-list"></a><h3>tp_capabilities_supports_room_list ()</h3>
354
 
<pre class="programlisting"><span class="returnvalue">gboolean</span>            tp_capabilities_supports_room_list  (<em class="parameter"><code><a class="link" href="telepathy-glib-capabilities.html#TpCapabilities"><span class="type">TpCapabilities</span></a> *self</code></em>,
355
 
                                                         <em class="parameter"><code><span class="type">gboolean</span> *with_server</code></em>);</pre>
 
354
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            tp_capabilities_supports_room_list  (<em class="parameter"><code><a class="link" href="telepathy-glib-capabilities.html#TpCapabilities"><span class="type">TpCapabilities</span></a> *self</code></em>,
 
355
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> *with_server</code></em>);</pre>
356
356
<p>
357
357
Discovers whether this protocol or connection supports listing rooms.
358
 
Specifically, if this function returns <code class="literal">TRUE</code>, a room list channel can be
 
358
Specifically, if this function returns <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>, a room list channel can be
359
359
requested as follows:
360
360
</p>
361
 
<div class="informalexample"><pre class="programlisting">
362
 
GHashTable *request;
363
 
TpAccountChannelRequest *req;
364
 
 
365
 
request = tp_asv_new (
366
 
    TP_PROP_CHANNEL_CHANNEL_TYPE, G_TYPE_STRING,
367
 
      TP_IFACE_CHANNEL_TYPE_ROOM_LIST,
368
 
    TP_PROP_CHANNEL_TARGET_HANDLE_TYPE, G_TYPE_UINT, TP_HANDLE_TYPE_NONE,
369
 
    NULL);
370
 
 
371
 
req = tp_account_channel_request_new (account, request,
372
 
   TP_USER_ACTION_TIME_CURRENT_TIME);
373
 
 
374
 
tp_account_channel_request_create_and_handle_channel_async (req, NULL,
375
 
    create_channel_cb, NULL);
376
 
 
377
 
g_object_unref (req);
378
 
g_hash_table_unref (request);
379
 
</pre></div>
 
361
<div class="informalexample">
 
362
  <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
 
363
    <tbody>
 
364
      <tr>
 
365
        <td class="listing_lines" align="right"><pre>1
 
366
2
 
367
3
 
368
4
 
369
5
 
370
6
 
371
7
 
372
8
 
373
9
 
374
10
 
375
11
 
376
12
 
377
13
 
378
14
 
379
15
 
380
16
 
381
17</pre></td>
 
382
        <td class="listing_code"><pre class="programlisting">GHashTable <span class="gtkdoc opt">*</span>request<span class="gtkdoc opt">;</span>
 
383
TpAccountChannelRequest <span class="gtkdoc opt">*</span>req<span class="gtkdoc opt">;</span>
 
384
 
 
385
request <span class="gtkdoc opt">=</span> <span class="function"><a href="telepathy-glib-asv.html#tp-asv-new">tp_asv_new</a></span> <span class="gtkdoc opt">(</span>
 
386
    TP_PROP_CHANNEL_CHANNEL_TYPE<span class="gtkdoc opt">,</span> G_TYPE_STRING<span class="gtkdoc opt">,</span>
 
387
      TP_IFACE_CHANNEL_TYPE_ROOM_LIST<span class="gtkdoc opt">,</span>
 
388
    TP_PROP_CHANNEL_TARGET_HANDLE_TYPE<span class="gtkdoc opt">,</span> G_TYPE_UINT<span class="gtkdoc opt">,</span> TP_HANDLE_TYPE_NONE<span class="gtkdoc opt">,</span>
 
389
    NULL<span class="gtkdoc opt">);</span>
 
390
 
 
391
req <span class="gtkdoc opt">=</span> <span class="function"><a href="telepathy-glib-account-channel-request.html#tp-account-channel-request-new">tp_account_channel_request_new</a></span> <span class="gtkdoc opt">(</span>account<span class="gtkdoc opt">,</span> request<span class="gtkdoc opt">,</span>
 
392
   TP_USER_ACTION_TIME_CURRENT_TIME<span class="gtkdoc opt">);</span>
 
393
 
 
394
<span class="function"><a href="telepathy-glib-account-channel-request.html#tp-account-channel-request-create-and-handle-channel-async">tp_account_channel_request_create_and_handle_channel_async</a></span> <span class="gtkdoc opt">(</span>req<span class="gtkdoc opt">,</span> NULL<span class="gtkdoc opt">,</span>
 
395
    create_channel_cb<span class="gtkdoc opt">,</span> NULL<span class="gtkdoc opt">);</span>
 
396
 
 
397
<span class="function"><a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#g-object-unref">g_object_unref</a></span> <span class="gtkdoc opt">(</span>req<span class="gtkdoc opt">);</span>
 
398
<span class="function"><a href="http://library.gnome.org/devel/glib/unstable/glib-Hash-Tables.html#g-hash-table-unref">g_hash_table_unref</a></span> <span class="gtkdoc opt">(</span>request<span class="gtkdoc opt">);</span></pre></td>
 
399
      </tr>
 
400
    </tbody>
 
401
  </table>
 
402
</div>
 
403
 
380
404
<p>
381
405
</p>
382
406
<p>
383
 
If <em class="parameter"><code>with_server</code></em> is set to <code class="literal">TRUE</code>, a list of rooms on a particular server can
 
407
If <em class="parameter"><code>with_server</code></em> is set to <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>, a list of rooms on a particular server can
384
408
be requested as follows:
385
409
</p>
386
 
<div class="informalexample"><pre class="programlisting">
387
 
/\* Same code as above but with request defined using: *\/
388
 
request = tp_asv_new (
389
 
    TP_PROP_CHANNEL_CHANNEL_TYPE, G_TYPE_STRING,
390
 
      TP_IFACE_CHANNEL_TYPE_ROOM_LIST,
391
 
    TP_PROP_CHANNEL_TARGET_HANDLE_TYPE, G_TYPE_UINT, TP_HANDLE_TYPE_NONE,
392
 
    TP_PROP_CHANNEL_TYPE_ROOM_LIST_SERVER, G_TYPE_STRING,
393
 
      "characters.shakespeare.lit",
394
 
    NULL);
395
 
</pre></div>
 
410
<div class="informalexample">
 
411
  <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
 
412
    <tbody>
 
413
      <tr>
 
414
        <td class="listing_lines" align="right"><pre>1
 
415
2
 
416
3
 
417
4
 
418
5
 
419
6
 
420
7
 
421
8</pre></td>
 
422
        <td class="listing_code"><pre class="programlisting"><span class="gtkdoc opt">/</span>\<span class="gtkdoc opt">*</span> Same code as above but with request defined <span class="keyword">using</span><span class="gtkdoc opt">: *</span>\<span class="gtkdoc opt">/</span>
 
423
request <span class="gtkdoc opt">=</span> <span class="function"><a href="telepathy-glib-asv.html#tp-asv-new">tp_asv_new</a></span> <span class="gtkdoc opt">(</span>
 
424
    TP_PROP_CHANNEL_CHANNEL_TYPE<span class="gtkdoc opt">,</span> G_TYPE_STRING<span class="gtkdoc opt">,</span>
 
425
      TP_IFACE_CHANNEL_TYPE_ROOM_LIST<span class="gtkdoc opt">,</span>
 
426
    TP_PROP_CHANNEL_TARGET_HANDLE_TYPE<span class="gtkdoc opt">,</span> G_TYPE_UINT<span class="gtkdoc opt">,</span> TP_HANDLE_TYPE_NONE<span class="gtkdoc opt">,</span>
 
427
    TP_PROP_CHANNEL_TYPE_ROOM_LIST_SERVER<span class="gtkdoc opt">,</span> G_TYPE_STRING<span class="gtkdoc opt">,</span>
 
428
      <span class="string">&quot;characters.shakespeare.lit&quot;</span><span class="gtkdoc opt">,</span>
 
429
    NULL<span class="gtkdoc opt">);</span></pre></td>
 
430
      </tr>
 
431
    </tbody>
 
432
  </table>
 
433
</div>
 
434
 
396
435
<p>
397
436
</p>
398
437
<div class="variablelist"><table border="0">
404
443
</tr>
405
444
<tr>
406
445
<td><p><span class="term"><em class="parameter"><code>with_server</code></em> :</span></p></td>
407
 
<td>if not <code class="literal">NULL</code>, used to return <code class="literal">TRUE</code> if the
 
446
<td>if not <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, used to return <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the
408
447
<a class="link" href="telepathy-glib-interfaces.html#TP-PROP-CHANNEL-TYPE-ROOM-LIST-SERVER:CAPS" title="TP_PROP_CHANNEL_TYPE_ROOM_LIST_SERVER"><span class="type">TP_PROP_CHANNEL_TYPE_ROOM_LIST_SERVER</span></a> property can be defined when
409
448
requesting a RoomList channel. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span>
410
449
</td>
412
451
<tr>
413
452
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
414
453
<td>
415
 
<code class="literal">TRUE</code> if a channel request containing RoomList as ChannelType,
 
454
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if a channel request containing RoomList as ChannelType,
416
455
HandleTypeNone as TargetHandleType can be expected to work,
417
 
<code class="literal">FALSE</code> otherwise.</td>
 
456
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise.</td>
418
457
</tr>
419
458
</tbody>
420
459
</table></div>
433
472
<p>
434
473
This can be used by advanced clients to determine whether an unusually
435
474
complex request would succeed. See the Telepathy D-Bus API Specification
436
 
for details of how to interpret the returned <span class="type">GPtrArray</span> of
 
475
for details of how to interpret the returned <a href="http://library.gnome.org/devel/glib/unstable/glib-Pointer-Arrays.html#GPtrArray"><span class="type">GPtrArray</span></a> of
437
476
<a class="link" href="telepathy-glib-gtypes.html#TP-STRUCT-TYPE-REQUESTABLE-CHANNEL-CLASS:CAPS" title="TP_STRUCT_TYPE_REQUESTABLE_CHANNEL_CLASS"><span class="type">TP_STRUCT_TYPE_REQUESTABLE_CHANNEL_CLASS</span></a>.
438
477
</p>
439
478
<p>
445
484
<hr>
446
485
<div class="refsect2">
447
486
<a name="TpCapabilities--contact-specific"></a><h3>The <code class="literal">"contact-specific"</code> property</h3>
448
 
<pre class="programlisting">  "contact-specific"         <span class="type">gboolean</span>              : Read / Write / Construct Only</pre>
 
487
<pre class="programlisting">  "contact-specific"         <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write / Construct Only</pre>
449
488
<p>
450
489
Whether this object accurately describes the capabilities of a particular
451
490
contact, or if it's only a guess based on the capabilities of the
457
496
</div>
458
497
<div class="footer">
459
498
<hr>
460
 
          Generated by GTK-Doc V1.17</div>
 
499
          Generated by GTK-Doc V1.18</div>
461
500
</body>
462
501
</html>
 
 
b'\\ No newline at end of file'