~ubuntu-branches/ubuntu/utopic/telepathy-glib/utopic

« back to all changes in this revision

Viewing changes to docs/reference/html/telepathy-glib-connection-sidecars.html

  • Committer: Package Import Robot
  • Author(s): Simon McVittie
  • Date: 2014-09-16 15:49:50 UTC
  • mfrom: (60.1.5 sid)
  • Revision ID: package-import@ubuntu.com-20140916154950-krvowuvofhu8u6sp
Tags: 0.24.1-1
* New upstream stable release
* debian/copyright: clean up syntax (*.[ch] is unsupported),
  drop deleted files
* debian/watch: only match 0.x versions, 1.0 will be a separate
  source package

Show diffs side-by-side

added added

removed removed

Lines of Context:
2
2
<html>
3
3
<head>
4
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5
 
<title>telepathy-glib API Reference Manual: Connection Sidecars interface</title>
 
5
<title>Connection Sidecars interface</title>
6
6
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
7
7
<link rel="home" href="index.html" title="telepathy-glib API Reference Manual">
8
8
<link rel="up" href="ch-client.html" title="Client-side proxies">
9
9
<link rel="prev" href="telepathy-glib-connection-renaming.html" title="Connection Renaming interface">
10
10
<link rel="next" href="telepathy-glib-contact-search.html" title="TpContactSearch">
11
 
<meta name="generator" content="GTK-Doc V1.20 (XML mode)">
 
11
<meta name="generator" content="GTK-Doc V1.19 (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">
15
 
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="10"><tr valign="middle">
16
 
<td width="100%" align="left" class="shortcuts">
17
 
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span> 
18
 
                  <a href="#telepathy-glib-connection-sidecars.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> 
19
 
                  <a href="#telepathy-glib-connection-sidecars.object-hierarchy" class="shortcut">Object Hierarchy</a></span>
20
 
</td>
21
 
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
22
 
<td><a accesskey="u" href="ch-client.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
23
 
<td><a accesskey="p" href="telepathy-glib-connection-renaming.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
24
 
<td><a accesskey="n" href="telepathy-glib-contact-search.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
25
 
</tr></table>
 
15
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
 
16
<tr valign="middle">
 
17
<td><a accesskey="p" href="telepathy-glib-connection-renaming.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
 
18
<td><a accesskey="u" href="ch-client.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
 
19
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
 
20
<th width="100%" align="center">telepathy-glib API Reference Manual</th>
 
21
<td><a accesskey="n" href="telepathy-glib-contact-search.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
 
22
</tr>
 
23
<tr><td colspan="5" class="shortcuts">
 
24
<a href="#telepathy-glib-connection-sidecars.synopsis" class="shortcut">Top</a>
 
25
                   | 
 
26
                  <a href="#telepathy-glib-connection-sidecars.description" class="shortcut">Description</a>
 
27
</td></tr>
 
28
</table>
26
29
<div class="refentry">
27
30
<a name="telepathy-glib-connection-sidecars"></a><div class="titlepage"></div>
28
31
<div class="refnamediv"><table width="100%"><tr>
30
33
<h2><span class="refentrytitle"><a name="telepathy-glib-connection-sidecars.top_of_page"></a>Connection Sidecars interface</span></h2>
31
34
<p>Connection Sidecars interface — client-side wrappers for the Sidecars interface</p>
32
35
</td>
33
 
<td class="gallery_image" valign="top" align="right"></td>
 
36
<td valign="top" align="right"></td>
34
37
</tr></table></div>
35
 
<div class="refsect1">
36
 
<a name="telepathy-glib-connection-sidecars.functions"></a><h2>Functions</h2>
37
 
<div class="informaltable"><table width="100%" border="0">
38
 
<colgroup>
39
 
<col width="150px" class="functions_return">
40
 
<col class="functions_name">
41
 
</colgroup>
42
 
<tbody>
43
 
<tr>
44
 
<td class="function_type">
45
 
<a class="link" href="telepathy-glib-proxy.html#TpProxyPendingCall" title="TpProxyPendingCall"><span class="returnvalue">TpProxyPendingCall</span></a> *
46
 
