diff options
author | Guillaume Desmottes <guillaume.desmottes@collabora.co.uk> | 2011-05-09 15:18:40 +0200 |
---|---|---|
committer | Guillaume Desmottes <guillaume.desmottes@collabora.co.uk> | 2011-05-09 16:04:16 +0200 |
commit | 9354c13814bb18f1a7b414360310d196a0cbbfc7 (patch) | |
tree | 17c415c36eea0382431df0684e7dcefdf2803197 /spec/Channel_Interface_SMS.xml | |
parent | 3d327b76fc2c1bf2b1553dc295a8c77ee900250d (diff) | |
download | telepathy-glib-9354c13814bb18f1a7b414360310d196a0cbbfc7.tar.gz |
update to spec 0.23.1
Generate API for:
- Channel.Interface.SMS.GetSMSLength()
- ChannelDispatcher.DelegateChannels()
- ChannelDispatcher.PresentChannel()
Diffstat (limited to 'spec/Channel_Interface_SMS.xml')
-rw-r--r-- | spec/Channel_Interface_SMS.xml | 78 |
1 files changed, 78 insertions, 0 deletions
diff --git a/spec/Channel_Interface_SMS.xml b/spec/Channel_Interface_SMS.xml index 235046c36..480a2a77c 100644 --- a/spec/Channel_Interface_SMS.xml +++ b/spec/Channel_Interface_SMS.xml @@ -205,5 +205,83 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. <tp:member-ref>SMSChannel</tp:member-ref> property. </tp:docstring> </signal> + + <method name="GetSMSLength" + tp:name-for-bindings="Get_SMS_Length"> + <tp:added version="0.23.1"/> + + <tp:docstring xmlns="http://www.w3.org/1999/xhtml"> + <p>Returns the number of 140 octet chunks required to send a message + via SMS, as well as the number of remaining characters available in + the final chunk and, if possible, an estimate of the cost.</p> + + <tp:rationale> + <p>There are a number of different SMS encoding mechanisms, and the + client doesn't know which mechanisms an individual CM might support. + This method allows the client, without any knowledge of the + encoding mechanism, to provide length details to the user.</p> + </tp:rationale> + + <p>Clients SHOULD limit the frequency with which this method is called + and SHOULD NOT call it for every keystroke. Clients MAY estimate the + remaining size between single keystrokes.</p> + </tp:docstring> + + <arg name="Message" type="aa{sv}" tp:type="Message_Part[]" direction="in"> + <tp:docstring> + The message the user wishes to send. + </tp:docstring> + </arg> + + <arg name="Chunks_Required" type="u" direction="out"> + <tp:docstring xmlns="http://www.w3.org/1999/xhtml"> + <p>The number of 140 octet chunks required to send this message.</p> + + <p>For example, in the GSM standard 7-bit encoding, a 162 character + message would require 2 chunks.</p> + </tp:docstring> + </arg> + + <arg name="Remaining_Characters" type="i" direction="out"> + <tp:docstring xmlns="http://www.w3.org/1999/xhtml"> + <p>The number of further characters that can be fit in the final + chunk. A negative value indicates that the message will be + truncated by <code>abs(Remaining_Characters)</code>. The value + <code>MIN_INT32</code> (<code>-2<sup>31</sup></code>) + indicates the message will be truncated by an unknown amount.</p> + + <p>For example, in the GSM standard 7-bit encoding, a 162 character + message would return 144 remaining characters (because of the + space required for the multipart SMS header).</p> + </tp:docstring> + </arg> + + <arg name="Estimated_Cost" type="i" direction="out"> + <tp:docstring xmlns="http://www.w3.org/1999/xhtml"> + <p>The estimated cost of sending this message. The currency and + scale of this value are the same as the + <tp:dbus-ref namespace="ofdT.Connection.Interface">Balance.AccountBalance</tp:dbus-ref> + property.</p> + + <p>A value of <code>-1</code> indicates the cost could not be + estimated.</p> + + </tp:docstring> + </arg> + + <tp:possible-errors> + <tp:error name="org.freedesktop.Telepathy.Error.NotImplemented"> + <tp:docstring> + Raised when the method is not available on this channel. + Clients MAY choose to make their own estimation. + </tp:docstring> + </tp:error> + <tp:error name="org.freedesktop.Telepathy.Error.InvalidArgument"> + <tp:docstring> + Raised when the content cannot be encoded into a valid SMS. + </tp:docstring> + </tp:error> + </tp:possible-errors> + </method> </interface> </node> |