Commit 8b39c526 authored by Emmanuel Lepage Vallee's avatar Emmanuel Lepage Vallee
Browse files

* #29696: presence: add documentation

parent 33c9ce5d
../../../src/dbus/callmanager-introspec.xml
\ No newline at end of file
../../../src/client/dbus/callmanager-introspec.xml
\ No newline at end of file
../../../src/dbus/configurationmanager-introspec.xml
\ No newline at end of file
../../../src/client/dbus/configurationmanager-introspec.xml
\ No newline at end of file
../../../src/dbus/instance-introspec.xml
\ No newline at end of file
../../../src/client/dbus/instance-introspec.xml
\ No newline at end of file
../../../src/client/dbus/presencemanager-introspec.xml
\ No newline at end of file
......@@ -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>
......
......@@ -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>
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