r243 - trunk/specifications/otapi
smartphones-commits at lists.linuxtogo.org
smartphones-commits at lists.linuxtogo.org
Wed Apr 23 17:15:16 CEST 2008
Author: mickeylauer
Date: 2008-04-23 17:15:15 +0200 (Wed, 23 Apr 2008)
New Revision: 243
Modified:
trunk/specifications/otapi/org.freesmartphone.GSM.Call.xml.in
Log:
otapi/org.freesmartphone.GSM.Call.xml.in: docs++
Modified: trunk/specifications/otapi/org.freesmartphone.GSM.Call.xml.in
===================================================================
--- trunk/specifications/otapi/org.freesmartphone.GSM.Call.xml.in 2008-04-22 13:32:21 UTC (rev 242)
+++ trunk/specifications/otapi/org.freesmartphone.GSM.Call.xml.in 2008-04-23 15:15:15 UTC (rev 243)
@@ -17,34 +17,79 @@
<method name="Emergency">
<annotation name="org.freedesktop.DBus.GLib.Async" value="fso_gsm_call" />
+ <doc:doc>
+ <doc:description>Initiate an emergency call.</doc:description>
+ </doc:doc>
<arg type="s" name="number" direction="out">
</arg>
</method>
<signal name="IncomingCall">
+ <doc:doc>
+ <doc:description>Sent frequently whenever there is an incoming call.</doc:description>
+ <doc:inote>This signal is emitted once for every 'RING' from the modem.</doc:inote>
+ </doc:doc>
<arg name="type" type="s" />
<arg name="number" type="s" />
<arg type="i" name="id" />
</signal>
- <method name="Accept">
+ <method name="Activate">
<annotation name="org.freedesktop.DBus.GLib.Async" value="fso_gsm_call" />
+ <doc:doc>
+ <doc:description>
+ Activate a call. No difference is made whether this is an incoming
+ call or a call that has been put on hold.
+ </doc:description>
+ </doc:doc>
<arg type="i" name="id" direction="in" />
</method>
<signal name="ActivatedCall">
+ <doc:doc>
+ <doc:description>
+ Sent whenever a call becomes the active call. No difference is made whether this
+ is a new call or a call that has been put on hold.
+ </doc:description>
+ </doc:doc>
<arg name="type" type="s" />
<arg name="number" type="s" />
<arg type="i" name="id" />
</signal>
+ <method name="Hold">
+ <annotation name="org.freedesktop.DBus.GLib.Async" value="fso_gsm_call" />
+ <doc:doc>
+ <doc:description>Put a call on hold.</doc:description>
+ </doc:doc>
+ <arg type="i" name="id" direction="in" />
+ </method>
+
+ <signal name="HeldCall">
+ <doc:doc>
+ <doc:description>Sent whenever a call has been put on hold.</doc:description>
+ </doc:doc>
+ <arg name="type" type="s" />
+ <arg name="number" type="s" />
+ <arg type="i" name="id" />
+ </signal>
+
<method name="Release">
<annotation name="org.freedesktop.DBus.GLib.Async" value="fso_gsm_call" />
+ <doc:doc>
+ <doc:description>Release a call.</doc:description>
+ </doc:doc>
<arg type="s" name="message" direction="in" />
<arg type="i" name="id" direction="in" />
</method>
<signal name="ReleasedCall">
+ <doc:doc>
+ <doc:description>
+ Sent whenever a call has been released. No difference is made whether
+ this was the active call or a call that has been put on hold.
+ </doc:description>
+ </doc:doc>
<arg type="b" name="success" />
<arg type="s" name="reason" />
<arg type="i" name="id" />
@@ -52,45 +97,71 @@
<method name="ReleaseAll">
<annotation name="org.freedesktop.DBus.GLib.Async" value="fso_gsm_call" />
+ <doc:doc>
+ <doc:description>Release all calls, no matter whether active or put on hold.</doc:description>
+ </doc:doc>
<arg type="s" name="message" direction="in" />
</method>
<method name="Initiate">
<annotation name="org.freedesktop.DBus.GLib.Async" value="fso_gsm_call" />
+ <doc:doc>
+ <doc:description>Initiate an outgoing call.</doc:description>
+ <doc:inote>
+ The next guaranteed signal you will receive is either
+ 'ReleasedCall' (in case the peer rejects the call), or
+ 'ActivatedCall' (in case the peer takes the call).
+ </doc:inote>
+ </doc:doc>
<arg type="s" name="number" direction="in" />
<arg type="s" name="type" direction="in" />
<arg type="i" name="id" direction="out" />
</method>
- <method name="GetStatus">
- <annotation name="org.freedesktop.DBus.GLib.Async" value="fso_gsm_call" />
- <arg type="i" name="id" direction="in" />
- <arg type="s" name="status" direction="out" />
- </method>
-
- <!-- this is optional -->
-
<signal name="CallProgress">
- <arg type="s" name="status" />
- <!--
- Valid values are:
- "Setting up"
- "Disconnect"
- "Alert"
- "Proceed"
- "Sync"
- "Progress"
- "Connected"
- "Release"
- "Reject"
- "Unknown"
- -->
- <arg type="i" name="id" />
+ <doc:doc>
+ <doc:description>Optional: Sent when a call changes progress.</doc:description>
+ <doc:inote>This maps to a GSM extension command not specified by standards.</doc:inote>
+ </doc:doc>
+ <arg type="s" name="progress">
+ <doc:doc>
+ <doc:summary>
+ The call progress. Expected values are:
+ "Setting up",
+ "Disconnect",
+ "Alert",
+ "Proceed",
+ "Sync",
+ "Progress",
+ "Connected",
+ "Release",
+ "Reject",
+ "Unknown".
+ </doc:summary>
+ </doc:doc>
+ </arg>
+ <arg type="i" name="id">
+ <doc:doc>
+ <doc:description>Index of call that changed call progress.</doc:description>
+ </doc:doc>
+ </arg>
</signal>
- <method name="ListActive">
+ <method name="ListCalls">
<annotation name="org.freedesktop.DBus.GLib.Async" value="fso_gsm_call" />
- <arg type="a{is}" name="calls" direction="out" />
+ <doc:doc>
+ <doc:description>Retreive list of calls.</doc:description>
+ </doc:doc>
+ <arg type="a{isb}" name="calls" direction="out">
+ <doc:doc>
+ <doc:summary>
+ The calls. Expected structure decomposes to:
+ 1. Index,
+ 2. Number of the peer,
+ 3. True, if it is the active call, False otherwise.
+ </doc:summary>
+ </doc:doc>
+ </arg>
</method>
<method name="SendDtmf">
More information about the Smartphones-commits
mailing list