r231 - trunk/specifications/otapi
smartphones-commits at lists.linuxtogo.org
smartphones-commits at lists.linuxtogo.org
Sun Apr 20 17:26:25 CEST 2008
Author: mickeylauer
Date: 2008-04-20 17:26:24 +0200 (Sun, 20 Apr 2008)
New Revision: 231
Modified:
trunk/specifications/otapi/README
trunk/specifications/otapi/org.freesmartphone.GSM.SIM.xml.in
Log:
otapi/org.freesmartphone.GSM.SIM.xml: fully documented
Modified: trunk/specifications/otapi/README
===================================================================
--- trunk/specifications/otapi/README 2008-04-20 12:48:11 UTC (rev 230)
+++ trunk/specifications/otapi/README 2008-04-20 15:26:24 UTC (rev 231)
@@ -4,7 +4,9 @@
TODO
====
-* Error specification / handling?
+* Error specification / handling
+* Sorting
+* Cross-references
Hacking notes
=============
Modified: trunk/specifications/otapi/org.freesmartphone.GSM.SIM.xml.in
===================================================================
--- trunk/specifications/otapi/org.freesmartphone.GSM.SIM.xml.in 2008-04-20 12:48:11 UTC (rev 230)
+++ trunk/specifications/otapi/org.freesmartphone.GSM.SIM.xml.in 2008-04-20 15:26:24 UTC (rev 231)
@@ -110,7 +110,7 @@
</arg>
</method>
- <!-- TODO consider additional commands for
+ <!-- FIXME might want to consider additional commands for
* getting retry count left for auth
* lock phone -->
@@ -118,11 +118,18 @@
<method name="GetPhonebookInfo">
<annotation name="org.freedesktop.DBus.GLib.Async" value="fso_gsm_sim" />
+ <doc:doc>
+ <doc:description>Request information about the SIM phonebook.</doc:description>
+ <doc:inote>This maps to the GSM 07.07 command +CPBR=?, see 3GPP TS 07.07 Chapter 8.12</doc:inote>
+ </doc:doc>
<arg type="a{sv}" name="info" direction="out">
<doc:doc>
<doc:summary>
- Information about the SIM phonebook storage. Fields to expect:
- ...
+ Information about the SIM phonebook storage. Tuples to expect:
+ ("slots", int:value) = maximum of entries stored on the SIM,
+ ("used", int:value) = actual number of entries stored on the SIM,
+ ("number_length", int:value) = maximum length for the number,
+ ("name_length", int:value) = maximum length for the name.
</doc:summary>
</doc:doc>
</arg>
@@ -130,54 +137,163 @@
<method name="DeleteEntry">
<annotation name="org.freedesktop.DBus.GLib.Async" value="fso_gsm_sim" />
- <arg type="i" name="index" direction="in" />
+ <doc:doc>
+ <doc:description>Delete an entry in the SIM phonebook.</doc:description>
+ <doc:inote>This maps to the GSM 07.07 command +CPBW=, see 3GPP TS 07.07 Chapter 8.14</doc:inote>
+ </doc:doc>
+ <arg type="i" name="index" direction="in">
+ <doc:doc>
+ <doc:summary>Index of entry to delete.</doc:summary>
+ </doc:doc>
+ </arg>
</method>
<method name="StoreEntry">
<annotation name="org.freedesktop.DBus.GLib.Async" value="fso_gsm_sim" />
- <arg type="i" name="index" direction="in" />
- <arg type="i" name="type" direction="in" />
- <arg type="s" name="name" direction="in" />
- <arg type="s" name="contents" direction="in" />
+ <doc:doc>
+ <doc:description>Store an entry in the SIM phonebook.</doc:description>
+ <doc:inote>This maps to the GSM 07.07 command +CPBW=, see 3GPP TS 07.07 Chapter 8.14</doc:inote>
+ </doc:doc>
+ <arg type="i" name="index" direction="in">
+ <doc:doc>
+ <doc:summary>Index of entry to store.</doc:summary>
+ </doc:doc>
+ </arg>
+ <arg type="s" name="name" direction="in">
+ <doc:doc>
+ <doc:summary>Name corresponding to the number.</doc:summary>
+ </doc:doc>
+ </arg>
+ <arg type="s" name="number" direction="in">
+ <doc:doc>
+ <doc:summary>Number corresponding to the name.</doc:summary>
+ <doc:inote>We do not export the +CPBW "type" entry to the interface, but rather deal with that transparently.</doc:inote>
+ </doc:doc>
+ </arg>
</method>
<method name="RetrieveEntry">
<annotation name="org.freedesktop.DBus.GLib.Async" value="fso_gsm_sim" />
- <arg type="i" name="index" direction="in" />
- <arg type="i" name="type" direction="out" />
- <arg type="s" name="name" direction="out" />
- <arg type="s" name="contents" direction="out" />
+ <arg type="i" name="index" direction="in">
+ <doc:doc>
+ <doc:summary>Index of entry to retrieve.</doc:summary>
+ </doc:doc>
+ </arg>
+ <arg type="s" name="name" direction="out">
+ <doc:doc>
+ <doc:summary>Name corresponding to the number.</doc:summary>
+ </doc:doc>
+ </arg>
+ <arg type="s" name="number" direction="out">
+ <doc:doc>
+ <doc:summary>Number corresponding to the name.</doc:summary>
+ </doc:doc>
+ </arg>
</method>
<!-- SHORT MESSAGE SERVICE -->
+ <method name="GetMessagebookInfo">
+ <annotation name="org.freedesktop.DBus.GLib.Async" value="fso_gsm_sim" />
+ <doc:doc>
+ <doc:description>Request information about the SIM messagebook.</doc:description>
+ <doc:inote>This vaguely maps to the GSM 07.05 command +CMGL=?, see 3GPP TS 07.07 Chapter 3.4.2</doc:inote>
+ </doc:doc>
+ <arg type="a{sv}" name="info" direction="out">
+ <doc:doc>
+ <doc:summary>
+ Information about the SIM messagebook storage. Tuples to expect:
+ ("slots", int:value) = maximum of messages stored on the SIM,
+ ("used", int:value) = actual number of messages stored on the SIM,
+ ("contents_length", int:value) = maximum length for a message,
+ </doc:summary>
+ </doc:doc>
+ </arg>
+ </method>
+
<method name="GetServiceCenterNumber">
<annotation name="org.freedesktop.DBus.GLib.Async" value="fso_gsm_sim" />
- <arg type="s" name="number" direction="out" />
+ <doc:doc>
+ <doc:description>Retrieve phone number of SMS Center Number.</doc:description>
+ <doc:inote>This maps to the GSM 07.05 command +CSCA?, see 3GPP TS 07.05 Chapter 3.3.1</doc:inote>
+ </doc:doc>
+ <arg type="s" name="number" direction="out">
+ <doc:doc>
+ <doc:summary>The SMS Center Number.</doc:summary>
+ </doc:doc>
+ </arg>
</method>
<method name="SetServiceCenterNumber">
<annotation name="org.freedesktop.DBus.GLib.Async" value="fso_gsm_sim" />
- <arg type="s" name="number" direction="in" />
+ <doc:doc>
+ <doc:description>Set phone number of SMS Center Number.</doc:description>
+ <doc:inote>This maps to the GSM 07.05 command +CSCA=(number,type), see 3GPP TS 07.05 Chapter 3.3.1</doc:inote>
+ </doc:doc>
+ <arg type="s" name="number" direction="in">
+ <doc:doc>
+ <doc:summary>The SMS Center Number.</doc:summary>
+ </doc:doc>
+ </arg>
</method>
<method name="DeleteMessage">
<annotation name="org.freedesktop.DBus.GLib.Async" value="fso_gsm_sim" />
- <arg type="i" name="index" direction="in" />
+ <doc:doc>
+ <doc:description>Delete a message in the SIM messagebook.</doc:description>
+ <doc:inote>This maps to the GSM 07.05 command +CMGD=(index), see 3GPP TS 07.05 Chapter 3.5.4</doc:inote>
+ </doc:doc>
+ <arg type="i" name="index" direction="in">
+ <doc:doc>
+ <doc:summary>Index of message to delete.</doc:summary>
+ </doc:doc>
+ </arg>
</method>
<method name="StoreMessage">
<annotation name="org.freedesktop.DBus.GLib.Async" value="fso_gsm_sim" />
- <arg type="s" name="recipient_number" direction="in" />
- <arg type="s" name="contents" direction="in" />
- <arg type="i" name="index" direction="out" />
+ <doc:doc>
+ <doc:description>Store a message in the SIM messagebook.</doc:description>
+ <doc:inote>This maps to the GSM 07.05 command +CMGW=..., see 3GPP TS 07.05 Chapter 3.5.3</doc:inote>
+ </doc:doc>
+ <arg type="s" name="recipient_number" direction="in">
+ <doc:doc>
+ <doc:summary>Number of recipient.</doc:summary>
+ </doc:doc>
+ </arg>
+ <arg type="s" name="contents" direction="in">
+ <doc:doc>
+ <doc:summary>Contents of message.</doc:summary>
+ </doc:doc>
+ </arg>
+ <arg type="i" name="index" direction="out">
+ <doc:doc>
+ <doc:summary>Index of new message.</doc:summary>
+ </doc:doc>
+ </arg>
</method>
<method name="RetrieveMessage">
<annotation name="org.freedesktop.DBus.GLib.Async" value="fso_gsm_sim" />
- <arg type="i" name="index" direction="in" />
- <arg type="s" name="sender_number" direction="out" />
- <arg type="s" name="contents" direction="out" />
+ <doc:doc>
+ <doc:description>Retrieve a message from the SIM messagebook.</doc:description>
+ <doc:inote>This maps to the GSM 07.05 command +CMGR=(index), see 3GPP TS 07.05 Chapter 3.4.3</doc:inote>
+ </doc:doc>
+ <arg type="i" name="index" direction="in">
+ <doc:doc>
+ <doc:summary>Index of message to retrieve.</doc:summary>
+ </doc:doc>
+ </arg>
+ <arg type="s" name="sender_number" direction="out">
+ <doc:doc>
+ <doc:summary>Number of sender.</doc:summary>
+ </doc:doc>
+ </arg>
+ <arg type="s" name="contents" direction="out">
+ <doc:doc>
+ <doc:summary>Contents of message.</doc:summary>
+ </doc:doc>
+ </arg>
</method>
</interface>
More information about the Smartphones-commits
mailing list