Commit a1ae3e1e authored by Alexandre Savard's avatar Alexandre Savard
Browse files

[#2521] Update configuration manager documentation

parent c1417c3e
...@@ -105,8 +105,8 @@ ...@@ -105,8 +105,8 @@
<tp:docstring> <tp:docstring>
</tp:docstring> </tp:docstring>
<arg type="s" name="accountID" direction="in"> <arg type="s" name="accountID" direction="in">
<tp:docstring> <tp:docstring>
</tp:docstring> </tp:docstring>
</arg> </arg>
<arg type="i" name="number" direction="in"> <arg type="i" name="number" direction="in">
<tp:docstring> <tp:docstring>
...@@ -732,6 +732,7 @@ ...@@ -732,6 +732,7 @@
<method name="getWindowWidth" tp:name-for-bindings="getWindowWidth"> <method name="getWindowWidth" tp:name-for-bindings="getWindowWidth">
<tp:docstring> <tp:docstring>
Unused
</tp:docstring> </tp:docstring>
<arg type="i" name="width" direction="out"> <arg type="i" name="width" direction="out">
<tp:docstring> <tp:docstring>
...@@ -741,6 +742,7 @@ ...@@ -741,6 +742,7 @@
<method name="getWindowHeight" tp:name-for-bindings="getWindowHeight"> <method name="getWindowHeight" tp:name-for-bindings="getWindowHeight">
<tp:docstring> <tp:docstring>
Unused
</tp:docstring> </tp:docstring>
<arg type="i" name="height" direction="out"> <arg type="i" name="height" direction="out">
<tp:docstring> <tp:docstring>
...@@ -750,6 +752,7 @@ ...@@ -750,6 +752,7 @@
<method name="setWindowWidth" tp:name-for-bindings="setWindowWidth"> <method name="setWindowWidth" tp:name-for-bindings="setWindowWidth">
<tp:docstring> <tp:docstring>
Unused
</tp:docstring> </tp:docstring>
<arg type="i" name="width" direction="in"> <arg type="i" name="width" direction="in">
<tp:docstring> <tp:docstring>
...@@ -759,6 +762,7 @@ ...@@ -759,6 +762,7 @@
<method name="setWindowHeight" tp:name-for-bindings="setWindowHeight"> <method name="setWindowHeight" tp:name-for-bindings="setWindowHeight">
<tp:docstring> <tp:docstring>
Unused
</tp:docstring> </tp:docstring>
<arg type="i" name="height" direction="in"> <arg type="i" name="height" direction="in">
<tp:docstring> <tp:docstring>
...@@ -768,6 +772,7 @@ ...@@ -768,6 +772,7 @@
<method name="getWindowPositionX" tp:name-for-bindings="getWindowPositionX"> <method name="getWindowPositionX" tp:name-for-bindings="getWindowPositionX">
<tp:docstring> <tp:docstring>
Unused
</tp:docstring> </tp:docstring>
<arg type="i" name="posX" direction="out"> <arg type="i" name="posX" direction="out">
<tp:docstring> <tp:docstring>
...@@ -777,6 +782,7 @@ ...@@ -777,6 +782,7 @@
<method name="setWindowPositionX" tp:name-for-bindings="setWindowPositionX"> <method name="setWindowPositionX" tp:name-for-bindings="setWindowPositionX">
<tp:docstring> <tp:docstring>
Unused
</tp:docstring> </tp:docstring>
<arg type="i" name="posX" direction="in"> <arg type="i" name="posX" direction="in">
<tp:docstring> <tp:docstring>
...@@ -786,6 +792,7 @@ ...@@ -786,6 +792,7 @@
<method name="getWindowPositionY" tp:name-for-bindings="getWindowPositionY"> <method name="getWindowPositionY" tp:name-for-bindings="getWindowPositionY">
<tp:docstring> <tp:docstring>
Unused
</tp:docstring> </tp:docstring>
<arg type="i" name="posY" direction="out"> <arg type="i" name="posY" direction="out">
<tp:docstring> <tp:docstring>
...@@ -795,28 +802,33 @@ ...@@ -795,28 +802,33 @@
<method name="setWindowPositionY" tp:name-for-bindings="setWindowPositionY"> <method name="setWindowPositionY" tp:name-for-bindings="setWindowPositionY">
<tp:docstring> <tp:docstring>
Unused
</tp:docstring> </tp:docstring>
<arg type="i" name="posY" direction="in"> <arg type="i" name="posY" direction="in">
<tp:docstring> <tp:docstring>
</tp:docstring> </tp:docstring>
</arg> </arg>
</method> </method>
<method name="enableStatusIcon" tp:name-for-bindings="enableStatusIcon"> <method name="enableStatusIcon" tp:name-for-bindings="enableStatusIcon">
<tp:docstring> <tp:docstring>
Allow SFLphone icon to be displayed in system tray
</tp:docstring> </tp:docstring>
<arg type="s" name="value" direction="in"> <arg type="s" name="value" direction="in">
<tp:docstring> <tp:docstring>
</tp:docstring> true/false
</tp:docstring>
</arg> </arg>
</method> </method>
<method name="isStatusIconEnabled" tp:name-for-bindings="isStatusIconEnabled"> <method name="isStatusIconEnabled" tp:name-for-bindings="isStatusIconEnabled">
<tp:docstring> <tp:docstring>
Test if SFLphone icon is displayed in system tray.
</tp:docstring> </tp:docstring>
<arg type="s" name="value" direction="out"> <arg type="s" name="value" direction="out">
<tp:docstring> <tp:docstring>
</tp:docstring> true/false
</tp:docstring>
</arg> </arg>
</method> </method>
...@@ -899,100 +911,144 @@ ...@@ -899,100 +911,144 @@
</tp:docstring> </tp:docstring>
<annotation name="com.trolltech.QtDBus.QtTypeName.In0" value="MapStringString"/> <annotation name="com.trolltech.QtDBus.QtTypeName.In0" value="MapStringString"/>
<arg type="a{ss}" name="entries" direction="in"> <arg type="a{ss}" name="entries" direction="in">
<tp:docstring> <tp:docstring>
</tp:docstring> </tp:docstring>
</arg> </arg>
</method> </method>
<signal name="accountsChanged" tp:name-for-bindings="accountsChanged"> <signal name="accountsChanged" tp:name-for-bindings="accountsChanged">
<tp:docstring>
Signal emited on account changes. Clients should update
all account status with <tp:member-ref>getAccountDetails</tp:member-ref>
iterating over the list provided by <tp:member-ref>getAccountList</tp:member-ref>
</tp:docstring>
</signal> </signal>
<signal name="errorAlert" tp:name-for-bindings="errorAlert"> <signal name="errorAlert" tp:name-for-bindings="errorAlert">
<arg type="i" name="code"> <arg type="i" name="code">
<tp:docstring> <tp:docstring>
</tp:docstring> </tp:docstring>
</arg> </arg>
</signal> </signal>
<!-- TLS Methods --> <!-- TLS Methods -->
<method name="getSupportedTlsMethod" tp:name-for-bindings="getSupportedTlsMethod"> <method name="getSupportedTlsMethod" tp:name-for-bindings="getSupportedTlsMethod">
<tp:docstring> <tp:docstring>
Provide a list of supported TLS method
</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> A list of TLS method: (TLSv1, SSLv1, SSLv2,
SSLv3, SSLv23)
</tp:docstring>
</arg> </arg>
</method> </method>
<method name="getTlsSettingsDefault" tp:name-for-bindings="getTlsSettingsDefault"> <method name="getTlsSettingsDefault" tp:name-for-bindings="getTlsSettingsDefault">
<annotation name="com.trolltech.QtDBus.QtTypeName.Out0" value="MapStringString"/> <annotation name="com.trolltech.QtDBus.QtTypeName.Out0" value="MapStringString"/>
<tp:docstring> <tp:docstring>
Get default TLS setting for new accounts
</tp:docstring> </tp:docstring>
<arg type="a{ss}" name="details" direction="out"> <arg type="a{ss}" name="details" direction="out">
<tp:docstring> <tp:docstring>
</tp:docstring> A hash table containing details. Refer
to <tp:member-ref>getTlsSettings</tp:member-ref>
for possible keys
</tp:docstring>
</arg> </arg>
</method> </method>
<method name="getTlsSettings" tp:name-for-bindings="getTlsSettings"> <method name="getTlsSettings" tp:name-for-bindings="getTlsSettings">
<tp:docstring> <tp:docstring>
Get current TLS setting for a specific account
</tp:docstring> </tp:docstring>
<arg type="s" name="accountID" direction="in"> <arg type="s" name="accountID" direction="in">
<tp:docstring> <tp:docstring>
</tp:docstring> The account ID
</tp:docstring>
</arg> </arg>
<annotation name="com.trolltech.QtDBus.QtTypeName.Out0" value="MapStringString"/> <annotation name="com.trolltech.QtDBus.QtTypeName.Out0" value="MapStringString"/>
<arg type="a{ss}" name="details" direction="out"> <arg type="a{ss}" name="details" direction="out">
<tp:docstring> <tp:docstring>
</tp:docstring> A hash table containing details with key:
<ul>
<li>"TLS.listenerPort": valid numerical port</li>
<li>"TLS.enable": true/false</li>
<li>"TLS.certificateListFile": A valid path to
a .pem file containing CA certificate</li>
<li>"TLS.certificateFile": A valid path to a
file containing the public end-point
certificate (optional)</li>
<li>"TLS.privateKeyFile": A valid path to a
file containing the public end-point private
key (optional)</li>
<li>"TLS.password": Public end-point private
key password (optional)</li>
<li>"TLS.method": (TLSv1, SSLv1, SSLv2,
SSLv3, SSLv23)</li>
</ul>
</tp:docstring>
</arg> </arg>
</method> </method>
<method name="setTlsSettings" tp:name-for-bindings="setTlsSettings"> <method name="setTlsSettings" tp:name-for-bindings="setTlsSettings">
<tp:docstring> <tp:docstring>
Update TLS setting for a specific account
</tp:docstring> </tp:docstring>
<annotation name="com.trolltech.QtDBus.QtTypeName.In1" value="MapStringString"/> <annotation name="com.trolltech.QtDBus.QtTypeName.In1" value="MapStringString"/>
<arg type="s" name="accountID" direction="in"> <arg type="s" name="accountID" direction="in">
<tp:docstring> <tp:docstring>
</tp:docstring> The account ID
</tp:docstring>
</arg> </arg>
<arg type="a{ss}" name="details" direction="in"> <arg type="a{ss}" name="details" direction="in">
<tp:docstring> <tp:docstring>
</tp:docstring> A hash table containing details. Refer
to <tp:member-ref>getTlsSettings</tp:member-ref>
for possible keys.
</tp:docstring>
</arg> </arg>
</method> </method>
<method name="getAddrFromInterfaceName" tp:name-for-bindings="getAddrFromInterfaceName"> <method name="getAddrFromInterfaceName" tp:name-for-bindings="getAddrFromInterfaceName">
<tp:docstring> <tp:docstring>
Resolve interface IPv4 address provided its name.
</tp:docstring> </tp:docstring>
<arg type="s" name="interface" direction="in"> <arg type="s" name="interface" direction="in">
<tp:docstring> <tp:docstring>
</tp:docstring> Interface name
</tp:docstring>
</arg> </arg>
<arg type="s" name="address" direction="out"> <arg type="s" name="address" direction="out">
<tp:docstring> <tp:docstring>
</tp:docstring> Interface IPv4 address
</tp:docstring>
</arg> </arg>
</method> </method>
<method name="getAllIpInterface" tp:name-for-bindings="getAllIpInterface"> <method name="getAllIpInterface" tp:name-for-bindings="getAllIpInterface">
<tp:docstring> <tp:docstring>
Provide a list of IP interface's IPv4 address.
</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> A list of interface's IPv4 address
</tp:docstring>
</arg> </arg>
</method> </method>
<method name="getAllIpInterfaceByName" tp:name-for-bindings="getAllIpInterfaceByName"> <method name="getAllIpInterfaceByName" tp:name-for-bindings="getAllIpInterfaceByName">
<tp:docstring> <tp:docstring>
Provide a list of IP interface's name: default
(0.0.0.0), lo, eth0 ...
</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> A list of interface's name
</tp:docstring>
</arg> </arg>
</method> </method>
......
Supports Markdown
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