</td>
47
 
<td class="function_name">
48
 
<a class="link" href="telepathy-glib-connection-sidecars.html#tp-cli-connection-interface-sidecars1-call-ensure-sidecar" title="tp_cli_connection_interface_sidecars1_call_ensure_sidecar ()">tp_cli_connection_interface_sidecars1_call_ensure_sidecar</a> <span class="c_punctuation">()</span>
49
 
</td>
50
 
</tr>
51
 
<tr>
52
 
<td class="function_type">
53
 
<span class="returnvalue">void</span>
54
 
</td>
55
 
<td class="function_name">
56
 
<span class="c_punctuation">(</span><a class="link" href="telepathy-glib-connection-sidecars.html#tp-cli-connection-interface-sidecars1-callback-for-ensure-sidecar" title="tp_cli_connection_interface_sidecars1_callback_for_ensure_sidecar ()">*tp_cli_connection_interface_sidecars1_callback_for_ensure_sidecar</a><span class="c_punctuation">)</span> <span class="c_punctuation">()</span>
57
 
</td>
58
 
</tr>
59
 
</tbody>
60
 
</table></div>
61
 
</div>
62
 
<div class="refsect1">
63
 
<a name="telepathy-glib-connection-sidecars.object-hierarchy"></a><h2>Object Hierarchy</h2>
64
 
<pre class="screen">
65
 
</pre>
66
 
</div>
67
 
<div class="refsect1">
68
 
<a name="telepathy-glib-connection-sidecars.includes"></a><h2>Includes</h2>
69
 
<pre class="synopsis">#include &lt;telepathy-glib/telepathy-glib-dbus.h&gt;
 
38
<div class="refsynopsisdiv">
 
39
<a name="telepathy-glib-connection-sidecars.synopsis"></a><h2>Synopsis</h2>
 
40
<pre class="synopsis">
 
41
#include &lt;telepathy-glib/telepathy-glib-dbus.h&gt;
 
42
 
 
43
<a class="link" href="telepathy-glib-proxy.html#TpProxyPendingCall" title="TpProxyPendingCall"><span class="returnvalue">TpProxyPendingCall</span></a> * <a class="link" href="telepathy-glib-connection-sidecars.html#tp-cli-connection-interface-sidecars1-call-ensure-sidecar" title="tp_cli_connection_interface_sidecars1_call_ensure_sidecar ()">tp_cli_connection_interface_sidecars1_call_ensure_sidecar</a>
 
44
                                                        (<em class="parameter"><code><a class="link" href="telepathy-glib-connection.html#TpConnection"><span class="type">TpConnection</span></a> *proxy</code></em>,
 
45
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> timeout_ms</code></em>,
 
46
                                                         <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> *in_Main_Interface</code></em>,
 
47
                                                         <em class="parameter"><code><a class="link" href="telepathy-glib-connection-sidecars.html#tp-cli-connection-interface-sidecars1-callback-for-ensure-sidecar" title="tp_cli_connection_interface_sidecars1_callback_for_ensure_sidecar ()"><span class="type">tp_cli_connection_interface_sidecars1_callback_for_ensure_sidecar</span></a> callback</code></em>,
 
48
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>,
 
49
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Datasets.html#GDestroyNotify"><span class="type">GDestroyNotify</span></a> destroy</code></em>,
 
50
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a> *weak_object</code></em>);
 
51
<span class="returnvalue">void</span>                (<a class="link" href="telepathy-glib-connection-sidecars.html#tp-cli-connection-interface-sidecars1-callback-for-ensure-sidecar" title="tp_cli_connection_interface_sidecars1_callback_for_ensure_sidecar ()">*tp_cli_connection_interface_sidecars1_callback_for_ensure_sidecar</a>)
 
52
                                                        (<em class="parameter"><code><a class="link" href="telepathy-glib-connection.html#TpConnection"><span class="type">TpConnection</span></a> *proxy</code></em>,
 
53
                                                         <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> *out_Path</code></em>,
 
54
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Hash-Tables.html#GHashTable"><span class="type">GHashTable</span></a> *out_Properties</code></em>,
 
55
                                                         <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>,
 
56
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>,
 
57
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a> *weak_object</code></em>);
70
58
</pre>
71
59
</div>
72
60
<div class="refsect1">
73
61
<a name="telepathy-glib-connection-sidecars.description"></a><h2>Description</h2>
74
 
