~tiagosh/telepathy-qt/group-chat2

« back to all changes in this revision

Viewing changes to doc/html/a00134.html

  • Committer: Package Import Robot
  • Author(s): Ricardo Salveti de Araujo
  • Date: 2013-06-06 04:56:14 UTC
  • Revision ID: package-import@ubuntu.com-20130606045614-inpxexo6765rnmp1
Tags: upstream-0.9.3
ImportĀ upstreamĀ versionĀ 0.9.3

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
<?xml version="1.0" encoding="iso-8859-1"?>
 
2
<!DOCTYPE html
 
3
    PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "DTD/xhtml1-strict.dtd">
 
4
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
 
5
<head>
 
6
  <title>Tp::Client::ChannelInterfaceSMSInterface Class Reference</title>
 
7
  <link href="doxygen.css" rel="stylesheet" type="text/css" />
 
8
</head>
 
9
<body>
 
10
<table border="0" cellpadding="0" cellspacing="0" width="100%">
 
11
<tr>
 
12
<td width="1">&nbsp;&nbsp;</td>
 
13
<td class="postheader" valign="center">
 
14
<a href="index.html">
 
15
<font color="#004faf">Home</font></a>&nbsp;&middot;
 
16
<a href="classes.html">
 
17
<font color="#004faf">All Classes</font></a>&nbsp;&middot;
 
18
<a href="namespaces.html">
 
19
<font color="#004faf">All Namespaces</font></a>&nbsp;&middot;
 
20
<a href="modules.html">
 
21
<font color="#004faf">Modules</font></a>&nbsp;&middot;
 
22
<a href="functions.html">
 
23
<font color="#004faf">Functions</font></a>&nbsp;&middot;
 
24
<a href="files.html">
 
25
<font color="#004faf">Files</font></a>
 
26
</td>
 
27
</tr>
 
28
</table>
 
29
<!-- Generated by Doxygen 1.7.6.1 -->
 
30
  <div id="nav-path" class="navpath">
 
31
    <ul>
 
32
      <li class="navelem"><a class="el" href="a00724.html">Tp</a>      </li>
 
33
      <li class="navelem"><a class="el" href="a00728.html">Client</a>      </li>
 
34
      <li class="navelem"><a class="el" href="a00134.html">ChannelInterfaceSMSInterface</a>      </li>
 
35
    </ul>
 
36
  </div>
 
37
</div>
 
38
<div class="header">
 
39
  <div class="summary">
 
40
<a href="#pub-slots">Public Slots</a> &#124;
 
41
<a href="#signals">Signals</a> &#124;
 
42
<a href="#pub-methods">Public Member Functions</a> &#124;
 
43
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
 
44
<a href="#pro-methods">Protected Member Functions</a>  </div>
 
45
  <div class="headertitle">
 
46
<div class="title">Tp::Client::ChannelInterfaceSMSInterface Class Reference<div class="ingroups"><a class="el" href="a00739.html">Channel proxies</a></div></div>  </div>
 
47
</div><!--header-->
 
48
<div class="contents">
 
49
<!-- doxytag: class="Tp::Client::ChannelInterfaceSMSInterface" --><!-- doxytag: inherits="Tp::AbstractInterface" -->
 
50
<p><code>#include &lt;<a class="el" href="a00502_source.html">TelepathyQt/Channel</a>&gt;</code></p>
 
51
 
 
52
<p>Inherits <a class="el" href="a00037.html">Tp::AbstractInterface</a>.</p>
 
53
 
 
54
<p><a href="a01096.html">List of all members.</a></p>
 
55
<h2><a name="pub-slots"></a>
 
56
Public Slots</h2>
 
57
<ul>
 
58
<li>QDBusPendingReply&lt; uint, int, int &gt; <a class="el" href="a00134.html#a25ca310de9dd4b8b5f4bd301e1d7e486">GetSMSLength</a> (const <a class="el" href="a00761.html#gad29671d375c7a5bf1e8228f609b0d828">Tp::MessagePartList</a> &amp;message, int timeout=-1)
 
59
</ul>
 
60
<h2><a name="signals"></a>
 
61
Signals</h2>
 
62
<ul>
 
63
<li>void <a class="el" href="a00134.html#a44a6a31763a5b5a28fcd4f87ae336265">SMSChannelChanged</a> (bool SMSChannel)
 
64
</ul>
 
65
<h2><a name="pub-methods"></a>
 
66
Public Member Functions</h2>
 
67
<ul>
 
