Show last authors
1 // Documentation based on repostory git version commit 2.2.0-alpha-10-ge6a6109b //
2
3 =Module Presence=
4
5 This module transfers SIP presence messages, like subscribe/notify/publish to a presence server.
6 {{{--}}}{{{--}}}
7
8 Configuration options:
9 |=(% style="text-align: center; border: 1px solid #999" %)Name|=(% style="text-align: center; border: 1px solid #999" %)Description|=(% style="text-align: center; border: 1px solid #999" %)Default Value|=(% style="text-align: center; border: 1px solid #999" %)Type
10 |=(% style="text-align: center; vertical-align: middle; border: 1px solid #999" %)enabled|(% style="text-align: left; border: 1px solid #999" %)(((Indicate whether the module is activated~.)))|(% style="text-align: center; vertical-align: middle; border: 1px solid #999" %) ##false##|(% style="text-align: center; vertical-align: middle; border: 1px solid #999" %)Boolean
11 |=(% style="text-align: center; vertical-align: middle; border: 1px solid #999" %)filter|(% style="text-align: left; border: 1px solid #999" %)(((A request~/response enters module if the boolean filter evaluates to true~. Ex~: from~.uri~.domain contains ~'sip~.linphone~.org~'~, from~.uri~.domain in ~'a~.org b~.org c~.org~'~, ~(to~.uri~.domain in ~'a~.org b~.org c~.org~'~) ~&~& ~(user~-agent ~=~= ~'Linphone v2~'~)~. You can consult the full filter documentation here ~: https~:~/~/wiki~.linphone~.org~/xwiki~/wiki~/public~/view~/Flexisip~/Configuration~/Filter~%20syntax~/)))|(% style="text-align: center; vertical-align: middle; border: 1px solid #999" %) ##is~_request ~&~& ~(request~.method~-name ~=~= ~'PUBLISH~' ~|~| request~.method~-name ~=~= ~'NOTIFY~' ~|~| request~.method~-name ~=~= ~'SUBSCRIBE~'~)##|(% style="text-align: center; vertical-align: middle; border: 1px solid #999" %)BooleanExpr
12 |=(% style="text-align: center; vertical-align: middle; border: 1px solid #999" %)presence-server|(% style="text-align: left; border: 1px solid #999" %)(((A SIP URI where to send all presence related requests~.)))|(% style="text-align: center; vertical-align: middle; border: 1px solid #999" %) ##sip~:127~.0~.0~.1~:5065~;transport~=tcp##|(% style="text-align: center; vertical-align: middle; border: 1px solid #999" %)String
13 |=(% style="text-align: center; vertical-align: middle; border: 1px solid #999" %)only-list-subscription|(% style="text-align: left; border: 1px solid #999" %)(((If true~, only manage list subscription~.)))|(% style="text-align: center; vertical-align: middle; border: 1px solid #999" %) ##false##|(% style="text-align: center; vertical-align: middle; border: 1px solid #999" %)BooleanExpr
14 |=(% style="text-align: center; vertical-align: middle; border: 1px solid #999" %)check-domain-in-presence-results|(% style="text-align: left; border: 1px solid #999" %)(((When getting the list of users with phones~, if this setting is enabled~, it will limit the results to the ones that have the same domain~.)))|(% style="text-align: center; vertical-align: middle; border: 1px solid #999" %) ##false##|(% style="text-align: center; vertical-align: middle; border: 1px solid #999" %)Boolean