Commit 22c238d1 authored by Alexandre Savard's avatar Alexandre Savard

[#2521] Dbus documentation

parent c2186cfc
...@@ -268,15 +268,15 @@ ...@@ -268,15 +268,15 @@
@param[in] input accountID @param[in] input accountID
--> -->
<arg type="s" name="accountID" direction="in"> <arg type="s" name="accountID" direction="in">
<tp:docstring> <tp:docstring>
The account ID The account ID
</tp:docstring> </tp:docstring>
</arg> </arg>
<arg type="i" name="expire" direction="in"> <arg type="i" name="expire" direction="in">
<tp:docstring> <tp:docstring>
<p>To register, expire must be 1.</p> <p>To register, expire must be 1.</p>
<p>To un-register, expire must be 0.</p> <p>To un-register, expire must be 0.</p>
</tp:docstring> </tp:docstring>
</arg> </arg>
</method> </method>
...@@ -285,13 +285,14 @@ ...@@ -285,13 +285,14 @@
</tp:docstring> </tp:docstring>
<annotation name="com.trolltech.QtDBus.QtTypeName.Out0" value="VectorString"/> <annotation name="com.trolltech.QtDBus.QtTypeName.Out0" value="VectorString"/>
<arg type="as" name="list" direction="out"> <arg type="as" name="list" direction="out">
<tp:docstring> <tp:docstring>
</tp:docstring> </tp:docstring>
</arg> </arg>
</method> </method>
<method name="getVersion" tp:name-for-bindings="getVersion"> <method name="getVersion" tp:name-for-bindings="getVersion">
<tp:docstring> <tp:docstring>
Return SFLphone-daemon version
</tp:docstring> </tp:docstring>
<arg type="s" name="version" direction="out"> <arg type="s" name="version" direction="out">
<tp:docstring> <tp:docstring>
...@@ -302,7 +303,7 @@ ...@@ -302,7 +303,7 @@
<method name="getRingtoneList" tp:name-for-bindings="getRingtoneList"> <method name="getRingtoneList" tp:name-for-bindings="getRingtoneList">
<tp:docstring> <tp:docstring>
Return a list of valid Sun's .au sound file used Return a list of valid Sun's .au sound file used
as ringtones as ringtones.
</tp:docstring> </tp:docstring>
<annotation name="com.trolltech.QtDBus.QtTypeName.Out0" value="VectorString"/> <annotation name="com.trolltech.QtDBus.QtTypeName.Out0" value="VectorString"/>
<arg type="as" name="list" direction="out"> <arg type="as" name="list" direction="out">
...@@ -313,7 +314,7 @@ ...@@ -313,7 +314,7 @@
<method name="getPlaybackDeviceList" tp:name-for-bindings="getPlaybackDeviceList"> <method name="getPlaybackDeviceList" tp:name-for-bindings="getPlaybackDeviceList">
<tp:docstring> <tp:docstring>
Provide a list of playback device Provide a list of playback device from ALSA
</tp:docstring> </tp:docstring>
<annotation name="com.trolltech.QtDBus.QtTypeName.Out0" value="VectorString"/> <annotation name="com.trolltech.QtDBus.QtTypeName.Out0" value="VectorString"/>
<arg type="as" name="list" direction="out"> <arg type="as" name="list" direction="out">
...@@ -324,6 +325,7 @@ ...@@ -324,6 +325,7 @@
<method name="getRecordDeviceList" tp:name-for-bindings="getRecordDeviceList"> <method name="getRecordDeviceList" tp:name-for-bindings="getRecordDeviceList">
<tp:docstring> <tp:docstring>
Provide a list of record device from ALSA
</tp:docstring> </tp:docstring>
<annotation name="com.trolltech.QtDBus.QtTypeName.Out0" value="VectorString"/> <annotation name="com.trolltech.QtDBus.QtTypeName.Out0" value="VectorString"/>
<arg type="as" name="list" direction="out"> <arg type="as" name="list" direction="out">
...@@ -334,6 +336,7 @@ ...@@ -334,6 +336,7 @@
<method name="isRingtoneEnabled" tp:name-for-bindings="isRingtoneEnabled"> <method name="isRingtoneEnabled" tp:name-for-bindings="isRingtoneEnabled">
<tp:docstring> <tp:docstring>
Return true if ringtone is enabled, false otherwise
</tp:docstring> </tp:docstring>
<arg type="i" name="bool" direction="out"> <arg type="i" name="bool" direction="out">
<tp:docstring> <tp:docstring>
...@@ -343,24 +346,28 @@ ...@@ -343,24 +346,28 @@
<method name="ringtoneEnabled" tp:name-for-bindings="ringtoneEnabled"> <method name="ringtoneEnabled" tp:name-for-bindings="ringtoneEnabled">
<tp:docstring> <tp:docstring>
Unused
</tp:docstring> </tp:docstring>
</method> </method>
<method name="getRingtoneChoice" tp:name-for-bindings="getRingtoneChoice"> <method name="getRingtoneChoice" tp:name-for-bindings="getRingtoneChoice">
<tp:docstring> <tp:docstring>
Get current ringtone .au file selected
</tp:docstring> </tp:docstring>
<arg type="s" name="tone" direction="out"> <arg type="s" name="tone" direction="out">
<tp:docstring> <tp:docstring>
</tp:docstring> </tp:docstring>
</arg> </arg>
</method> </method>
<method name="setRingtoneChoice" tp:name-for-bindings="setRingtoneChoice"> <method name="setRingtoneChoice" tp:name-for-bindings="setRingtoneChoice">
<tp:docstring> <tp:docstring>
Set current ringtone .au file from list acquired using <tp:member-ref>getAccountList</tp:member-ref>
</tp:docstring> </tp:docstring>
<arg type="s" name="tone" direction="in"> <arg type="s" name="tone" direction="in">
<tp:docstring> <tp:docstring>
</tp:docstring> A valid .au file path
</tp:docstring>
</arg> </arg>
</method> </method>
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment