r234 - trunk/specifications/otapi

[smartphones-commits at lists.linuxtogo.org]

Author: mickeylauer
Date: 2008-04-21 00:17:45 +0200 (Mon, 21 Apr 2008)
New Revision: 234

Modified:
   trunk/specifications/otapi/org.freesmartphone.GSM.Call.xml.in
Log:
otapi/org.freesmartphone.GSM.Call.xml.in: first bits of docs. G'night.


Modified: trunk/specifications/otapi/org.freesmartphone.GSM.Call.xml.in
===================================================================
--- trunk/specifications/otapi/org.freesmartphone.GSM.Call.xml.in	2008-04-20 16:52:16 UTC (rev 233)
+++ trunk/specifications/otapi/org.freesmartphone.GSM.Call.xml.in	2008-04-20 22:17:45 UTC (rev 234)
@@ -1,12 +1,24 @@
 <?xml version="1.0"?>
 <node name="/" xmlns:doc="http://www.freedesktop.org/dbus/1.0/doc.dtd" doc:id="freesmartphone-gsm-call-interface">
 
+<doc:doc>
+  <doc:summary>freesmartphone.org GSM Call Interface</doc:summary>
+</doc:doc>
+
 <interface name="org.freesmartphone.GSM.Call">
 
+  <doc:doc>
+    <doc:para>
+      The Call object is used to initiate, accept, release, and otherwise deal
+      with voice calls. It also allows you to send DTMF tones and customize
+      calling line identification presentation.
+    </doc:para>
+  </doc:doc>
 
   <method name="Emergency">
     <annotation name="org.freedesktop.DBus.GLib.Async" value="fso_gsm_call" />
-    <arg type="s" name="number" direction="out" />
+    <arg type="s" name="number" direction="out">
+    </arg>
   </method>
 
   <signal name="IncomingCall">
@@ -15,17 +27,17 @@
     <arg type="i" name="id" />
   </signal>
 
+  <method name="Accept">
+    <annotation name="org.freedesktop.DBus.GLib.Async" value="fso_gsm_call" />
+    <arg type="i" name="id" direction="in" />
+  </method>
+
   <signal name="ActivatedCall">
     <arg name="type" type="s" />
     <arg name="number" type="s" />
     <arg type="i" name="id" />
   </signal>
 
-  <method name="Accept">
-    <annotation name="org.freedesktop.DBus.GLib.Async" value="fso_gsm_call" />
-    <arg type="i" name="id" direction="in" />
-  </method>
-
   <method name="Release">
     <annotation name="org.freedesktop.DBus.GLib.Async" value="fso_gsm_call" />
     <arg type="s" name="message" direction="in" />
@@ -57,7 +69,7 @@
   </method>
 
     <!-- this is optional -->
-  
+
   <signal name="CallProgress">
     <arg type="s" name="status" />
     <!--
@@ -83,18 +95,68 @@
 
   <method name="SendDtmf">
     <annotation name="org.freedesktop.DBus.GLib.Async" value="fso_gsm_call" />
-    <arg type="s" name="mode" direction="out" />
+    <doc:doc>
+      <doc:description>Send a Dual Tone Multiple Frequency (DTMF) signal during a call.</doc:description>
+      <doc:inote>This maps to the TIA IS 101 command +VTS=(value), see 3GPP TS 07.07 Chapter C.2.11.</doc:inote>
+    </doc:doc>
+    <arg type="s" name="signal" direction="out">
+      <doc:doc>
+        <doc:summary>The signal to sent. Expected valid values are: (0-9,#,*,A-D)</doc:summary>
+      </doc:doc>
+    </arg>
   </method>
 
   <method name="SetDtmfDuration">
     <annotation name="org.freedesktop.DBus.GLib.Async" value="fso_gsm_call" />
-    <arg type="i" name="mode" direction="in" />
+    <doc:doc>
+      <doc:description>Set the duration of Dual Tone Multiple Frequency (DTMF) signals.</doc:description>
+      <doc:inote>This maps to the TIA IS 101 command +VTD=(value), see 3GPP TS 07.07 Chapter C.2.12.</doc:inote>
+    </doc:doc>
+    <arg type="i" name="mode" direction="in">
+      <doc:doc>
+        <doc:summary>The duration to set in 1/10ths of seconds. 0 sets a vendor default.</doc:summary>
+      </doc:doc>
+    </arg>
   </method>
 
   <method name="GetDtmfDuration">
     <annotation name="org.freedesktop.DBus.GLib.Async" value="fso_gsm_call" />
-    <arg type="i" name="duration" direction="out" />
+    <doc:doc>
+      <doc:description>Get the duration of Dual Tone Multiple Frequency (DTMF) signals.</doc:description>
+      <doc:inote>This maps to the TIA IS 101 command +VTD?, see 3GPP TS 07.07 Chapter C.2.12.</doc:inote>
+    </doc:doc>
+    <arg type="i" name="duration" direction="out">
+      <doc:doc>
+        <doc:summary>The current duration in 1/10ths of seconds.</doc:summary>
+      </doc:doc>
+    </arg>
   </method>
 
+  <method name="SetSendIdentification">
+    <annotation name="org.freedesktop.DBus.GLib.Async" value="fso_gsm_call" />
+    <doc:doc>
+      <doc:description>Set whether your subscriber number is visible during a call.</doc:description>
+      <doc:inote>This maps to the GSM 07.07 command +CLIR=(value), see 3GPP TS 07.07 Chapter 7.7.</doc:inote>
+    </doc:doc>
+    <arg type="b" name="mode" direction="in">
+      <doc:doc>
+        <doc:summary>True, if your subscriber number should be visible to other parties. False, otherwise.</doc:summary>
+      </doc:doc>
+    </arg>
+  </method>
+
+  <method name="GetSendIdentification">
+    <annotation name="org.freedesktop.DBus.GLib.Async" value="fso_gsm_call" />
+    <doc:doc>
+      <doc:description>Get whether your subscriber number is visible during a call.</doc:description>
+      <doc:inote>This maps to the GSM 07.07 command +CLIR?, see 3GPP TS 07.07 Chapter 7.7.</doc:inote>
+    </doc:doc>
+    <arg type="b" name="duration" direction="out">
+      <doc:doc>
+        <doc:summary>True, if your subscriber number is visible to other parties. False, otherwise.</doc:summary>
+      </doc:doc>
+    </arg>
+  </method>
+
 </interface>
 </node>