From 8b39c52694ddaaf6c5caed02a50abdfa0e351873 Mon Sep 17 00:00:00 2001
From: Emmanuel Lepage Vallee <emmanuel.lepage@savoirfairelinux.com>
Date: Fri, 6 Sep 2013 13:09:13 -0400
Subject: [PATCH] * #29696: presence: add documentation
---
.../dbus-api/spec/callmanager-introspec.xml | 2 +-
.../spec/configurationmanager-introspec.xml | 2 +-
.../doc/dbus-api/spec/instance-introspec.xml | 2 +-
.../spec/presencemanager-introspec.xml | 1 +
.../dbus/configurationmanager-introspec.xml | 1 +
.../client/dbus/presencemanager-introspec.xml | 79 ++++++++++++++++---
6 files changed, 72 insertions(+), 15 deletions(-)
create mode 120000 daemon/doc/dbus-api/spec/presencemanager-introspec.xml
diff --git a/daemon/doc/dbus-api/spec/callmanager-introspec.xml b/daemon/doc/dbus-api/spec/callmanager-introspec.xml
index 2150eca25d..53db533cb4 120000
--- a/daemon/doc/dbus-api/spec/callmanager-introspec.xml
+++ b/daemon/doc/dbus-api/spec/callmanager-introspec.xml
@@ -1 +1 @@
-../../../src/dbus/callmanager-introspec.xml
\ No newline at end of file
+../../../src/client/dbus/callmanager-introspec.xml
\ No newline at end of file
diff --git a/daemon/doc/dbus-api/spec/configurationmanager-introspec.xml b/daemon/doc/dbus-api/spec/configurationmanager-introspec.xml
index d340519f1a..17ad4338ba 120000
--- a/daemon/doc/dbus-api/spec/configurationmanager-introspec.xml
+++ b/daemon/doc/dbus-api/spec/configurationmanager-introspec.xml
@@ -1 +1 @@
-../../../src/dbus/configurationmanager-introspec.xml
\ No newline at end of file
+../../../src/client/dbus/configurationmanager-introspec.xml
\ No newline at end of file
diff --git a/daemon/doc/dbus-api/spec/instance-introspec.xml b/daemon/doc/dbus-api/spec/instance-introspec.xml
index 2e02dfe723..c551629283 120000
--- a/daemon/doc/dbus-api/spec/instance-introspec.xml
+++ b/daemon/doc/dbus-api/spec/instance-introspec.xml
@@ -1 +1 @@
-../../../src/dbus/instance-introspec.xml
\ No newline at end of file
+../../../src/client/dbus/instance-introspec.xml
\ No newline at end of file
diff --git a/daemon/doc/dbus-api/spec/presencemanager-introspec.xml b/daemon/doc/dbus-api/spec/presencemanager-introspec.xml
new file mode 120000
index 0000000000..19c1ff524a
--- /dev/null
+++ b/daemon/doc/dbus-api/spec/presencemanager-introspec.xml
@@ -0,0 +1 @@
+../../../src/client/dbus/presencemanager-introspec.xml
\ No newline at end of file
diff --git a/daemon/src/client/dbus/configurationmanager-introspec.xml b/daemon/src/client/dbus/configurationmanager-introspec.xml
index bc6f3d7b9d..cb4660b250 100644
--- a/daemon/src/client/dbus/configurationmanager-introspec.xml
+++ b/daemon/src/client/dbus/configurationmanager-introspec.xml
@@ -46,6 +46,7 @@
<li>ACCOUNT_REGISTRATION_STATUS: The account registration status. Should be Registered to make calls.</li>
<li>ACCOUNT_REGISTRATION_STATE_CODE</li>
<li>ACCOUNT_REGISTRATION_STATE_DESC</li>
+ <li>CONFIG_DEFAULT_PRESENCE_ENABLED: enable/disable presence support - true or false</li>
<li>SRTP_KEY_EXCHANGE</li>
<li>SRTP_ENABLE: Whether or not voice communication are encrypted - True or False (Default: False)</li>
<li>SRTP_RTP_FALLBACK</li>
diff --git a/daemon/src/client/dbus/presencemanager-introspec.xml b/daemon/src/client/dbus/presencemanager-introspec.xml
index d61ea14c8c..800c1b72b8 100644
--- a/daemon/src/client/dbus/presencemanager-introspec.xml
+++ b/daemon/src/client/dbus/presencemanager-introspec.xml
@@ -5,36 +5,91 @@
<!-- METHODS !-->
<method name="sendPresence" tp:name-for-bindings="sendPresence">
<tp:added version="1.3.0"/>
- <arg type="s" name="accountID" direction="in"/>
- <arg type="b" name="status" direction="in"/>
- <arg type="s" name="note" direction="in"/>
+ <arg type="s" name="accountID" direction="in">
+ <tp:docstring>
+ The account from which the presence will be emitted
+ </tp:docstring>
+ </arg>
+ <arg type="b" name="status" direction="in">
+ <tp:docstring>
+ Is this account present or not
+ </tp:docstring>
+ </arg>
+ <arg type="s" name="note" direction="in">
+ <tp:docstring>
+ A message transmitted by the server to other users
+ </tp:docstring>
+ </arg>
</method>
<method name="approvePresSubServer" tp:name-for-bindings="approvePresSubServer">
+ <tp:docstring>
+ Answer a presence request from the server
+ </tp:docstring>
<tp:added version="1.3.0"/>
- <arg type="s" name="uri" direction="in"/>
- <arg type="b" name="flag" direction="in"/>
+ <arg type="s" name="uri" direction="in">
+ <tp:docstring>
+ </tp:docstring>
+ </arg>
+ <arg type="b" name="flag" direction="in">
+ <tp:docstring>
+ Is the request granted or denied
+ </tp:docstring>
+ </arg>
</method>
<method name="subscribePresSubClient" tp:name-for-bindings="subscribePresSubClient">
+ <tp:docstring>
+ Ask be be notified when 'uri' presence change
+ </tp:docstring>
<tp:added version="1.3.0"/>
- <arg type="s" name="accountID" direction="in"/>
- <arg type="s" name="uri" direction="in"/>
- <arg type="b" name="flag" direction="in"/>
+ <arg type="s" name="accountID" direction="in">
+ <tp:docstring>
+ An account from which get request presence informations
+ </tp:docstring>
+ </arg>
+ <arg type="s" name="uri" direction="in">
+ <tp:docstring>
+ A SIP uri to watch
+ </tp:docstring>
+ </arg>
+ <arg type="b" name="flag" direction="in">
+ <tp:docstring>
+ </tp:docstring>
+ </arg>
</method>
<!-- SIGNALS !-->
<signal name="newPresSubClientNotification" tp:name-for-bindings="newPresSubClientNotification">
<tp:added version="1.3.0"/>
- <arg type="s" name="buddyUri"/>
- <arg type="s" name="status"/>
- <arg type="s" name="lineStatus"/>
+ <tp:docstring>
+ Notify when a registered presence uri presence informations changes
+ </tp:docstring>
+ <arg type="s" name="buddyUri">
+ <tp:docstring>
+ The registered URI
+ </tp:docstring>
+ </arg>
+ <arg type="s" name="status">
+ <tp:docstring>
+ Is the URI present or not
+ </tp:docstring>
+ </arg>
+ <arg type="s" name="lineStatus">
+ <tp:docstring>
+ A string containing informations from the user (human readable)
+ </tp:docstring>
+ </arg>
</signal>
<signal name="newPresSubServerRequest" tp:name-for-bindings="newPresSubServerRequest">
<tp:added version="1.3.0"/>
- <arg type="s" name="buddyUri"/>
+ <arg type="s" name="buddyUri">
+ <tp:docstring>
+ Notify when an other user (or the server) request your presence informations
+ </tp:docstring>
+ </arg>
</signal>
</interface>
</node>
--
GitLab