Changeset f48bbdd in Dbus API specifications

Timestamp:

02/12/09 15:53:41 (4 years ago)

Author:

Michael 'Mickey' Lauer <mickey@…>

Branches:

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

Children:

9386136

Parents:

f3e85b1

git-author:

Michael 'Mickey' Lauer <mickey@…> (02/12/09 15:53:41)

git-committer:

Michael 'Mickey' Lauer <mickey@…> (02/12/09 15:53:41)

Message:

otapi: document org.freesmartphone.GSM.SIM.GetProviderList?()

Files:

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

html/org.freesmartphone.GSM.SIM.html

@@ -26 +26 @@
 <li><a href="#GetHomeZones">GetHomeZones</a></li>
 <li><a href="#GetIssuer">GetIssuer</a></li>
+<li><a href="#GetProviderList">GetProviderList</a></li>
 <li><a href="#ListPhonebooks">ListPhonebooks</a></li>
 <li><a href="#GetPhonebookInfo">GetPhonebookInfo</a></li>
@@ -75 +76 @@
 <h3><a name="GetIssuer">GetIssuer</a> ( ) &rarr; s</h3>
 <p><i>Description:</i> Retrieve the name of the SIM issuer, if stored on the SIM. </p><p><div class="rationale"><p>This maps to the GSM 07.07 command +CRSM=176,28486,0,0,17, see 3GPP TS 07.07 Chapter 8.17. </p></div></p><h4>Returns</h4><i>s: name</i><p>The name of the SIM issuer. This can be an actual network provider or a mobile virtual network operator (MVNO). </p>
+<h3><a name="GetProviderList">GetProviderList</a> ( ) &rarr; a{is}</h3>
+<p><i>Description:</i> Retrieve the list of known providers, if stored on the SIM. </p><p><div class="rationale"><p>This maps to the GSM 07.07 command +COPN, see 3GPP TS 07.07 Chapter 7.19. </p></div></p><h4>Returns</h4><i>a{is}: providers</i><p>An map containing of known providers as tuples. The key is the numerical provider code (mccmnc), the value is the alphanumerical provider name. </p>
 <h3><a name="ListPhonebooks">ListPhonebooks</a> ( ) &rarr; as</h3>
 <p><i>Description:</i> Retrieve the list of available phonebooks on the SIM. </p><p><div class="rationale"><p>This maps to the GSM 07.07 command +CPBS=?, see 3GPP TS 07.07 Chapter 8.12. </p></div></p><h4>Returns</h4><i>as: categories</i><p>The available phonebooks, if any. Expected values are:  <ul>  <li>"contacts",</li>  <li>"dialed",</li>  <li>"received",</li>  <li>"own",</li>  <li>"missed",</li>  <li>"emergency",</li>  </ul> </p>

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

@@ -4 +4 @@
 <doc:doc>
   <doc:summary>freesmartphone.org GSM SIM Interface</doc:summary>
-  <doc:version>0.9.4.0</doc:version>
+  <doc:version>0.9.5.0</doc:version>
 </doc:doc>
 
@@ -322 +322 @@
         <doc:summary>
           The name of the SIM issuer. This can be an actual network provider or a mobile virtual network operator (MVNO).
+        </doc:summary>
+      </doc:doc>
+    </arg>
+  </method>
+
+  <method name="GetProviderList">
+    <annotation name="org.freedesktop.DBus.GLib.Async" value="fso_gsm_sim" />
+    <doc:doc>
+      <doc:description>Retrieve the list of known providers, if stored on the SIM.</doc:description>
+      <doc:inote>This maps to the GSM 07.07 command +COPN, see 3GPP TS 07.07 Chapter 7.19.</doc:inote>
+    </doc:doc>
+    <arg type="a{is}" name="providers" direction="out">
+      <doc:doc>
+        <doc:summary>
+          An map containing of known providers as tuples. The key is the numerical provider code (mccmnc), the value is the alphanumerical provider name.
         </doc:summary>
       </doc:doc>

xml/org.freesmartphone.GSM.SIM.xml

@@ -65 +65 @@
       <annotation name="org.freedesktop.DBus.GLib.Async" value="fso_gsm_sim"/>
       <arg type="s" name="name" direction="out"/>
+    </method>
+    <method name="GetProviderList">
+      <annotation name="org.freedesktop.DBus.GLib.Async" value="fso_gsm_sim"/>
+      <arg type="a{is}" name="providers" direction="out"/>
     </method>
     <method name="ListPhonebooks">