<p>Some Telepathy connection managers have a plugin API, with plugins
 
62
<p>
 
63
Some Telepathy connection managers have a plugin API, with plugins
75
64
providing plugin-specific channel types and other D-Bus APIs. It is
76
65
technically difficult for plugins to add interfaces analogous to Aliasing,
77
66
Avatars etc. to a Connection. The Sidecars1 interface provides an
78
 
alternative, by attaching plugin-provided interfaces to a secondary object.</p>
 
67
alternative, by attaching plugin-provided interfaces to a secondary object.
 
68
</p>
79
69
</div>
80
70
<div class="refsect1">
81
 
<a name="telepathy-glib-connection-sidecars.functions_details"></a><h2>Functions</h2>
 
71
<a name="telepathy-glib-connection-sidecars.details"></a><h2>Details</h2>
82
72
<div class="refsect2">
83
 
<a name="tp-cli-connection-interface-sidecars1-call-ensure-sidecar"></a><h3>tp_cli_connection_interface_sidecars1_call_ensure_sidecar ()</h3>
84
 
<pre class="programlisting"><a class="link" href="telepathy-glib-proxy.html#TpProxyPendingCall" title="TpProxyPendingCall"><span class="returnvalue">TpProxyPendingCall</span></a> *
85
 
tp_cli_connection_interface_sidecars1_call_ensure_sidecar
86
 
                               (<em class="parameter"><code><a class="link" href="telepathy-glib-connection.html#TpConnection"><span class="type">TpConnection</span></a> *proxy</code></em>,
87
 
                                <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> timeout_ms</code></em>,
88
 
                                <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> *in_Main_Interface</code></em>,
89
 
                                <em class="parameter"><code><a class="link" href="telepathy-glib-connection-sidecars.html#tp-cli-connection-interface-sidecars1-callback-for-ensure-sidecar" title="tp_cli_connection_interface_sidecars1_callback_for_ensure_sidecar ()"><span class="type">tp_cli_connection_interface_sidecars1_callback_for_ensure_sidecar</span></a> callback</code></em>,
90
 
                                <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>,
91
 
                                <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Datasets.html#GDestroyNotify"><span class="type">GDestroyNotify</span></a> destroy</code></em>,
92
 
                                <em class="parameter"><code><a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a> *weak_object</code></em>);</pre>
93
 
<p>Start a EnsureSidecar method call.</p>
94
 
<p>&lt;tp:docstring xmlns="http://www.w3.org/1999/xhtml"&gt;         &lt;p&gt;Request an object with a particular interface providing additional           connection-specific functionality, together with its immutable           properties. These will often be implemented by plug-ins to the           connection managers; for example, support for an XMPP XEP for which           no generic Telepathy interface exists might be implemented by a           Gabble plugin exposing a sidecar with a particular interface.&lt;/p&gt;          &lt;p&gt;This method may be called at any point during the lifetime of a           connection, even before its &lt;tp:type&gt;Connection_Status&lt;/tp:type&gt;           changes to Connected. It MAY take a long time to           return—perhaps it needs to wait for a connection to be established           and for all the services supported by the server to be discovered           before determining whether necessary server-side support is           available—so callers SHOULD override the default method timeout (25           seconds) with a much higher value (perhaps even MAX_INT32, meaning           “no timeout” in recent versions of libdbus).&lt;/p&gt;          &lt;tp:rationale&gt;           &lt;p&gt;There is an implicit assumption that any connection             manager plugin will only want to export one “primary” object per             feature it implements, since there is a one-to-one mapping between             interface and object. This is reasonable since Sidecars are             (intended to be) analogous to extra interfaces on the connection,             providing once-per-connection shared functionality; it also makes             client code straightforward (look up the interface you care about             in a dictionary, build a proxy object from the value). More             “plural” plugins are likely to want to implement new types of             &lt;tp:dbus-ref namespace="org.freedesktop.Telepathy"&gt;Channel&lt;/tp:dbus-ref&gt;             instead.&lt;/p&gt;         &lt;/tp:rationale&gt;</p>
95
 
<div class="refsect3">
96
 
<a name="id-1.4.24.7.2.6"></a><h4>Parameters</h4>
97
 
<div class="informaltable"><table width="100%" border="0">
 
73
<a name="tp-cli-connection-interface-sidecars1-call-ensure-sidecar"></a><h3>tp_cli_connection_interface_sidecars1_call_ensure_sidecar ()</h3>
 
74
<pre class="programlisting"><a class="link" href="telepathy-glib-proxy.html#TpProxyPendingCall" title="TpProxyPendingCall"><span class="returnvalue">TpProxyPendingCall</span></a> * tp_cli_connection_interface_sidecars1_call_ensure_sidecar
 
75
                                                        (<em class="parameter"><code><a class="link" href="telepathy-glib-connection.html#TpConnection"><span class="type">TpConnection</span></a> *proxy</code></em>,
 
76
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> timeout_ms</code></em>,
 
77
                                                         <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> *in_Main_Interface</code></em>,
 
78
                                                         <em class="parameter"><code><a class="link" href="telepathy-glib-connection-sidecars.html#tp-cli-connection-interface-sidecars1-callback-for-ensure-sidecar" title="tp_cli_connection_interface_sidecars1_callback_for_ensure_sidecar ()"><span class="type">tp_cli_connection_interface_sidecars1_callback_for_ensure_sidecar</span></a> callback</code></em>,
 
79
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>,
 
80
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Datasets.html#GDestroyNotify"><span class="type">GDestroyNotify</span></a> destroy</code></em>,
 
81
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a> *weak_object</code></em>);</pre>
 
82
<p>
 
83
Start a EnsureSidecar method call.
 
84
</p>
 
85
<p>
 
86
&lt;tp:docstring xmlns="http://www.w3.org/1999/xhtml"&gt;         &lt;p&gt;Request an object with a particular interface providing additional           connection-specific functionality, together with its immutable           properties. These will often be implemented by plug-ins to the           connection managers; for example, support for an XMPP XEP for which           no generic Telepathy interface exists might be implemented by a           Gabble plugin exposing a sidecar with a particular interface.&lt;/p&gt;          &lt;p&gt;This method may be called at any point during the lifetime of a           connection, even before its &lt;tp:type&gt;Connection_Status&lt;/tp:type&gt;           changes to Connected. It MAY take a long time to           return—perhaps it needs to wait for a connection to be established           and for all the services supported by the server to be discovered           before determining whether necessary server-side support is           available—so callers SHOULD override the default method timeout (25           seconds) with a much higher value (perhaps even MAX_INT32, meaning           “no timeout” in recent versions of libdbus).&lt;/p&gt;          &lt;tp:rationale&gt;           &lt;p&gt;There is an implicit assumption that any connection             manager plugin will only want to export one “primary” object per             feature it implements, since there is a one-to-one mapping between             interface and object. This is reasonable since Sidecars are             (intended to be) analogous to extra interfaces on the connection,             providing once-per-connection shared functionality; it also makes             client code straightforward (look up the interface you care about             in a dictionary, build a proxy object from the value). More             “plural” plugins are likely to want to implement new types of             &lt;tp:dbus-ref namespace="org.freedesktop.Telepathy"&gt;Channel&lt;/tp:dbus-ref&gt;             instead.&lt;/p&gt;         &lt;/tp:rationale&gt;
 
87
</p>
 
88
<div class="variablelist"><table border="0" class="variablelist">
98
89
<colgroup>
99
 
<col width="150px" class="parameters_name">
100
 
<col class="parameters_description">
101
 
<col width="200px" class="parameters_annotations">
 
90
<col align="left" valign="top">
 
91
<col>
102
92
</colgroup>
103
93
<tbody>
104
94
<tr>
105
 
<td class="parameter_name"><p>proxy</p></td>
106
 
<td class="parameter_description"><p>the <a class="link" href="telepathy-glib-proxy.html#TpProxy"><span class="type">TpProxy</span></a></p></td>
107
 
<td class="parameter_annotations"> </td>
108
 
</tr>
109
 
<tr>
110
 
<td class="parameter_name"><p>timeout_ms</p></td>
111
 
<td class="parameter_description"><p>the timeout in milliseconds, or -1 to use the
112
 
default</p></td>
113
 
<td class="parameter_annotations"> </td>
114
 
</tr>
115
 
<tr>
116
 
<td class="parameter_name"><p>in_Main_Interface</p></td>
117
 
<td class="parameter_description"><p>Used to pass an 'in' argument: The &amp;quot;primary&amp;quot; interface implemented by an object attached           to a connection. For example, a Gabble plugin implementing           fine-grained control of XEP-0016 privacy lists might expose an object           implementing &lt;tt&gt;com.example.PrivacyLists&lt;/tt&gt;.</p></td>
118
 
<td class="parameter_annotations"> </td>
119
 
</tr>
120
 
<tr>
121
 
<td class="parameter_name"><p>callback</p></td>
122
 
<td class="parameter_description"><p>called when the method call succeeds or fails;
 
95
<td><p><span class="term"><em class="parameter"><code>proxy</code></em> :</span></p></td>
 
96
<td>the <a class="link" href="telepathy-glib-proxy.html#TpProxy"><span class="type">TpProxy</span></a>
 
97
</td>
 
98
</tr>
 
99
<tr>
 
100
<td><p><span class="term"><em class="parameter"><code>timeout_ms</code></em> :</span></p></td>
 
101
<td>the timeout in milliseconds, or -1 to use the
 
102
default</td>
 
103
</tr>
 
104
<tr>
 
105
<td><p><span class="term"><em class="parameter"><code>in_Main_Interface</code></em> :</span></p></td>
 
106
<td>Used to pass an 'in' argument: The &amp;quot;primary&amp;quot; interface implemented by an object attached           to a connection. For example, a Gabble plugin implementing           fine-grained control of XEP-0016 privacy lists might expose an object           implementing &lt;tt&gt;com.example.PrivacyLists&lt;/tt&gt;.</td>
 
107
</tr>
 
108
<tr>
 
109
<td><p><span class="term"><em class="parameter"><code>callback</code></em> :</span></p></td>
 
110
<td>called when the method call succeeds or fails;
123
111
may be <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to make a "fire and forget" call with no
124
 
reply tracking</p></td>
125
 
<td class="parameter_annotations"> </td>
126
 
</tr>
127
 
<tr>
128
 
<td class="parameter_name"><p>user_data</p></td>
129
 
<td class="parameter_description"><p>user-supplied data passed to the callback;
130
 
must be <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if <em class="parameter"><code>callback</code></em>
131
 
is <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a></p></td>
132
 
<td class="parameter_annotations"> </td>
133
 
</tr>
134
 
<tr>
135
 
<td class="parameter_name"><p>destroy</p></td>
136
 
<td class="parameter_description"><p>called with the user_data as argument, after the
 
112
reply tracking</td>
 
113
</tr>
 
114
<tr>
 
115
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
 
116
<td>user-supplied data passed to the callback;
 
117
must be <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if <em class="parameter"><code>callback</code></em> is <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
 
118
</td>
 
119
</tr>
 
120
<tr>
 
121
<td><p><span class="term"><em class="parameter"><code>destroy</code></em> :</span></p></td>
 
122
<td>called with the user_data as argument, after the
137
123
call has succeeded, failed or been cancelled;
138
 
must be <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if <em class="parameter"><code>callback</code></em>
139
 
is <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a></p></td>
140
 
<td class="parameter_annotations"> </td>
 
124
must be <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if <em class="parameter"><code>callback</code></em> is <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
 
125
</td>
141
126
</tr>
142
127
<tr>
143
 
<td class="parameter_name"><p>weak_object</p></td>
144
 
<td class="parameter_description"><p>If not <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, a <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a> which will be
 
128
<td><p><span class="term"><em class="parameter"><code>weak_object</code></em> :</span></p></td>
 