68
<li><a class="el" href="a00134.html#a0963567595da8466f4465a74252468e1">ChannelInterfaceSMSInterface</a> (const QString &amp;busName, const QString &amp;objectPath, QObject *parent=0)
 
69
<li><a class="el" href="a00134.html#a31251dbe46c1c44dbb1d7ba56b892773">ChannelInterfaceSMSInterface</a> (const QDBusConnection &amp;connection, const QString &amp;busName, const QString &amp;objectPath, QObject *parent=0)
 
70
<li><a class="el" href="a00134.html#ae4c10b0c7b205032a5aa5e071a40eea6">ChannelInterfaceSMSInterface</a> (<a class="el" href="a00216.html">Tp::DBusProxy</a> *proxy)
 
71
<li><a class="el" href="a00134.html#a3a19a0190339a05da0cc1d3c2dd88c8f">ChannelInterfaceSMSInterface</a> (const <a class="el" href="a00117.html">Tp::Client::ChannelInterface</a> &amp;mainInterface)
 
72
<li><a class="el" href="a00134.html#ad90f19f83c3774f703daaf80c7f6e571">ChannelInterfaceSMSInterface</a> (const <a class="el" href="a00117.html">Tp::Client::ChannelInterface</a> &amp;mainInterface, QObject *parent)
 
73
<li><a class="el" href="a00329.html">Tp::PendingVariant</a> * <a class="el" href="a00134.html#a01085f8a670bd4dee774b0409a00af2b">requestPropertyFlash</a> () const 
 
74
<li><a class="el" href="a00329.html">Tp::PendingVariant</a> * <a class="el" href="a00134.html#a3701fe3db530a59dc25ce790cd8dfbf0">requestPropertySMSChannel</a> () const 
 
75
<li><a class="el" href="a00330.html">Tp::PendingVariantMap</a> * <a class="el" href="a00134.html#ab4e879b9ec2423bc01fa5c7edccef3cb">requestAllProperties</a> () const 
 
76
</ul>
 
77
<h2><a name="pub-static-methods"></a>
 
78
Static Public Member Functions</h2>
 
79
<ul>
 
80
<li>static QLatin1String <a class="el" href="a00134.html#a6aaf11f1282007dfe112373a4415f718">staticInterfaceName</a> ()
 
81
</ul>
 
82
<h2><a name="pro-methods"></a>
 
83
Protected Member Functions</h2>
 
84
<ul>
 
85
<li>virtual void <a class="el" href="a00134.html#a051ffa99b47faa6678ca7316f07f4399">invalidate</a> (<a class="el" href="a00216.html">Tp::DBusProxy</a> *, const QString &amp;, const QString &amp;)
 
86
</ul>
 
87
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
 
88
<div class="textblock"><p>Proxy class providing a 1:1 mapping of the D-Bus interface "org.freedesktop.Telepathy.Channel.Interface.SMS". </p>
 
89
</div><hr/><h2>Constructor &amp; Destructor Documentation</h2>
 
90
<a class="anchor" id="a0963567595da8466f4465a74252468e1"></a><!-- doxytag: member="Tp::Client::ChannelInterfaceSMSInterface::ChannelInterfaceSMSInterface" ref="a0963567595da8466f4465a74252468e1" args="(const QString &amp;busName, const QString &amp;objectPath, QObject *parent=0)" -->
 
91
<div class="memitem">
 
92
<div class="memproto">
 
93
      <table class="memname">
 
94
        <tr>
 
95
          <td class="memname"><a class="el" href="a00134.html#a0963567595da8466f4465a74252468e1">Tp::Client::ChannelInterfaceSMSInterface::ChannelInterfaceSMSInterface</a> </td>
 
96
          <td>(</td>
 
97
          <td class="paramtype">const QString &amp;&#160;</td>
 
98
          <td class="paramname"><em>busName</em>, </td>
 
99
        </tr>
 
100
        <tr>
 
101
          <td class="paramkey"></td>
 
102
          <td></td>
 
103
          <td class="paramtype">const QString &amp;&#160;</td>
 
104
          <td class="paramname"><em>objectPath</em>, </td>
 
105
        </tr>
 
106
        <tr>
 
107
          <td class="paramkey"></td>
 
108
          <td></td>
 
109
          <td class="paramtype">QObject *&#160;</td>
 
110
          <td class="paramname"><em>parent</em> = <code>0</code>&#160;</td>
 
111
        </tr>
 
112
        <tr>
 
113
          <td></td>
 
114
          <td>)</td>
 
115
          <td></td><td></td>
 
116
        </tr>
 
117
      </table>
 
118
</div>
 
119
<div class="memdoc">
 
120
<p>Creates a <a class="el" href="a00134.html">ChannelInterfaceSMSInterface</a> associated with the given object on the session bus.</p>
 
121
<dl class="params"><dt><b>Parameters:</b></dt><dd>
 
122
  <table class="params">
 
123
    <tr><td class="paramname">busName</td><td>Name of the service the object is on. </td></tr>
 
124
    <tr><td class="paramname">objectPath</td><td>Path to the object on the service. </td></tr>
 
125
    <tr><td class="paramname">parent</td><td>Passed to the parent class constructor. </td></tr>
 
126
  </table>
 
127
  </dd>
 
128
</dl>
 
129
 
 
130
</div>
 
131
</div>
 
132
<a class="anchor" id="a31251dbe46c1c44dbb1d7ba56b892773"></a><!-- doxytag: member="Tp::Client::ChannelInterfaceSMSInterface::ChannelInterfaceSMSInterface" ref="a31251dbe46c1c44dbb1d7ba56b892773" args="(const QDBusConnection &amp;connection, const QString &amp;busName, const QString &amp;objectPath, QObject *parent=0)" -->
 
133
<div class="memitem">
 
134
<div class="memproto">
 
135
      <table class="memname">
 
136
        <tr>
 
137
          <td class="memname"><a class="el" href="a00134.html#a0963567595da8466f4465a74252468e1">Tp::Client::ChannelInterfaceSMSInterface::ChannelInterfaceSMSInterface</a> </td>
 
138
          <td>(</td>
 
139
          <td class="paramtype">const QDBusConnection &amp;&#160;</td>
 
140
          <td class="paramname"><em>connection</em>, </td>
 
141
        </tr>
 
142
        <tr>
 
143
          <td class="paramkey"></td>
 
144
          <td></td>
 
145
          <td class="paramtype">const QString &amp;&#160;</td>
 
146
          <td class="paramname"><em>busName</em>, </td>
 
147
        </tr>
 
148
        <tr>
 
149
          <td class="paramkey"></td>
 
150
          <td></td>
 
151
          <td class="paramtype">const QString &amp;&#160;</td>
 
152
          <td class="paramname"><em>objectPath</em>, </td>
 
153
        </tr>
 
154
        <tr>
 
155
          <td class="paramkey"></td>
 
156
          <td></td>
 
157
          <td class="paramtype">QObject *&#160;</td>
 
158
          <td class="paramname"><em>parent</em> = <code>0</code>&#160;</td>
 
159
        </tr>
 
160
        <tr>
 
161
          <td></td>
 
162
          <td>)</td>
 
163
          <td></td><td></td>
 
164
        </tr>
 
165
      </table>
 
166
</div>
 
167
<div class="memdoc">
 
168
<p>Creates a <a class="el" href="a00134.html">ChannelInterfaceSMSInterface</a> associated with the given object on the given bus.</p>
 
169
<dl class="params"><dt><b>Parameters:</b></dt><dd>
 
170
  <table class="params">
 
171
    <tr><td class="paramname">connection</td><td>The bus via which the object can be reached. </td></tr>
 
172
    <tr><td class="paramname">busName</td><td>Name of the service the object is on. </td></tr>
 
173
    <tr><td class="paramname">objectPath</td><td>Path to the object on the service. </td></tr>
 
174
    <tr><td class="paramname">parent</td><td>Passed to the parent class constructor. </td></tr>
 
175
  </table>
 
176
  </dd>
 
177
</dl>
 
178
 
 
179
</div>
 
180
</div>
 
181
<a class="anchor" id="ae4c10b0c7b205032a5aa5e071a40eea6"></a><!-- doxytag: member="Tp::Client::ChannelInterfaceSMSInterface::ChannelInterfaceSMSInterface" ref="ae4c10b0c7b205032a5aa5e071a40eea6" args="(Tp::DBusProxy *proxy)" -->
 
182
<div class="memitem">
 
183
<div class="memproto">
 
184
      <table class="memname">
 
185
        <tr>
 
186
          <td class="memname"><a class="el" href="a00134.html#a0963567595da8466f4465a74252468e1">Tp::Client::ChannelInterfaceSMSInterface::ChannelInterfaceSMSInterface</a> </td>
 
187
          <td>(</td>
 
188
          <td class="paramtype"><a class="el" href="a00216.html">Tp::DBusProxy</a> *&#160;</td>
 
189
          <td class="paramname"><em>proxy</em></td><td>)</td>
 
190
          <td></td>
 
191
        </tr>
 
192
      </table>
 
193
</div>
 
194
<div class="memdoc">
 
