/usr/share/doc/libtelepathy-glib-doc/telepathy-glib/telepathy-glib-connection-addressing.html is in libtelepathy-glib-doc 0.18.0-1ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Connection Addressing interface</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.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-connection-powersaving.html" title="Connection PowerSaving interface">
<link rel="next" href="telepathy-glib-contact-search.html" title="TpContactSearch">
<meta name="generator" content="GTK-Doc V1.18 (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-connection-powersaving.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-contact-search.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-connection-addressing.synopsis" class="shortcut">Top</a>
|
<a href="#telepathy-glib-connection-addressing.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry">
<a name="telepathy-glib-connection-addressing"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="telepathy-glib-connection-addressing.top_of_page"></a>Connection Addressing interface</span></h2>
<p>Connection Addressing interface — client-side wrappers for the Addressing interface</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="telepathy-glib-connection-addressing.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include <telepathy-glib/connection.h>
<a class="link" href="telepathy-glib-proxy.html#TpProxyPendingCall" title="TpProxyPendingCall"><span class="returnvalue">TpProxyPendingCall</span></a> * <a class="link" href="telepathy-glib-connection-addressing.html#tp-cli-connection-interface-addressing-call-get-contacts-by-uri" title="tp_cli_connection_interface_addressing_call_get_contacts_by_uri ()">tp_cli_connection_interface_addressing_call_get_contacts_by_uri</a>
(<em class="parameter"><code><a class="link" href="telepathy-glib-connection.html#TpConnection"><span class="type">TpConnection</span></a> *proxy</code></em>,
<em class="parameter"><code><span class="type">gint</span> timeout_ms</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> **in_URIs</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> **in_Interfaces</code></em>,
<em class="parameter"><code><a class="link" href="telepathy-glib-connection-addressing.html#tp-cli-connection-interface-addressing-callback-for-get-contacts-by-uri" title="tp_cli_connection_interface_addressing_callback_for_get_contacts_by_uri ()"><span class="type">tp_cli_connection_interface_addressing_callback_for_get_contacts_by_uri</span></a> callback</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>,
<em class="parameter"><code><span class="type">GDestroyNotify</span> destroy</code></em>,
<em class="parameter"><code><span class="type">GObject</span> *weak_object</code></em>);
<a class="link" href="telepathy-glib-proxy.html#TpProxyPendingCall" title="TpProxyPendingCall"><span class="returnvalue">TpProxyPendingCall</span></a> * <a class="link" href="telepathy-glib-connection-addressing.html#tp-cli-connection-interface-addressing-call-get-contacts-by-vcard-field" title="tp_cli_connection_interface_addressing_call_get_contacts_by_vcard_field ()">tp_cli_connection_interface_addressing_call_get_contacts_by_vcard_field</a>
(<em class="parameter"><code><a class="link" href="telepathy-glib-connection.html#TpConnection"><span class="type">TpConnection</span></a> *proxy</code></em>,
<em class="parameter"><code><span class="type">gint</span> timeout_ms</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *in_Field</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> **in_Addresses</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> **in_Interfaces</code></em>,
<em class="parameter"><code><a class="link" href="telepathy-glib-connection-addressing.html#tp-cli-connection-interface-addressing-callback-for-get-contacts-by-vcard-field" title="tp_cli_connection_interface_addressing_callback_for_get_contacts_by_vcard_field ()"><span class="type">tp_cli_connection_interface_addressing_callback_for_get_contacts_by_vcard_field</span></a> callback</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>,
<em class="parameter"><code><span class="type">GDestroyNotify</span> destroy</code></em>,
<em class="parameter"><code><span class="type">GObject</span> *weak_object</code></em>);
<span class="returnvalue">void</span> (<a class="link" href="telepathy-glib-connection-addressing.html#tp-cli-connection-interface-addressing-callback-for-get-contacts-by-uri" title="tp_cli_connection_interface_addressing_callback_for_get_contacts_by_uri ()">*tp_cli_connection_interface_addressing_callback_for_get_contacts_by_uri</a>)
(<em class="parameter"><code><a class="link" href="telepathy-glib-connection.html#TpConnection"><span class="type">TpConnection</span></a> *proxy</code></em>,
<em class="parameter"><code><span class="type">GHashTable</span> *out_Requested</code></em>,
<em class="parameter"><code><span class="type">GHashTable</span> *out_Attributes</code></em>,
<em class="parameter"><code>const <span class="type">GError</span> *error</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>,
<em class="parameter"><code><span class="type">GObject</span> *weak_object</code></em>);
<span class="returnvalue">void</span> (<a class="link" href="telepathy-glib-connection-addressing.html#tp-cli-connection-interface-addressing-callback-for-get-contacts-by-vcard-field" title="tp_cli_connection_interface_addressing_callback_for_get_contacts_by_vcard_field ()">*tp_cli_connection_interface_addressing_callback_for_get_contacts_by_vcard_field</a>)
(<em class="parameter"><code><a class="link" href="telepathy-glib-connection.html#TpConnection"><span class="type">TpConnection</span></a> *proxy</code></em>,
<em class="parameter"><code><span class="type">GHashTable</span> *out_Requested</code></em>,
<em class="parameter"><code><span class="type">GHashTable</span> *out_Attributes</code></em>,
<em class="parameter"><code>const <span class="type">GError</span> *error</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>,
<em class="parameter"><code><span class="type">GObject</span> *weak_object</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="telepathy-glib-connection-addressing.description"></a><h2>Description</h2>
<p>
An interface for connections in protocols where contacts' unique
identifiers can be expressed as vCard fields and/or URIs.
</p>
</div>
<div class="refsect1">
<a name="telepathy-glib-connection-addressing.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="tp-cli-connection-interface-addressing-call-get-contacts-by-uri"></a><h3>tp_cli_connection_interface_addressing_call_get_contacts_by_uri ()</h3>
<pre class="programlisting"><a class="link" href="telepathy-glib-proxy.html#TpProxyPendingCall" title="TpProxyPendingCall"><span class="returnvalue">TpProxyPendingCall</span></a> * tp_cli_connection_interface_addressing_call_get_contacts_by_uri
(<em class="parameter"><code><a class="link" href="telepathy-glib-connection.html#TpConnection"><span class="type">TpConnection</span></a> *proxy</code></em>,
<em class="parameter"><code><span class="type">gint</span> timeout_ms</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> **in_URIs</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> **in_Interfaces</code></em>,
<em class="parameter"><code><a class="link" href="telepathy-glib-connection-addressing.html#tp-cli-connection-interface-addressing-callback-for-get-contacts-by-uri" title="tp_cli_connection_interface_addressing_callback_for_get_contacts_by_uri ()"><span class="type">tp_cli_connection_interface_addressing_callback_for_get_contacts_by_uri</span></a> callback</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>,
<em class="parameter"><code><span class="type">GDestroyNotify</span> destroy</code></em>,
<em class="parameter"><code><span class="type">GObject</span> *weak_object</code></em>);</pre>
<p>
Start a GetContactsByURI method call.
</p>
<p>
<tp:docstring xmlns="http://www.w3.org/1999/xhtml"> <p>Request contacts and retrieve their attributes using URI addresses.</p> <p>The connection manager should record that these handles are in use by the client who invokes this method, and must not deallocate the handles until the client disconnects from the bus or calls the <tp:dbus-ref namespace="org.freedesktop.Telepathy">Connection.ReleaseHandles</tp:dbus-ref> method.</p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>proxy</code></em> :</span></p></td>
<td>the <a class="link" href="telepathy-glib-proxy.html#TpProxy"><span class="type">TpProxy</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>timeout_ms</code></em> :</span></p></td>
<td>the timeout in milliseconds, or -1 to use the
default</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>in_URIs</code></em> :</span></p></td>
<td>Used to pass an 'in' argument: The URI addresses to get contact handles for. Supported schemes can be found in <tp:dbus-ref namespace="org.freedesktop.Telepathy.Protocol.Interface.Addressing">AddressableURISchemes</tp:dbus-ref>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>in_Interfaces</code></em> :</span></p></td>
<td>Used to pass an 'in' argument: <tp:docstring xmlns="http://www.w3.org/1999/xhtml"> <p>A list of strings indicating which D-Bus interfaces the calling process is interested in. All supported attributes from these interfaces, whose values can be obtained without additional network activity, will be in the reply.</p> <p>Attributes from this interface and from <tp:dbus-ref>org.freedesktop.Telepathy.Connection</tp:dbus-ref> are always returned, and need not be requested explicitly.</p> <p>The behavior of this parameter is similar to the same parameter in <tp:dbus-ref namespace="org.freedesktop.Telepathy.Connection.Interface">Contacts.GetContactAttributes</tp:dbus-ref>.</p></td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>callback</code></em> :</span></p></td>
<td>called when the method call succeeds or fails;
may be <code class="literal">NULL</code> to make a "fire and forget" call with no
reply tracking</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>user-supplied data passed to the callback;
must be <code class="literal">NULL</code> if <em class="parameter"><code>callback</code></em> is <code class="literal">NULL</code>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>destroy</code></em> :</span></p></td>
<td>called with the user_data as argument, after the
call has succeeded, failed or been cancelled;
must be <code class="literal">NULL</code> if <em class="parameter"><code>callback</code></em> is <code class="literal">NULL</code>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>weak_object</code></em> :</span></p></td>
<td>If not <code class="literal">NULL</code>, a <span class="type">GObject</span> which will be
weakly referenced; if it is destroyed, this call
will automatically be cancelled. Must be <code class="literal">NULL</code> if
<em class="parameter"><code>callback</code></em> is <code class="literal">NULL</code>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a <a class="link" href="telepathy-glib-proxy.html#TpProxyPendingCall" title="TpProxyPendingCall"><span class="type">TpProxyPendingCall</span></a> representing the call in
progress. It is borrowed from the object, and will become
invalid when the callback is called, the call is
cancelled or the <a class="link" href="telepathy-glib-proxy.html#TpProxy"><span class="type">TpProxy</span></a> becomes invalid.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="tp-cli-connection-interface-addressing-call-get-contacts-by-vcard-field"></a><h3>tp_cli_connection_interface_addressing_call_get_contacts_by_vcard_field ()</h3>
<pre class="programlisting"><a class="link" href="telepathy-glib-proxy.html#TpProxyPendingCall" title="TpProxyPendingCall"><span class="returnvalue">TpProxyPendingCall</span></a> * tp_cli_connection_interface_addressing_call_get_contacts_by_vcard_field
(<em class="parameter"><code><a class="link" href="telepathy-glib-connection.html#TpConnection"><span class="type">TpConnection</span></a> *proxy</code></em>,
<em class="parameter"><code><span class="type">gint</span> timeout_ms</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *in_Field</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> **in_Addresses</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> **in_Interfaces</code></em>,
<em class="parameter"><code><a class="link" href="telepathy-glib-connection-addressing.html#tp-cli-connection-interface-addressing-callback-for-get-contacts-by-vcard-field" title="tp_cli_connection_interface_addressing_callback_for_get_contacts_by_vcard_field ()"><span class="type">tp_cli_connection_interface_addressing_callback_for_get_contacts_by_vcard_field</span></a> callback</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>,
<em class="parameter"><code><span class="type">GDestroyNotify</span> destroy</code></em>,
<em class="parameter"><code><span class="type">GObject</span> *weak_object</code></em>);</pre>
<p>
Start a GetContactsByVCardField method call.
</p>
<p>
<tp:docstring xmlns="http://www.w3.org/1999/xhtml"> <p>Request contacts and retrieve their attributes using a given field in their vCards.</p> <p>The connection manager should record that these handles are in use by the client who invokes this method, and must not deallocate the handles until the client disconnects from the bus or calls the <tp:dbus-ref namespace="org.freedesktop.Telepathy">Connection.ReleaseHandles</tp:dbus-ref> method.</p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>proxy</code></em> :</span></p></td>
<td>the <a class="link" href="telepathy-glib-proxy.html#TpProxy"><span class="type">TpProxy</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>timeout_ms</code></em> :</span></p></td>
<td>the timeout in milliseconds, or -1 to use the
default</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>in_Field</code></em> :</span></p></td>
<td>Used to pass an 'in' argument: <tp:docstring xmlns="http://www.w3.org/1999/xhtml"> <p>The vCard field of the addresses we are requesting. The field name SHOULD be in lower case. Supported fields can be found in <tp:dbus-ref namespace="org.freedesktop.Telepathy.Protocol.Interface.Addressing">AddressableVCardFields</tp:dbus-ref>.</p> <p>The <code>url</code> vCard field MUST NOT appear here; see <tp:member-ref>GetContactsByURI</tp:member-ref> instead.</p> <tp:rationale> <p>In practice, protocols have a limited set of URI schemes that make sense to resolve as a contact.</p> </tp:rationale></td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>in_Addresses</code></em> :</span></p></td>
<td>Used to pass an 'in' argument: The addresses to get contact handles for. The address types should match the given vCard field.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>in_Interfaces</code></em> :</span></p></td>
<td>Used to pass an 'in' argument: <tp:docstring xmlns="http://www.w3.org/1999/xhtml"> <p>A list of strings indicating which D-Bus interfaces the calling process is interested in. All supported attributes from these interfaces, whose values can be obtained without additional network activity, will be in the reply.</p> <p>Attributes from this interface and from <tp:dbus-ref>org.freedesktop.Telepathy.Connection</tp:dbus-ref> are always returned, and need not be requested explicitly.</p> <p>The behavior of this parameter is similar to the same parameter in <tp:dbus-ref namespace="org.freedesktop.Telepathy.Connection.Interface">Contacts.GetContactAttributes</tp:dbus-ref>.</p></td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>callback</code></em> :</span></p></td>
<td>called when the method call succeeds or fails;
may be <code class="literal">NULL</code> to make a "fire and forget" call with no
reply tracking</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>user-supplied data passed to the callback;
must be <code class="literal">NULL</code> if <em class="parameter"><code>callback</code></em> is <code class="literal">NULL</code>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>destroy</code></em> :</span></p></td>
<td>called with the user_data as argument, after the
call has succeeded, failed or been cancelled;
must be <code class="literal">NULL</code> if <em class="parameter"><code>callback</code></em> is <code class="literal">NULL</code>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>weak_object</code></em> :</span></p></td>
<td>If not <code class="literal">NULL</code>, a <span class="type">GObject</span> which will be
weakly referenced; if it is destroyed, this call
will automatically be cancelled. Must be <code class="literal">NULL</code> if
<em class="parameter"><code>callback</code></em> is <code class="literal">NULL</code>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a <a class="link" href="telepathy-glib-proxy.html#TpProxyPendingCall" title="TpProxyPendingCall"><span class="type">TpProxyPendingCall</span></a> representing the call in
progress. It is borrowed from the object, and will become
invalid when the callback is called, the call is
cancelled or the <a class="link" href="telepathy-glib-proxy.html#TpProxy"><span class="type">TpProxy</span></a> becomes invalid.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="tp-cli-connection-interface-addressing-callback-for-get-contacts-by-uri"></a><h3>tp_cli_connection_interface_addressing_callback_for_get_contacts_by_uri ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> (*tp_cli_connection_interface_addressing_callback_for_get_contacts_by_uri)
(<em class="parameter"><code><a class="link" href="telepathy-glib-connection.html#TpConnection"><span class="type">TpConnection</span></a> *proxy</code></em>,
<em class="parameter"><code><span class="type">GHashTable</span> *out_Requested</code></em>,
<em class="parameter"><code><span class="type">GHashTable</span> *out_Attributes</code></em>,
<em class="parameter"><code>const <span class="type">GError</span> *error</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>,
<em class="parameter"><code><span class="type">GObject</span> *weak_object</code></em>);</pre>
<p>
Signature of the callback called when a GetContactsByURI method call
succeeds or fails.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>proxy</code></em> :</span></p></td>
<td>the proxy on which the call was made</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>out_Requested</code></em> :</span></p></td>
<td>Used to return an 'out' argument if <em class="parameter"><code>error</code></em> is <code class="literal">NULL</code>: <tp:docstring xmlns="http://www.w3.org/1999/xhtml"> <p>A mapping of requested URIs to the corresponding contact handles.</p> <p>Requested URIs that are not valid or understood for this protocol MUST be omitted from the mapping.</p></td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>out_Attributes</code></em> :</span></p></td>
<td>Used to return an 'out' argument if <em class="parameter"><code>error</code></em> is <code class="literal">NULL</code>: <tp:docstring xmlns="http://www.w3.org/1999/xhtml"> <p>A dictionary mapping the contact handles to contact attributes. If any of the requested addresses are in fact invalid, they are simply omitted from this mapping. If contact attributes are not immediately known, the behaviour is defined by the interface; the attribute should either be omitted from the result or replaced with a default value.</p> <p>Requested URIs that are not valid or understood for this protocol MUST be omitted from the mapping.</p> <p>Each contact's attributes will always include at least the identifier that would be obtained by inspecting the handle (<code>org.freedesktop.Telepathy.Connection/contact-id</code>). </p></td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>
<code class="literal">NULL</code> on success, or an error on failure</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>user-supplied data</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>weak_object</code></em> :</span></p></td>
<td>user-supplied object</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="tp-cli-connection-interface-addressing-callback-for-get-contacts-by-vcard-field"></a><h3>tp_cli_connection_interface_addressing_callback_for_get_contacts_by_vcard_field ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> (*tp_cli_connection_interface_addressing_callback_for_get_contacts_by_vcard_field)
(<em class="parameter"><code><a class="link" href="telepathy-glib-connection.html#TpConnection"><span class="type">TpConnection</span></a> *proxy</code></em>,
<em class="parameter"><code><span class="type">GHashTable</span> *out_Requested</code></em>,
<em class="parameter"><code><span class="type">GHashTable</span> *out_Attributes</code></em>,
<em class="parameter"><code>const <span class="type">GError</span> *error</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>,
<em class="parameter"><code><span class="type">GObject</span> *weak_object</code></em>);</pre>
<p>
Signature of the callback called when a GetContactsByVCardField method call
succeeds or fails.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>proxy</code></em> :</span></p></td>
<td>the proxy on which the call was made</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>out_Requested</code></em> :</span></p></td>
<td>Used to return an 'out' argument if <em class="parameter"><code>error</code></em> is <code class="literal">NULL</code>: <tp:docstring xmlns="http://www.w3.org/1999/xhtml"> <p>A mapping from requested vCard addresses to the corresponding contact handles.</p> <p>Requested addresses that are not valid or understood for this protocol MUST be omitted from the mapping.</p></td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>out_Attributes</code></em> :</span></p></td>
<td>Used to return an 'out' argument if <em class="parameter"><code>error</code></em> is <code class="literal">NULL</code>: <tp:docstring xmlns="http://www.w3.org/1999/xhtml"> <p>A dictionary mapping the contact handles to contact attributes. If any of the requested addresses are in fact invalid, they are simply omitted from this mapping. If contact attributes are not immediately known, the behaviour is defined by the interface; the attribute should either be omitted from the result or replaced with a default value.</p> <p>Requested addresses that are not valid or understood for this protocol MUST be omitted from the mapping.</p> <p>Each contact's attributes will always include at least the identifier that would be obtained by inspecting the handle (<code>org.freedesktop.Telepathy.Connection/contact-id</code>). </p></td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>
<code class="literal">NULL</code> on success, or an error on failure</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>user-supplied data</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>weak_object</code></em> :</span></p></td>
<td>user-supplied object</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1">
<a name="telepathy-glib-connection-addressing.see-also"></a><h2>See Also</h2>
<a class="link" href="telepathy-glib-connection.html#TpConnection"><span class="type">TpConnection</span></a>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.18</div>
</body>
</html>
|