129
<td>If not <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, a <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a> which will be
145
130
weakly referenced; if it is destroyed, this call
146
131
will automatically be cancelled. Must be <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if
147
 
<em class="parameter"><code>callback</code></em>
148
 
is <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a></p></td>
149
 
<td class="parameter_annotations"> </td>
 
132
<em class="parameter"><code>callback</code></em> is <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
 
133
</td>
150
134
</tr>
151
 
</tbody>
152
 
</table></div>
153
 
</div>
154
 
<div class="refsect3">
155
 
<a name="id-1.4.24.7.2.7"></a><h4>Returns</h4>
156
 
<p> a <a class="link" href="telepathy-glib-proxy.html#TpProxyPendingCall" title="TpProxyPendingCall"><span class="type">TpProxyPendingCall</span></a> representing the call in
 
135
<tr>
 
136
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
137
<td>a <a class="link" href="telepathy-glib-proxy.html#TpProxyPendingCall" title="TpProxyPendingCall"><span class="type">TpProxyPendingCall</span></a> representing the call in
157
138
progress. It is borrowed from the object, and will become
158
139
invalid when the callback is called, the call is
159
 
cancelled or the <a class="link" href="telepathy-glib-proxy.html#TpProxy"><span class="type">TpProxy</span></a> becomes invalid.</p>
160
 
<p></p>
161
 
</div>
 
140
cancelled or the <a class="link" href="telepathy-glib-proxy.html#TpProxy"><span class="type">TpProxy</span></a> becomes invalid.</td>
 
141
</tr>
 
142
</tbody>
 
143
</table></div>
162
144
</div>
163
145
<hr>
164
146
<div class="refsect2">
165
 
<a name="tp-cli-connection-interface-sidecars1-callback-for-ensure-sidecar"></a><h3>tp_cli_connection_interface_sidecars1_callback_for_ensure_sidecar ()</h3>
166
 
<pre class="programlisting"><span class="returnvalue">void</span>
167
 
<span class="c_punctuation">(</span>*tp_cli_connection_interface_sidecars1_callback_for_ensure_sidecar<span class="c_punctuation">)</span>
168
 
                               (<em class="parameter"><code><a class="link" href="telepathy-glib-connection.html#TpConnection"><span class="type">TpConnection</span></a> *proxy</code></em>,
169
 
                                <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> *out_Path</code></em>,
170
 
                                <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Hash-Tables.html#GHashTable"><span class="type">GHashTable</span></a> *out_Properties</code></em>,
171
 
                                <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>,
172
 
                                <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>,
173
 
                                <em class="parameter"><code><a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a> *weak_object</code></em>);</pre>
174
 
<p>Signature of the callback called when a EnsureSidecar method call
175
 
succeeds or fails.</p>
176
 
<div class="refsect3">
177
 
<a name="id-1.4.24.7.3.5"></a><h4>Parameters</h4>
178
 
<div class="informaltable"><table width="100%" border="0">
 
147
<a name="tp-cli-connection-interface-sidecars1-callback-for-ensure-sidecar"></a><h3>tp_cli_connection_interface_sidecars1_callback_for_ensure_sidecar ()</h3>
 
148
<pre class="programlisting"><span class="returnvalue">void</span>                (*tp_cli_connection_interface_sidecars1_callback_for_ensure_sidecar)
 
149
                                                        (<em class="parameter"><code><a class="link" href="telepathy-glib-connection.html#TpConnection"><span class="type">TpConnection</span></a> *proxy</code></em>,
 
150
                                                         <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> *out_Path</code></em>,
 
151
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Hash-Tables.html#GHashTable"><span class="type">GHashTable</span></a> *out_Properties</code></em>,
 
152
                                                         <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>,
 
153
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>,
 
154
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a> *weak_object</code></em>);</pre>
 
155
<p>
 
156
Signature of the callback called when a EnsureSidecar method call
 
157
succeeds or fails.
 
158
</p>
 
159
<div class="variablelist"><table border="0" class="variablelist">
179
160
<colgroup>
180
 
<col width="150px" class="parameters_name">
181
 
<col class="parameters_description">
182
 
<col width="200px" class="parameters_annotations">
 
161
<col align="left" valign="top">
 
162
<col>
183
163
</colgroup>
184
164
<tbody>
185
165
<tr>
186
 
<td class="parameter_name"><p>proxy</p></td>
187
 
<td class="parameter_description"><p>the proxy on which the call was made</p></td>
188
 
<td class="parameter_annotations"> </td>
189
 
</tr>
190
 
<tr>
191
 
<td class="parameter_name"><p>out_Path</p></td>
192
 
<td class="parameter_description"><p>Used to return an 'out' argument if <em class="parameter"><code>error</code></em>
193
 
is <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>: The object path of the sidecar, exported by the same bus           name as the Connection to which it is attached.</p></td>
194
 
<td class="parameter_annotations"> </td>
195
 
</tr>
196
 
<tr>
197
 
<td class="parameter_name"><p>out_Properties</p></td>
198
 
<td class="parameter_description"><p>Used to return an 'out' argument if <em class="parameter"><code>error</code></em>
199
 
is <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>: Immutable properties of the sidecar.</p></td>
200
 
<td class="parameter_annotations"> </td>
201
 
</tr>
202
 
<tr>
203
 
<td class="parameter_name"><p>error</p></td>
204
 
<td class="parameter_description"><p><a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> on success, or an error on failure</p></td>
205
 
<td class="parameter_annotations"> </td>
206
 
</tr>
207
 
<tr>
208
 
<td class="parameter_name"><p>user_data</p></td>
209
 
<td class="parameter_description"><p>user-supplied data</p></td>
210
 
<td class="parameter_annotations"> </td>
211
 
</tr>
212
 
<tr>
213
 
<td class="parameter_name"><p>weak_object</p></td>
214
 
<td class="parameter_description"><p>user-supplied object</p></td>
215
 
<td class="parameter_annotations"> </td>
 
166
<td><p><span class="term"><em class="parameter"><code>proxy</code></em> :</span></p></td>
 
167
<td>the proxy on which the call was made</td>
 
168
</tr>
 
169
<tr>
 
170
<td><p><span class="term"><em class="parameter"><code>out_Path</code></em> :</span></p></td>
 
171
<td>Used to return an 'out' argument if <em class="parameter"><code>error</code></em> is <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>: The object path of the sidecar, exported by the same bus           name as the Connection to which it is attached.</td>
 
172
</tr>
 
173
<tr>
 
174
<td><p><span class="term"><em class="parameter"><code>out_Properties</code></em> :</span></p></td>
 
175
<td>Used to return an 'out' argument if <em class="parameter"><code>error</code></em> is <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>: Immutable properties of the sidecar.</td>
 
176
</tr>
 
177
<tr>
 
178
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
 
179
<td>
 
180
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> on success, or an error on failure</td>
 
181
</tr>
 
182
<tr>
 
183
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
 
184
<td>user-supplied data</td>
 
185
</tr>
 
186
<tr>
 
187
<td><p><span class="term"><em class="parameter"><code>weak_object</code></em> :</span></p></td>
 
188
<td>user-supplied object</td>
216
189
</tr>
217
190
</tbody>
218
191
</table></div>
219
192
</div>
220
193
</div>
221
 
</div>
222
 
<div class="refsect1">
223
 
<a name="telepathy-glib-connection-sidecars.other_details"></a><h2>Types and Values</h2>
224
 
</div>
225
194
<div class="refsect1">
226
195
<a name="telepathy-glib-connection-sidecars.see-also"></a><h2>See Also</h2>
227
 
<p><a class="link" href="telepathy-glib-connection.html#TpConnection"><span class="type">TpConnection</span></a></p>
 
196
<a class="link" href="telepathy-glib-connection.html#TpConnection"><span class="type">TpConnection</span></a>
228
197
</div>
229
198
</div>
230
199
<div class="footer">
231
200
<hr>
232
 
          Generated by GTK-Doc V1.20</div>
 
201
          Generated by GTK-Doc V1.19</div>
233
202
</body>
234
203
</html>
 
 
b'\\ No newline at end of file'