195
<p>Creates a <a class="el" href="a00134.html">ChannelInterfaceSMSInterface</a> associated with the same object as the given proxy.</p>
 
196
<dl class="params"><dt><b>Parameters:</b></dt><dd>
 
197
  <table class="params">
 
198
    <tr><td class="paramname">proxy</td><td>The proxy to use. It will also be the QObject::parent() for this object. </td></tr>
 
199
  </table>
 
200
  </dd>
 
201
</dl>
 
202
 
 
203
</div>
 
204
</div>
 
205
<a class="anchor" id="a3a19a0190339a05da0cc1d3c2dd88c8f"></a><!-- doxytag: member="Tp::Client::ChannelInterfaceSMSInterface::ChannelInterfaceSMSInterface" ref="a3a19a0190339a05da0cc1d3c2dd88c8f" args="(const Tp::Client::ChannelInterface &amp;mainInterface)" -->
 
206
<div class="memitem">
 
207
<div class="memproto">
 
208
      <table class="memname">
 
209
        <tr>
 
210
          <td class="memname"><a class="el" href="a00134.html#a0963567595da8466f4465a74252468e1">Tp::Client::ChannelInterfaceSMSInterface::ChannelInterfaceSMSInterface</a> </td>
 
211
          <td>(</td>
 
212
          <td class="paramtype">const <a class="el" href="a00117.html">Tp::Client::ChannelInterface</a> &amp;&#160;</td>
 
213
          <td class="paramname"><em>mainInterface</em></td><td>)</td>
 
214
          <td><code> [explicit]</code></td>
 
215
        </tr>
 
216
      </table>
 
217
</div>
 
218
<div class="memdoc">
 
219
<p>Creates a <a class="el" href="a00134.html">ChannelInterfaceSMSInterface</a> associated with the same object as the given proxy. Additionally, the created proxy will have the same parent as the given proxy.</p>
 
220
<dl class="params"><dt><b>Parameters:</b></dt><dd>
 
221
  <table class="params">
 
222
    <tr><td class="paramname">mainInterface</td><td>The proxy to use. </td></tr>
 
223
  </table>
 
224
  </dd>
 
225
</dl>
 
226
 
 
227
</div>
 
228
</div>
 
229
<a class="anchor" id="ad90f19f83c3774f703daaf80c7f6e571"></a><!-- doxytag: member="Tp::Client::ChannelInterfaceSMSInterface::ChannelInterfaceSMSInterface" ref="ad90f19f83c3774f703daaf80c7f6e571" args="(const Tp::Client::ChannelInterface &amp;mainInterface, QObject *parent)" -->
 
230
<div class="memitem">
 
231
<div class="memproto">
 
232
      <table class="memname">
 
233
        <tr>
 
234
          <td class="memname"><a class="el" href="a00134.html#a0963567595da8466f4465a74252468e1">Tp::Client::ChannelInterfaceSMSInterface::ChannelInterfaceSMSInterface</a> </td>
 
235
          <td>(</td>
 
236
          <td class="paramtype">const <a class="el" href="a00117.html">Tp::Client::ChannelInterface</a> &amp;&#160;</td>
 
237
          <td class="paramname"><em>mainInterface</em>, </td>
 
238
        </tr>
 
239
        <tr>
 
240
          <td class="paramkey"></td>
 
241
          <td></td>
 
242
          <td class="paramtype">QObject *&#160;</td>
 
243
          <td class="paramname"><em>parent</em>&#160;</td>
 
244
        </tr>
 
245
        <tr>
 
246
          <td></td>
 
247
          <td>)</td>
 
248
          <td></td><td></td>
 
249
        </tr>
 
250
      </table>
 
251
</div>
 
252
<div class="memdoc">
 
253
<p>Creates a <a class="el" href="a00134.html">ChannelInterfaceSMSInterface</a> associated with the same object as the given proxy. However, a different parent object can be specified.</p>
 
254
<dl class="params"><dt><b>Parameters:</b></dt><dd>
 
255
  <table class="params">
 
256
    <tr><td class="paramname">mainInterface</td><td>The proxy to use. </td></tr>
 
257
    <tr><td class="paramname">parent</td><td>Passed to the parent class constructor. </td></tr>
 
258
  </table>
 
259
  </dd>
 
260
</dl>
 
261
 
 
262
</div>
 
263
</div>
 
264
<hr/><h2>Member Function Documentation</h2>
 
265
<a class="anchor" id="a6aaf11f1282007dfe112373a4415f718"></a><!-- doxytag: member="Tp::Client::ChannelInterfaceSMSInterface::staticInterfaceName" ref="a6aaf11f1282007dfe112373a4415f718" args="()" -->
 
266
<div class="memitem">
 
267
<div class="memproto">
 
268
      <table class="memname">
 
269
        <tr>
 
270
          <td class="memname">static QLatin1String <a class="el" href="a00134.html#a6aaf11f1282007dfe112373a4415f718">Tp::Client::ChannelInterfaceSMSInterface::staticInterfaceName</a> </td>
 
271
          <td>(</td>
 
272
          <td class="paramname"></td><td>)</td>
 
273
          <td><code> [inline, static]</code></td>
 
274
        </tr>
 
275
      </table>
 
276
</div>
 
277
<div class="memdoc">
 
278
<p>Returns the name of the interface "org.freedesktop.Telepathy.Channel.Interface.SMS", which this class represents.</p>
 
279
<dl class="return"><dt><b>Returns:</b></dt><dd>The D-Bus interface name. </dd></dl>
 
280
 
 
281
</div>
 
282
</div>
 
283
<a class="anchor" id="a01085f8a670bd4dee774b0409a00af2b"></a><!-- doxytag: member="Tp::Client::ChannelInterfaceSMSInterface::requestPropertyFlash" ref="a01085f8a670bd4dee774b0409a00af2b" args="() const " -->
 
284
<div class="memitem">
 
285
<div class="memproto">
 
286
      <table class="memname">
 
287
        <tr>
 
288
          <td class="memname"><a class="el" href="a00329.html">Tp::PendingVariant</a>* <a class="el" href="a00134.html#a01085f8a670bd4dee774b0409a00af2b">Tp::Client::ChannelInterfaceSMSInterface::requestPropertyFlash</a> </td>
 
289
          <td>(</td>
 
290
          <td class="paramname"></td><td>)</td>
 
291
          <td> const<code> [inline]</code></td>
 
292
        </tr>
 
293
      </table>
 
294
</div>
 
295
<div class="memdoc">
 
296
<p>Asynchronous getter for the remote object property <code>Flash</code> of type <code>bool</code>.</p>
 
297
 
 
298
 <p>If <code>True</code>, then this channel is exclusively for
 
299
   receiving class 0 SMSes (and no SMSes can be sent using   <a class="el" href="a00129.html#a2322168c5097082626ce8e18e19df608">ChannelInterfaceMessagesInterface::SendMessage()</a>  
 
300
   on this channel). If <code>False</code>, no incoming class 0 SMSes
 
301
   will appear on this channel.</p>
 
302
 
 
303
 <p>This property is immutable (cannot change), and therefore SHOULD
 
304
   appear wherever immutable properties are reported, e.g.   <a class="el" href="a00183.html#aa9fda39dba52244626a87535073b85bd">ConnectionInterfaceRequestsInterface::NewChannels()</a>  signals.</p>
 
305
 
 
306
 <div class="rationale">
 
307
   <p>Class 0 SMSes should be displayed immediately to the user, and
 
308
     need not be saved to the device memory unless the user explicitly
 
309
     chooses to do so. This is unlike ā€œnormalā€, class 1 SMSes, which
 
310
     must be stored, but need not be shown immediately in their entirity
 
311
     to the user.</p>
 
312
 
 
313
   <p>Separating class 0 SMSes into their own channel with this
 
314
     immutable property allows them to be dispatched to a different
 
315
       <a class="el" href="a00154.html">ClientHandlerInterface</a>  ā€”which
 
316
     would include this property in its   <a class="el" href="a00154.html#a03b88e295fd2eda13a74ca563ef3a612">ClientHandlerInterface::HandlerChannelFilter </a>  ā€”avoiding the normal Text
 
317
     channel handler having to decide for each message whether it should
 
318
     be displayed to the user immediately or handled normally.</p>
 
319
 
 
320
   <p>Currently, no mechanism is defined for <em>sending</em> class 0
 
321
     SMSes. It seems reasonable to support specifying the class of an
 
322
     outgoing SMS in its header <tp:type>Message_Part</tp:type>, rather
 
323
     than requiring the UI to request a special channel for such SMSes;
 
324
     hence, we define here that channels with Flash set to
 
325
     <code>True</code> are read-only.</p>
 
326
 </div>
 
327
 <dl class="return"><dt><b>Returns:</b></dt><dd>A pending variant which will emit finished when the property has been retrieved. </dd></dl>
 
328
 
 
329
</div>
 
330
</div>
 
331
<a class="anchor" id="a3701fe3db530a59dc25ce790cd8dfbf0"></a><!-- doxytag: member="Tp::Client::ChannelInterfaceSMSInterface::requestPropertySMSChannel" ref="a3701fe3db530a59dc25ce790cd8dfbf0" args="() const " -->
 
332
<div class="memitem">
 
333
<div class="memproto">
 
334
      <table class="memname">
 
335
        <tr>
 
336
          <td class="memname"><a class="el" href="a00329.html">Tp::PendingVariant</a>* <a class="el" href="a00134.html#a3701fe3db530a59dc25ce790cd8dfbf0">Tp::Client::ChannelInterfaceSMSInterface::requestPropertySMSChannel</a> </td>
 
337
          <td>(</td>
 
338
          <td class="paramname"></td><td>)</td>
 
339
          <td> const<code> [inline]</code></td>
 
340
        </tr>
 
341
      </table>
 
342
</div>
 
343
<div class="memdoc">
 
344
<p>Asynchronous getter for the remote object property <code>SMSChannel</code> of type <code>bool</code>.</p>
 
345
 
 
346
         <p>If TRUE, messages sent and received on this channel are transmitted
 
347
           via SMS.</p>
 
348
 
 
349
         <p>If this property is included in the channel request, the
 
350
           Connection Manager MUST return an appropriate channel (i.e. if TRUE
 
351
           the channel must be for SMSes, if FALSE it must not), or else fail
 
352
           to provide the requested channel with the
 
353
           <tp:error-ref>NotCapable</tp:error-ref>
 
354
           error.</p>
 
355
 
 
356
         <p>For example, to explicitly request an SMS channel to a contact.
 
357
           You might construct a channel request like:</p>
 
358
 
 
359
         <blockquote><pre>{
 
360
   Channel.Type: Channel.Type.Text,
 
361
   Channel.TargetHandleType: Handle_Type_Contact,
 
362
   Channel.TargetID: escher.cat,
 
363
   Channel.Interface.SMS.SMSChannel: True,
 
364
 }</pre></blockquote>
 
365
 
 
366
         <div class="rationale">
 
367
           Some protocols allow us to send SMSes to a remote contact, without
 
368
           knowing the phone number to which those SMSes will be sent. This
 
369
           provides a mechanism to request such channels.
 
370
         </div>
 
371
 
 
372
         <p>If this property is not included in the channel request, the
 
373
           Connection Manager MAY return an SMS channel if that is the most
 
374
           appropriate medium (i.e. if the channel target is a phone
 
375
           number).</p>
 
376
 
 
377
         <div class="rationale">
 
378
           To some types of identifiers (i.e. phone numbers) it only makes
 
379
           sense to return an SMS channel, this is what happens currently with
 
380
           telepathy-ring. We don't want to break this behaviour when we are
 
381
           not explicit about the type of channel we want. Alternatively, for
 
382
           protocols where there is an SMS fallback for IM messages, it's
 
383
           possible that we don't care what sort of channel we get, and simply
 
384
           want notification of the transport.
 
385
         </div>
 
386
 
 
387
         <p>Some protocols have a fallback to deliver IM messages via SMS.
 
388
           On these protocols, the Connection Manager SHOULD set the property
 
389
           value as appropriate, and notify its change with
 
390
             <a class="el" href="a00134.html#a44a6a31763a5b5a28fcd4f87ae336265">SMSChannelChanged()</a>  .</p>
 
391
 
 
392
         <div class="rationale">
 
393
           Protocols such as MSN can fall back to delivering IM messages via
 
394
           SMS. Where possible we want clients to be able to inform the user
 
395
           that their messages are going to be redirected to the remote
 
396
           contact's phone.
 
397
         </div>
 
398
 <dl class="return"><dt><b>Returns:</b></dt><dd>A pending variant which will emit finished when the property has been retrieved. </dd></dl>
 
399
 
 
400
</div>
 
401
</div>
 
402
<a class="anchor" id="ab4e879b9ec2423bc01fa5c7edccef3cb"></a><!-- doxytag: member="Tp::Client::ChannelInterfaceSMSInterface::requestAllProperties" ref="ab4e879b9ec2423bc01fa5c7edccef3cb" args="() const " -->
 
403
<div class="memitem">
 
404
<div class="memproto">
 
405
      <table class="memname">
 
406
        <tr>
 
407
          <td class="memname"><a class="el" href="a00330.html">Tp::PendingVariantMap</a>* <a class="el" href="a00134.html#ab4e879b9ec2423bc01fa5c7edccef3cb">Tp::Client::ChannelInterfaceSMSInterface::requestAllProperties</a> </td>
 
408
          <td>(</td>
 
409
          <td class="paramname"></td><td>)</td>
 
410
          <td> const<code> [inline]</code></td>
 
411
        </tr>
 
412
      </table>
 
413
</div>
 
414
<div class="memdoc">
 
415
<p>Request all of the <a class="el" href="a00729.html">DBus</a> properties on the interface.</p>
 
416
<dl class="return"><dt><b>Returns:</b></dt><dd>A pending variant map which will emit finished when the properties have been retrieved. </dd></dl>
 
417
 
 
418
</div>
 
419
</div>
 
420
<a class="anchor" id="a25ca310de9dd4b8b5f4bd301e1d7e486"></a><!-- doxytag: member="Tp::Client::ChannelInterfaceSMSInterface::GetSMSLength" ref="a25ca310de9dd4b8b5f4bd301e1d7e486" args="(const Tp::MessagePartList &amp;message, int timeout=&#45;1)" -->
 
421
<div class="memitem">
 
422
<div class="memproto">
 
423
      <table class="memname">
 
424
        <tr>
 
425
          <td class="memname">QDBusPendingReply&lt;uint, int, int&gt; <a class="el" href="a00134.html#a25ca310de9dd4b8b5f4bd301e1d7e486">Tp::Client::ChannelInterfaceSMSInterface::GetSMSLength</a> </td>
 
426
          <td>(</td>
 
427
          <td class="paramtype">const <a class="el" href="a00761.html#gad29671d375c7a5bf1e8228f609b0d828">Tp::MessagePartList</a> &amp;&#160;</td>
 
428
          <td class="paramname"><em>message</em>, </td>
 
429
        </tr>
 
430
        <tr>
 
431
          <td class="paramkey"></td>
 
432
          <td></td>
 
433
          <td class="paramtype">int&#160;</td>
 
434
          <td class="paramname"><em>timeout</em> = <code>-1</code>&#160;</td>
 
435
        </tr>
 
436
        <tr>
 
437
          <td></td>
 
438
          <td>)</td>
 
439
          <td></td><td><code> [inline, slot]</code></td>
 
440
        </tr>
 
441
      </table>
 
442
</div>
 
443
<div class="memdoc">
 
444
<p>Begins a call to the D-Bus method <code>GetSMSLength</code> on the remote object.</p>
 
445
 
 
446
 <p>Returns the number of 140 octet chunks required to send a message
 
447
   via SMS, as well as the number of remaining characters available in
 
448
   the final chunk and, if possible, an estimate of the cost.</p>
 
449
 
 
450
 <div class="rationale">
 
451
   <p>There are a number of different SMS encoding mechanisms, and the
 
452
     client doesn't know which mechanisms an individual CM might support.
 
453
     This method allows the client, without any knowledge of the
 
454
     encoding mechanism, to provide length details to the user.</p>
 
455
 </div>
 
456
 
 
457
 <p>Clients SHOULD limit the frequency with which this method is called
 
458
 and SHOULD NOT call it for every keystroke. Clients MAY estimate the
 
459
 remaining size between single keystrokes.</p>
 
460
 <p>Note that <em>timeout</em> is ignored as of now. It will be used once <a href="http://bugreports.qt.nokia.com/browse/QTBUG-11775">http://bugreports.qt.nokia.com/browse/QTBUG-11775</a> is fixed.</p>
 
461
<dl class="params"><dt><b>Parameters:</b></dt><dd>
 
462
  <table class="params">
 
463
    <tr><td class="paramname">message</td><td>The message the user wishes to send. </td></tr>
 
464
    <tr><td class="paramname">timeout</td><td>The timeout in milliseconds.</td></tr>
 
465
  </table>
 
466
  </dd>
 
467
</dl>
 
468
<dl class="return"><dt><b>Returns:</b></dt><dd></dd></dl>
 
469
 
 
470
     <p>The number of 140 octet chunks required to send this message.</p>
 
471
     
 
472
     <p>For example, in the GSM standard 7-bit encoding, a 162 character
 
473
       message would require 2 chunks.</p>
 
474
     <dl class="return"><dt><b>Returns:</b></dt><dd></dd></dl>
 
475
 
 
476
     <p>The number of further characters that can be fit in the final
 
477
       chunk. A negative value indicates that the message will be
 
478
       truncated by <code>abs(Remaining_Characters)</code>. The value
 
479
       <code>MIN_INT32</code> (<code>-2<sup>31</sup></code>)
 
480
       indicates the message will be truncated by an unknown amount.</p>
 
481
     
 
482
     <p>For example, in the GSM standard 7-bit encoding, a 162 character
 
