Changeset 5d6783c in Dbus API specifications

Timestamp:

09/08/08 19:21:35 (5 years ago)

Author:

Michael 'Mickey' Lauer <mickey@…>

Branches:

820cacfd324a623a04b3e22f319e9220819d6ec4, 0.11, 675acad2f1510526a93c9777d03664766c823aab, morphis/pending, morphis/sms-rework

Children:

a8dcdd4

Parents:

c36ffb1

git-author:

Michael 'Mickey' Lauer <mickey@…> (09/08/08 19:21:06)

git-committer:

Michael 'Mickey' Lauer <mickey@…> (09/08/08 19:21:35)

Message:

org.freesmartphone.GSM.Call: fix parameter direction in Emergency() call and add some docs
org.freesmartphone.GSM.SIM: correct description of mandatory element in GetSimInfo? (s/imei/imsi)
Thanks Thomas Seiler for spotting.

Files:

• html/org.freesmartphone.GSM.Call.html (modified) (2 diffs)
• html/org.freesmartphone.GSM.SIM.html (modified) (1 diff)
• otapi/org.freesmartphone.GSM.Call.xml.in (modified) (3 diffs)
• otapi/org.freesmartphone.GSM.SIM.xml.in (modified) (2 diffs)

html/org.freesmartphone.GSM.Call.html

@@ -33 +33 @@
 <h2>Errors</h2><ul>
 <li><a href="#NotFound">NotFound</a></li>
+<li><a href="#NotAnEmergencyNumber">NotAnEmergencyNumber</a></li>
 </ul>
-<h1>Methods</h1><h3><a name="Emergency">Emergency</a> ( ) &rarr; s</h3>
-<p><i>Description:</i> Initiate an emergency call.</p><p><div class="rationale"><p>This maps to ATD(number);, see v.250.</p></div></p><h4>Returns</h4><i>s: number</i><p></p>
+<h1>Methods</h1><h3><a name="Emergency">Emergency</a> ( s )</h3>
+<p><i>Description:</i> Initiate an emergency call.</p><p><div class="rationale"><p>This maps to ATD(number);, see v.250.</p></div></p><h4>Parameters</h4><i>s: number</i><p>The emergency number to dial. National and world-wide restrictions apply.</p>
 <h3><a name="Activate">Activate</a> ( i )</h3>
 <p><i>Description:</i> Activate a call as single active call. All previously active calls are  put on hold. No difference is made whether this is an incoming  call or a call that has been put on hold.</p><p><div class="rationale"><p>This can map to ATA, see v.250. It might also map to GSM 07.07 +CHLD=..., see 3GPP TS 07.07 Chapter 7.12.</p></div></p><h4>Parameters</h4><i>i: id</i><p></p>
@@ -58 +59 @@
 <h1>Signals</h1><h3><h3><a name="CallStatus">CallStatus</a> ( isa{sv} )</h3><p><i>Description:</i> Sent whenever there is any status or property change on a call in the system,  no matter whether this is an incoming, active, held, or released call.</p><h4>Parameters</h4><i>i: id</i><p>The index of the call that changed its status or properties.</p><i>s: status</i><p>The new status of the call. Expected values are:  <ul>  <li>"incoming" = The call is incoming (but not yet accepted),</li>  <li>"outgoing" = The call is outgoing (but not yet established),</li>  <li>"active" = The call is the active call (you can talk),</li>  <li>"held" = The call is being held,</li>  <li>"released" = The call is being released.</li>  </ul>  Further information can be part of the properties.</p><i>a{sv}: properties</i><p>An array of property values. Note that properties are optional. Expected tuples are:  <ul>  <li>( "reason", string ) = The reason for the status change (on outgoing calls e.g. 'BUSY' or 'NO CARRIER'),</li>  <li>( "number", string ) = The number of the peer (on incoming calls only if we received a CLIP),</li>  <li>( "auxstatus", string ) = An auxillary connection status (if your modem supports that),</li>  <li>...</li>  </ul></p></h3>
 <h1>Errors</h1><h3><a name="NotFound">NotFound</a></h3><p><i>Description:</i> Raised, if the specified call is not present.</p>
+<h3><a name="NotAnEmergencyNumber">NotAnEmergencyNumber</a></h3><p><i>Description:</i> Raised, if the number is not allowed to dial as emergency call.</p>
 
     <hr/>

html/org.freesmartphone.GSM.SIM.html

