File: telepathy-glib-automatic-proxy-factory.html

package info (click to toggle)
telepathy-glib 0.24.1-1.1
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 34,628 kB
  • ctags: 19,732
  • sloc: ansic: 124,643; xml: 34,410; sh: 11,299; python: 3,520; makefile: 1,727; cpp: 16
file content (211 lines) | stat: -rw-r--r-- 14,219 bytes parent folder | download | duplicates (4)
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
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>TpAutomaticProxyFactory</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.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-basic-proxy-factory.html" title="TpBasicProxyFactory">
<link rel="next" href="telepathy-glib-simple-client-factory.html" title="TpSimpleClientFactory">
<meta name="generator" content="GTK-Doc V1.19 (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-basic-proxy-factory.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-simple-client-factory.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-automatic-proxy-factory.synopsis" class="shortcut">Top</a>
                   | 
                  <a href="#telepathy-glib-automatic-proxy-factory.description" class="shortcut">Description</a>
                   | 
                  <a href="#telepathy-glib-automatic-proxy-factory.object-hierarchy" class="shortcut">Object Hierarchy</a>
                   | 
                  <a href="#telepathy-glib-automatic-proxy-factory.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
</td></tr>
</table>
<div class="refentry">
<a name="telepathy-glib-automatic-proxy-factory"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="telepathy-glib-automatic-proxy-factory.top_of_page"></a>TpAutomaticProxyFactory</span></h2>
<p>TpAutomaticProxyFactory — factory creating higher level proxy objects</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="telepathy-glib-automatic-proxy-factory.synopsis"></a><h2>Synopsis</h2>
<a name="TpAutomaticProxyFactory"></a><pre class="synopsis">
#include &lt;telepathy-glib/telepathy-glib.h&gt;

                    <a class="link" href="telepathy-glib-automatic-proxy-factory.html#TpAutomaticProxyFactory-struct" title="TpAutomaticProxyFactory">TpAutomaticProxyFactory</a>;
struct              <a class="link" href="telepathy-glib-automatic-proxy-factory.html#TpAutomaticProxyFactoryClass" title="struct TpAutomaticProxyFactoryClass">TpAutomaticProxyFactoryClass</a>;
<a class="link" href="telepathy-glib-automatic-proxy-factory.html#TpAutomaticProxyFactory"><span class="returnvalue">TpAutomaticProxyFactory</span></a> * <a class="link" href="telepathy-glib-automatic-proxy-factory.html#tp-automatic-proxy-factory-new" title="tp_automatic_proxy_factory_new ()">tp_automatic_proxy_factory_new</a>
                                                        (<em class="parameter"><code><span class="type">void</span></code></em>);
<a class="link" href="telepathy-glib-automatic-proxy-factory.html#TpAutomaticProxyFactory"><span class="returnvalue">TpAutomaticProxyFactory</span></a> * <a class="link" href="telepathy-glib-automatic-proxy-factory.html#tp-automatic-proxy-factory-dup" title="tp_automatic_proxy_factory_dup ()">tp_automatic_proxy_factory_dup</a>
                                                        (<em class="parameter"><code><span class="type">void</span></code></em>);
</pre>
</div>
<div class="refsect1">
<a name="telepathy-glib-automatic-proxy-factory.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
  <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
   +----TpAutomaticProxyFactory
</pre>
</div>
<div class="refsect1">
<a name="telepathy-glib-automatic-proxy-factory.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
TpAutomaticProxyFactory implements
 <a class="link" href="telepathy-glib-client-channel-factory.html#TpClientChannelFactory">TpClientChannelFactory</a>.</p>
</div>
<div class="refsect1">
<a name="telepathy-glib-automatic-proxy-factory.description"></a><h2>Description</h2>
<p>
This factory implements the <a class="link" href="telepathy-glib-client-channel-factory.html#TpClientChannelFactoryInterface" title="struct TpClientChannelFactoryInterface"><span class="type">TpClientChannelFactoryInterface</span></a> interface to
create specialized <a class="link" href="telepathy-glib-channel.html#TpChannel"><span class="type">TpChannel</span></a> subclasses.
</p>
<p>
<a class="link" href="telepathy-glib-automatic-proxy-factory.html#TpAutomaticProxyFactory"><span class="type">TpAutomaticProxyFactory</span></a> will currently create <a class="link" href="telepathy-glib-channel.html#TpChannel"><span class="type">TpChannel</span></a> objects
as follows:
</p>
<p>
</p>
<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
<li class="listitem"><p>a <a class="link" href="telepathy-glib-stream-tube-channel.html#TpStreamTubeChannel"><span class="type">TpStreamTubeChannel</span></a>, if the channel is of type
    <a class="link" href="telepathy-glib-interfaces.html#TP-IFACE-CHANNEL-TYPE-STREAM-TUBE:CAPS" title="TP_IFACE_CHANNEL_TYPE_STREAM_TUBE"><code class="literal">TP_IFACE_CHANNEL_TYPE_STREAM_TUBE</code></a>;</p></li>
<li class="listitem"><p>a <a class="link" href="telepathy-glib-text-channel.html#TpTextChannel"><span class="type">TpTextChannel</span></a>, if the channel is of type
    <a class="link" href="telepathy-glib-interfaces.html#TP-IFACE-CHANNEL-TYPE-TEXT:CAPS" title="TP_IFACE_CHANNEL_TYPE_TEXT"><code class="literal">TP_IFACE_CHANNEL_TYPE_TEXT</code></a> and implements
    <a class="link" href="telepathy-glib-interfaces.html#TP-IFACE-CHANNEL-INTERFACE-MESSAGES:CAPS" title="TP_IFACE_CHANNEL_INTERFACE_MESSAGES"><code class="literal">TP_IFACE_CHANNEL_INTERFACE_MESSAGES</code></a>;</p></li>
<li class="listitem"><p>a <a class="link" href="telepathy-glib-file-transfer-channel.html#TpFileTransferChannel"><span class="type">TpFileTransferChannel</span></a>, if the channel is of type
    <a class="link" href="telepathy-glib-interfaces.html#TP-IFACE-CHANNEL-TYPE-FILE-TRANSFER:CAPS" title="TP_IFACE_CHANNEL_TYPE_FILE_TRANSFER"><code class="literal">TP_IFACE_CHANNEL_TYPE_FILE_TRANSFER</code></a>;</p></li>
<li class="listitem"><p>a plain <a class="link" href="telepathy-glib-channel.html#TpChannel"><span class="type">TpChannel</span></a>, otherwise</p></li>
</ul></div>
<p>
</p>
<p>
It is guaranteed that the objects returned by future versions
will be either the class that is currently used, or a more specific
subclass of that class.
</p>
<p>
This factory asks to prepare the following properties:
</p>
<p>
</p>
<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
<li class="listitem"><p><a class="link" href="telepathy-glib-channel.html#TP-CHANNEL-FEATURE-CORE:CAPS" title="TP_CHANNEL_FEATURE_CORE"><code class="literal">TP_CHANNEL_FEATURE_CORE</code></a>, <a class="link" href="telepathy-glib-channel.html#TP-CHANNEL-FEATURE-GROUP:CAPS" title="TP_CHANNEL_FEATURE_GROUP"><code class="literal">TP_CHANNEL_FEATURE_GROUP</code></a>
    and <a class="link" href="telepathy-glib-channel.html#TP-CHANNEL-FEATURE-PASSWORD:CAPS" title="TP_CHANNEL_FEATURE_PASSWORD"><code class="literal">TP_CHANNEL_FEATURE_PASSWORD</code></a> for all
    type of channels.</p></li>
<li class="listitem"><p><a class="link" href="telepathy-glib-text-channel.html#TP-TEXT-CHANNEL-FEATURE-INCOMING-MESSAGES:CAPS" title="TP_TEXT_CHANNEL_FEATURE_INCOMING_MESSAGES"><code class="literal">TP_TEXT_CHANNEL_FEATURE_INCOMING_MESSAGES</code></a> and
    TP_TEXT_CHANNEL_FEATURE_SMS for <a class="link" href="telepathy-glib-text-channel.html#TpTextChannel"><span class="type">TpTextChannel</span></a></p></li>
<li class="listitem"><p><a class="link" href="telepathy-glib-file-transfer-channel.html#TP-FILE-TRANSFER-CHANNEL-FEATURE-CORE:CAPS" title="TP_FILE_TRANSFER_CHANNEL_FEATURE_CORE"><code class="literal">TP_FILE_TRANSFER_CHANNEL_FEATURE_CORE</code></a>
    for <a class="link" href="telepathy-glib-file-transfer-channel.html#TpFileTransferChannel"><span class="type">TpFileTransferChannel</span></a></p></li>
</ul></div>
<p>
</p>
<p>
TpProxy subclasses other than TpChannel are not currently supported.
</p>
</div>
<div class="refsect1">
<a name="telepathy-glib-automatic-proxy-factory.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="TpAutomaticProxyFactory-struct"></a><h3>TpAutomaticProxyFactory</h3>
<pre class="programlisting">typedef struct _TpAutomaticProxyFactory TpAutomaticProxyFactory;</pre>
<p>
Data structure representing a <a class="link" href="telepathy-glib-automatic-proxy-factory.html#TpAutomaticProxyFactory"><span class="type">TpAutomaticProxyFactory</span></a>
</p>
<p class="since">Since 0.13.2</p>
</div>
<hr>
<div class="refsect2">
<a name="TpAutomaticProxyFactoryClass"></a><h3>struct TpAutomaticProxyFactoryClass</h3>
<pre class="programlisting">struct TpAutomaticProxyFactoryClass {
    GObjectClass parent_class;
};
</pre>
<p>
The class of a <a class="link" href="telepathy-glib-automatic-proxy-factory.html#TpAutomaticProxyFactory"><span class="type">TpAutomaticProxyFactory</span></a>.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term"><a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObjectClass"><span class="type">GObjectClass</span></a> <em class="structfield"><code><a name="TpAutomaticProxyFactoryClass.parent-class"></a>parent_class</code></em>;</span></p></td>
<td>the parent class</td>
</tr></tbody>
</table></div>
<p class="since">Since 0.13.2</p>
</div>
<hr>
<div class="refsect2">
<a name="tp-automatic-proxy-factory-new"></a><h3>tp_automatic_proxy_factory_new ()</h3>
<pre class="programlisting"><a class="link" href="telepathy-glib-automatic-proxy-factory.html#TpAutomaticProxyFactory"><span class="returnvalue">TpAutomaticProxyFactory</span></a> * tp_automatic_proxy_factory_new
                                                        (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">tp_automatic_proxy_factory_new</code> is deprecated and should not be used in newly-written code. New code should use <a class="link" href="telepathy-glib-automatic-client-factory.html#TpAutomaticClientFactory"><span class="type">TpAutomaticClientFactory</span></a> instead</p>
</div>
<p>
Convenient function to create a new <a class="link" href="telepathy-glib-automatic-proxy-factory.html#TpAutomaticProxyFactory"><span class="type">TpAutomaticProxyFactory</span></a> instance.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a new <a class="link" href="telepathy-glib-automatic-proxy-factory.html#TpAutomaticProxyFactory"><span class="type">TpAutomaticProxyFactory</span></a>
</td>
</tr></tbody>
</table></div>
<p class="since">Since 0.13.2</p>
</div>
<hr>
<div class="refsect2">
<a name="tp-automatic-proxy-factory-dup"></a><h3>tp_automatic_proxy_factory_dup ()</h3>
<pre class="programlisting"><a class="link" href="telepathy-glib-automatic-proxy-factory.html#TpAutomaticProxyFactory"><span class="returnvalue">TpAutomaticProxyFactory</span></a> * tp_automatic_proxy_factory_dup
                                                        (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">tp_automatic_proxy_factory_dup</code> is deprecated and should not be used in newly-written code. New code should use <a class="link" href="telepathy-glib-automatic-client-factory.html#TpAutomaticClientFactory"><span class="type">TpAutomaticClientFactory</span></a> instead</p>
</div>
<p>
Returns a cached <a class="link" href="telepathy-glib-automatic-proxy-factory.html#TpAutomaticProxyFactory"><span class="type">TpAutomaticProxyFactory</span></a>; the same
<a class="link" href="telepathy-glib-automatic-proxy-factory.html#TpAutomaticProxyFactory"><span class="type">TpAutomaticProxyFactory</span></a> object will be returned by this function repeatedly,
as long as at least one reference exists.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a <a class="link" href="telepathy-glib-automatic-proxy-factory.html#TpAutomaticProxyFactory"><span class="type">TpAutomaticProxyFactory</span></a>. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
</td>
</tr></tbody>
</table></div>
<p class="since">Since 0.13.2</p>
</div>
</div>
<div class="refsect1">
<a name="telepathy-glib-automatic-proxy-factory.see-also"></a><h2>See Also</h2>
<a class="link" href="telepathy-glib-basic-proxy-factory.html#TpBasicProxyFactory"><span class="type">TpBasicProxyFactory</span></a>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.19</div>
</body>
</html>