483
       message would return 144 remaining characters (because of the
 
484
       space required for the multipart SMS header).</p>
 
485
     <dl class="return"><dt><b>Returns:</b></dt><dd></dd></dl>
 
486
 
 
487
     <p>The estimated cost of sending this message. The currency and
 
488
       scale of this value are the same as the
 
489
         <a class="el" href="a00169.html#a1857446a85b9180abddfeea462f2789b">ConnectionInterfaceBalanceInterface::AccountBalance </a>  
 
490
       property.</p>
 
491
     
 
492
     <p>A value of <code>-1</code> indicates the cost could not be
 
493
       estimated.</p>
 
494
      
 
495
</div>
 
496
</div>
 
497
<a class="anchor" id="a44a6a31763a5b5a28fcd4f87ae336265"></a><!-- doxytag: member="Tp::Client::ChannelInterfaceSMSInterface::SMSChannelChanged" ref="a44a6a31763a5b5a28fcd4f87ae336265" args="(bool SMSChannel)" -->
 
498
<div class="memitem">
 
499
<div class="memproto">
 
500
      <table class="memname">
 
501
        <tr>
 
502
          <td class="memname">void <a class="el" href="a00134.html#a44a6a31763a5b5a28fcd4f87ae336265">Tp::Client::ChannelInterfaceSMSInterface::SMSChannelChanged</a> </td>
 
503
          <td>(</td>
 
504
          <td class="paramtype">bool&#160;</td>
 
505
          <td class="paramname"><em>SMSChannel</em></td><td>)</td>
 
506
          <td><code> [signal]</code></td>
 
507
        </tr>
 
508
      </table>
 
509
</div>
 
510
<div class="memdoc">
 
511
<p>Represents the signal <code>SMSChannelChanged</code> on the remote object.</p>
 
512
<p>This signal indicates a change in the SMSChannel property.</p>
 
513
<dl class="params"><dt><b>Parameters:</b></dt><dd>
 
514
  <table class="params">
 
515
    <tr><td class="paramname">SMSChannel</td><td>The new value for SMSChannel. </td></tr>
 
516
  </table>
 
517
  </dd>
 
518
</dl>
 
519
 
 
520
</div>
 
521
</div>
 
522
<a class="anchor" id="a051ffa99b47faa6678ca7316f07f4399"></a><!-- doxytag: member="Tp::Client::ChannelInterfaceSMSInterface::invalidate" ref="a051ffa99b47faa6678ca7316f07f4399" args="(Tp::DBusProxy *, const QString &amp;, const QString &amp;)" -->
 
523
<div class="memitem">
 
524
<div class="memproto">
 
525
      <table class="memname">
 
526
        <tr>
 
527
          <td class="memname">void <a class="el" href="a00134.html#a051ffa99b47faa6678ca7316f07f4399">Tp::Client::ChannelInterfaceSMSInterface::invalidate</a> </td>
 
528
          <td>(</td>
 
529
          <td class="paramtype"><a class="el" href="a00216.html">Tp::DBusProxy</a> *&#160;</td>
 
530
          <td class="paramname"><em>proxy</em>, </td>
 
531
        </tr>
 
532
        <tr>
 
533
          <td class="paramkey"></td>
 
534
          <td></td>
 
535
          <td class="paramtype">const QString &amp;&#160;</td>
 
536
          <td class="paramname"><em>error</em>, </td>
 
537
        </tr>
 
538
        <tr>
 
539
          <td class="paramkey"></td>
 
540
          <td></td>
 
541
          <td class="paramtype">const QString &amp;&#160;</td>
 
542
          <td class="paramname"><em>message</em>&#160;</td>
 
543
        </tr>
 
544
        <tr>
 
545
          <td></td>
 
546
          <td>)</td>
 
547
          <td></td><td><code> [protected, virtual]</code></td>
 
548
        </tr>
 
549
      </table>
 
550
</div>
 
551
<div class="memdoc">
 
552
 
 
553
<p>Reimplemented from <a class="el" href="a00037.html#a79dde56ba44455f47c7c354ada07467a">Tp::AbstractInterface</a>.</p>
 
554
 
 
555
</div>
 
556
</div>
 
557
</div><!-- contents -->
 
558
<p /><address><hr /><div align="center">
 
559
<table width="100%" cellspacing="0" border="0"><tr class="address">
 
560
<td width="30%">Copyright &copy; 2008-2011 Collabora Ltd. and Nokia Corporation</td>
 
561
<td width="30%" align="right"><div align="right">Telepathy-Qt 0.9.3</div></td>
 
562
</tr></table></div></address>
 
563
</body>
 
564
</html>