@@ -64 +64 @@
 <p><i>Description:</i> Retrieve whether the SIM card checks for authentification on startup.</p><p><div class="rationale"><p>This maps to the GSM 07.07 command +CLCK,"SC",2, see 3GPP TS 07.07 Chapter 7.4.</p></div></p><h4>Returns</h4><i>b: check</i><p>True, if SIM card authentification is turned on. False, otherwise.</p>
 <h3><a name="GetSimInfo">GetSimInfo</a> ( ) &rarr; a{sv}</h3>
-<p><i>Description:</i> Get information about the IMSI, the subscriber numbers,  and the country code of the SIM card.</p><p><div class="rationale"><p>This can map to the following GSM 07.07 commands:  <ul>  <li>+CIMI (see 3GPP TS 07.07 Chapter 5.6),</li>  <li>+CNUM (see 3GPP TS 07.07 Chapter 7.1).</li>  </ul>  The dial code is computed by cross-referencing ITU E.212 (Land Mobile Numbering Plan).</p></div></p><h4>Returns</h4><i>a{sv}: info</i><p>Information about the SIM card. Required tuples are:  <ul>  <li>("imei", string)</li>  </ul>  Optional tuples are:  <ul>  <li>("subscriber_numbers", array),</li>  <li>("dial_prefix", string),</li>  <li>("country", string).</li>  </ul>  The subscriber_numbers array contains two-tuples formatted as (string:line-name, string:line-number).</p>
+<p><i>Description:</i> Get information about the IMSI, the subscriber numbers,  and the country code of the SIM card.</p><p><div class="rationale"><p>This can map to the following GSM 07.07 commands:  <ul>  <li>+CIMI (see 3GPP TS 07.07 Chapter 5.6),</li>  <li>+CNUM (see 3GPP TS 07.07 Chapter 7.1).</li>  </ul>  The dial code is computed by cross-referencing ITU E.212 (Land Mobile Numbering Plan).</p></div></p><h4>Returns</h4><i>a{sv}: info</i><p>Information about the SIM card. Required tuples are:  <ul>  <li>("imsi", string) = the unique subscriber identification stored on your SIM.</li>  </ul>  Optional tuples are:  <ul>  <li>("subscriber_numbers", array),</li>  <li>("dial_prefix", string),</li>  <li>("country", string).</li>  </ul>  The subscriber_numbers array contains two-tuples formatted as (string:line-name, string:line-number).</p>
 <h3><a name="SendGenericSimCommand">SendGenericSimCommand</a> ( s ) &rarr; s</h3>
 <p><i>Description:</i> Send a generic SIM command to the SIM card.</p><p><div class="rationale"><p>This maps to the GSM 07.07 command +CSIM=(command), see 3GPP TS 07.07 Chapter 8.17.</p></div></p><h4>Parameters</h4><i>s: command</i><p>The command to send, encoded as described in GSM 11.11.</p><h4>Returns</h4><i>s: result</i><p>The result of the command, encoded as described in GSM 11.11.</p>

otapi/org.freesmartphone.GSM.Call.xml.in

@@ -4 +4 @@
 <doc:doc>
   <doc:summary>freesmartphone.org GSM Call Interface</doc:summary>
+  <doc:version>0.8.9</doc:version>
 </doc:doc>
 
@@ -23 +24 @@
   </error>
 
+  <error name="NotAnEmergencyNumber">
+    <doc:doc>
+      <doc:description>
+        Raised, if the number is not allowed to dial as emergency call.
+      </doc:description>
+    </doc:doc>
+  </error>
+
   <method name="Emergency">
     <annotation name="org.freedesktop.DBus.GLib.Async" value="fso_gsm_call" />
@@ -29 +38 @@
       <doc:inote>This maps to ATD(number);, see v.250.</doc:inote>
     </doc:doc>
-    <arg type="s" name="number" direction="out">
+    <arg type="s" name="number" direction="in">
+      <doc:doc>
+        <doc:summary>The emergency number to dial. National and world-wide restrictions apply.</doc:summary>
+      </doc:doc>
     </arg>
   </method>

otapi/org.freesmartphone.GSM.SIM.xml.in

@@ -4 +4 @@
 <doc:doc>
   <doc:summary>freesmartphone.org GSM SIM Interface</doc:summary>
+  <doc:version>0.9.0</doc:version>
 </doc:doc>
 
@@ -205 +206 @@
           Information about the SIM card. Required tuples are:
           [ul]
-            [li]("imei", string)[/li]
+            [li]("imsi", string) = the unique subscriber identification stored on your SIM.[/li]
           [/ul]
           Optional tuples are: