configurationmanager-introspec.xml 31.7 KB
Newer Older
Pierre-Luc Beaudoin's avatar
Pierre-Luc Beaudoin committed
1
<?xml version="1.0" ?>
2
<node name="/configurationmanager-introspec" xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0">
Adrien Béraud's avatar
Adrien Béraud committed
3
    <interface name="cx.ring.Ring.ConfigurationManager">
4 5 6 7 8

        <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
            Used to handle the configuration stuff: accounts settings, account registration, user preferences, ...
        </tp:docstring>

9
        <method name="getAccountTemplate" tp:name-for-bindings="getAccountTemplate">
10
            <annotation name="org.qtproject.QtDBus.QtTypeName.Out0" value="MapStringString"/>
11 12 13 14
            <arg type="a{ss}" name="details" direction="out" tp:type="String_String_Map">
            </arg>
        </method>

15
        <method name="getAccountDetails" tp:name-for-bindings="getAccountDetails">
16
            <tp:docstring>
17
                Get all parameters of the specified account.
18
            </tp:docstring>
19 20 21 22 23
            <arg type="s" name="accountID" direction="in">
                <tp:docstring>
                    The account ID
                </tp:docstring>
            </arg>
24
            <annotation name="org.qtproject.QtDBus.QtTypeName.Out0" value="MapStringString"/>
25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45
            <arg type="a{ss}" name="details" direction="out" tp:type="String_String_Map">
                <tp:docstring>
                    The available keys / parameters are:
                    <ul>
                        <li>CONFIG_ACCOUNT_ENABLE:    True or False (Default: True)</li>
                        <li>CONFIG_ACCOUNT_RESOLVE_ONCE</li>
                        <li>CONFIG_ACCOUNT_TYPE: SIP or IAX2 (Default: SIP)</li>
                        <li>HOSTNAME: The IP adress or hostname of the registrar</li>
                        <li>USERNAME: The username (or extension) of the account</li>
                        <li>PASSWORD: The password associated to the account</li>
                        <li>REALM</li>
                        <li>CONFIG_ACCOUNT_MAILBOX: Number to dial to access the voicemail box</li>
                        <li>CONFIG_ACCOUNT_REGISTRATION_EXPIRE: SIP header expiration value (Default: 1600)</li>
                        <li>LOCAL_INTERFACE: The network interface (Default: eth0)</li>
                        <li>PUBLISHED_SAMEAS_LOCAL: If False, the published address equals the local address. This is the default.</li>
                        <li>PUBLISHED_ADDRESS: The SIP published address</li>
                        <li>LOCAL_PORT: The SIP listening port (Default: 5060)</li>
                        <li>PUBLISHED_PORT: The SIP published port</li>
                        <li>DISPLAY_NAMEL: The display name</li>
                        <li>STUN_ENABLE: True or False (Default: False)</li>
                        <li>STUN_SERVER: The STUN server address</li>
46 47 48
                        <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>
49
                        <li>CONFIG_DEFAULT_PRESENCE_ENABLED: enable/disable presence support - true or false</li>
50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73
                        <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>
                        <li>ZRTP_DISPLAY_SAS</li>
                        <li>ZRTP_DISPLAY_SAS_ONCE</li>
                        <li>ZRTP_HELLO_HASH</li>
                        <li>ZRTP_NOT_SUPP_WARNING</li>
                        <li>TLS_LISTENER_PORT: TLS listening port (Default: 5061)</li>
                        <li>TLS_ENABLE: Whether or not signalling is encrypted - True or False (Default: False)</li>
                        <li>TLS_CA_LIST_FILE</li>
                        <li>TLS_CERTIFICATE_FILE</li>
                        <li>TLS_PRIVATE_KEY_FILE</li>
                        <li>TLS_METHOD</li>
                        <li>TLS_CIPHERS</li>
                        <li>TLS_SERVER_NAME</li>
                        <li>TLS_VERIFY_SERVER</li>
                        <li>TLS_VERIFY_CLIENT</li>
                        <li>TLS_REQUIRE_CLIENT_CERTIFICATE</li>
                        <li>TLS_NEGOTIATION_TIMEOUT_SEC</li>
                    </ul>
                </tp:docstring>
            </arg>
        </method>

74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92
        <method name="getVolatileAccountDetails" tp:name-for-bindings="getVolatileAccountDetails">
           <arg type="s" name="accountID" direction="in">
               <tp:docstring>
                   The account ID
               </tp:docstring>
           </arg>
           <annotation name="org.qtproject.QtDBus.QtTypeName.Out0" value="MapStringString"/>
           <arg type="a{ss}" name="details" tp:type="String_String_Map" direction="out">
               <tp:docstring>
                   Account.registrationCoarseStatus      ( Coarse status like, UNREGISTERED or TRYING )
                   Account.registrationStatus            ( Error code, like 200 (OK) or 408 (Timeout) )
                   Account.registrationStatusDescription ( A technical error message (from PJSIP)     )
                   Account.lastSuccessfulRegister        ( Timestamp of the last "REGISTERED" event   )
                   Account.presenceStatus                ( Published presence status                  )
                   Account.presenceNote                  ( Published presence note (status string)    )
               </tp:docstring>
           </arg>
       </method>

93 94 95
        <method name="setAccountDetails" tp:name-for-bindings="setAccountDetails">
            <tp:docstring>
                Send new account parameters, or account parameters changes, to the core. The hash table is not required to be complete, only the updated parameters may be specified.
Adrien Béraud's avatar
Adrien Béraud committed
96
                <tp:rationale>Account settings are written to the configuration file when ring properly quits.</tp:rationale>
97 98
                <tp:rationale>After calling this method, the core will emit the signal <tp:member-ref>accountsChanged</tp:member-ref> with the updated data. The client must subscribe to this signal and use it to update its internal data structure.</tp:rationale>
            </tp:docstring>
99
            <annotation name="org.qtproject.QtDBus.QtTypeName.In1" value="MapStringString"/>
100 101 102 103 104 105 106 107 108
            <arg type="s" name="accountID" direction="in">
            </arg>
            <arg type="a{ss}" name="details" direction="in" tp:type="String_String_Map">
            </arg>
        </method>

        <method name="setCredentials" tp:name-for-bindings="setCredentials">
            <arg type="s" name="accountID" direction="in">
            </arg>
109
            <annotation name="org.qtproject.QtDBus.QtTypeName.In1" value="VectorMapStringString"/>
110 111 112 113 114
            <arg type="aa{ss}" name="credentialInformation" direction="in" tp:type="String_String_Map">
            </arg>
        </method>

        <method name="getIp2IpDetails" tp:name-for-bindings="getIp2IpDetails">
115 116 117
            <tp:docstring>
            Get configuration settings of the IP2IP_PROFILE. They are sligthly different from account settings since no VoIP accounts are involved.
            </tp:docstring>
118
            <annotation name="org.qtproject.QtDBus.QtTypeName.Out0" value="MapStringString"/>
119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148
            <arg type="a{ss}" name="details" direction="out" tp:type="String_String_Map">
            <tp:docstring>
            Available parameters are:
            <ul>
            <li>ACCOUNT_ID</li>
            <li>SRTP_KEY_EXCHANGE</li>
            <li>SRTP_ENABLE</li>
            <li>SRTP_RTP_FALLBACK</li>
            <li>ZRTP_DISPLAY_SAS</li>
            <li>ZRTP_HELLO_HASH</li>
            <li>ZRTP_NOT_SUPP_WARNING</li>
            <li>ZRTP_DISPLAY_SAS_ONCE</li>
            <li>LOCAL_INTERFACE</li>
            <li>LOCAL_PORT</li>
            <li>TLS_LISTENER_PORT</li>
            <li>TLS_CA_LIST_FILE</li>
            <li>TLS_CERTIFICATE_FILE</li>
            <li>TLS_PRIVATE_KEY_FILE</li>
            <li>TLS_PASSWORD</li>
            <li>TLS_METHOD</li>
            <li>TLS_CIPHERS</li>
            <li>TLS_SERVER_NAME</li>
            <li>TLS_VERIFY_SERVER</li>
            <li>TLS_VERIFY_CLIENT</li>
            <li>TLS_REQUIRE_CLIENT_CERTIFICATE</li>
            <li>TLS_NEGOTIATION_TIMEOUT_SEC</li>
            </ul>
            </tp:docstring>
            </arg>
        </method>
149

150 151 152
       <method name="getCredentials" tp:name-for-bindings="getCredentials">
           <arg type="s" name="accountID" direction="in">
           </arg>
153
           <annotation name="org.qtproject.QtDBus.QtTypeName.Out0" value="VectorMapStringString"/>
154 155 156 157 158 159 160 161 162 163
           <arg type="aa{ss}" name="credentialInformation" direction="out">
           </arg>
       </method>

       <method name="addAccount" tp:name-for-bindings="addAccount">
           <tp:docstring>
               Add a new account. When created, the signal <tp:member-ref>accountsChanged</tp:member-ref> is emitted. The clients must then call <tp:member-ref>getAccountList</tp:member-ref> to update their internal data structure.
               <tp:rationale>If no details are specified, the default parameters are used.</tp:rationale>
               <tp:rationale>The core tries to register the account as soon it is created.</tp:rationale>
           </tp:docstring>
164
           <annotation name="org.qtproject.QtDBus.QtTypeName.In0" value="MapStringString"/>
165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203
           <arg type="a{ss}" name="details" direction="in"  tp:type="String_String_Map">
               <tp:docstring>
                    The new account settings
               </tp:docstring>
           </arg>
           <arg type="s" name="createdAccountId" direction="out">
               <tp:docstring>
                    A new account ID
               </tp:docstring>
           </arg>
       </method>

       <method name="setAccountsOrder" tp:name-for-bindings="setAccountsOrder">
           <tp:docstring>
                Update the accounts order.
                <tp:rationale>When placing a call, the first registered account in the list is used.</tp:rationale>
           </tp:docstring>
           <arg type="s" name="order" direction="in">
               <tp:docstring>
                   An ordered list of account IDs, delimited by '/'
               </tp:docstring>
           </arg>
       </method>

       <method name="removeAccount" tp:name-for-bindings="removeAccount">
           <tp:docstring>
               Remove an existing account. When removed, the signal <tp:member-ref>accountsChanged</tp:member-ref> is emitted. The clients must then call <tp:member-ref>getAccountList</tp:member-ref> to update their internal data structure.
           </tp:docstring>
           <arg type="s" name="accoundID" direction="in">
               <tp:docstring>
                    The account to remove, identified by its ID
               </tp:docstring>
           </arg>
       </method>

       <method name="getAccountList" tp:name-for-bindings="getAccountList">
           <tp:docstring>
                Get a list of all created accounts, as stored by the core.
           </tp:docstring>
204
           <annotation name="org.qtproject.QtDBus.QtTypeName.Out0" value="VectorString"/>
205 206 207 208 209 210 211
           <arg type="as" name="list" direction="out">
               <tp:docstring>
                   A list of account IDs
               </tp:docstring>
           </arg>
       </method>

212 213
       <method name="registerAllAccounts" tp:name-for-bindings="registerAllAccounts">
           <tp:docstring>
214
                Send account registration (REGISTER) for all accounts, even if they are not enabled.
215 216 217
           </tp:docstring>
       </method>

218 219 220
       <method name="sendRegister" tp:name-for-bindings="sendRegister">
           <tp:docstring>
                Send account registration (REGISTER) to the registrar.
221
                Register the account if enable=true, unregister if enable=false.
222 223 224 225 226 227
           </tp:docstring>
           <arg type="s" name="accountID" direction="in">
               <tp:docstring>
                    The account ID
               </tp:docstring>
           </arg>
228
           <arg type="b" name="enable" direction="in">
229
               <tp:docstring>
230 231
                    <p>To register, enable must be true.</p>
                    <p>To un-register, enable must be false.</p>
232 233 234 235
               </tp:docstring>
           </arg>
       </method>

236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286
       <method name="setVolume" tp:name-for-bindings="setVolume">
           <tp:docstring>
             <p>Sets the volume using a linear scale [0,100].</p>
             <tp:rationale>Pulseaudio has its own mechanism to modify application volume. This method is enabled only if the ALSA API is used.</tp:rationale>
           </tp:docstring>
           <arg type="s" name="device" direction="in">
             <tp:docstring>
               The device: mic or speaker
             </tp:docstring>
           </arg>
           <arg type="d" name="value" direction="in">
             <tp:docstring>
               The volume value (between 0 and 100)
             </tp:docstring>
           </arg>
       </method>

       <method name="getVolume" tp:name-for-bindings="getVolume">
           <tp:docstring>
             <p>Return the volume value of the given device on a linear scale [0,100].</p>
             <tp:rationale>Only enabled if the ALSA API is used, Pulseaudio has its own mechanism to modify application volume.</tp:rationale>
           </tp:docstring>
           <arg type="s" name="device" direction="in">
             <tp:docstring>
               The device: mic or speaker
             </tp:docstring>
           </arg>
           <arg type="d" name="value" direction="out">
             <tp:docstring>
               The volume value (between 0 and 100)
             </tp:docstring>
           </arg>
       </method>

       <signal name="volumeChanged" tp:name-for-bindings="volumeChanged">
               <tp:docstring>
             <p>Notify clients of a volume level change.</p>
             <p>This signal occurs only if ALSA is enabled since Pulseaudio streams are managed externally. </p>
           </tp:docstring>
           <arg type="s" name="device">
             <tp:docstring>
               The device: mic or speaker
             </tp:docstring>
           </arg>
           <arg type="d" name="value">
             <tp:docstring>
               The new volume value
             </tp:docstring>
           </arg>
       </signal>

287 288
       <!-- For now only expose these two options to clients -->
       <method name="muteDtmf" tp:name-for-bindings="muteDtmf">
289
           <arg type="b" name="mute" direction="in"/>
290 291 292 293
       </method>
       <method name="isDtmfMuted" tp:name-for-bindings="isDtmfMuted">
           <arg type="b" name="muted" direction="out"/>
       </method>
294

295 296 297
       <method name="muteCapture" tp:name-for-bindings="muteCapture">
           <arg type="b" name="mute" direction="in">
               <tp:docstring>
298
                   True to mute audio capture, false to unmute.
299 300 301 302 303 304 305
               </tp:docstring>
           </arg>
       </method>

       <method name="isCaptureMuted" tp:name-for-bindings="isCaptureMuted">
           <arg type="b" name="muted" direction="out">
               <tp:docstring>
306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322
                   Returns true if audio capture is muted, false otherwise.
               </tp:docstring>
           </arg>
       </method>

       <method name="mutePlayback" tp:name-for-bindings="mutePlayback">
           <arg type="b" name="mute" direction="in">
               <tp:docstring>
                   True to mute audio playback, false otherwise.
               </tp:docstring>
           </arg>
       </method>

       <method name="isPlaybackMuted" tp:name-for-bindings="isPlaybackMuted">
           <arg type="b" name="muted" direction="out">
               <tp:docstring>
                   Returns true if audio playback is muted, false otherwise.
323 324 325 326
               </tp:docstring>
           </arg>
       </method>

327 328 329 330 331 332 333 334
       <method name="getAudioManager" tp:name-for-bindings="getAudioManager">
           <arg type="s" name="api" direction="out">
           </arg>
       </method>

       <method name="setAudioManager" tp:name-for-bindings="setAudioManager">
           <arg type="s" name="api" direction="in">
           </arg>
335 336
           <arg type="b" name="successful" direction="out">
           </arg>
337 338
       </method>

339 340 341 342 343 344 345 346
       <method name="getSupportedAudioManagers" tp:name-for-bindings="getSupportedAudioManagers">
           <tp:docstring>
               Returns a list of compiled audio backends.
           </tp:docstring>
           <arg type="as" name="api" direction="out">
           </arg>
       </method>

347 348 349 350 351 352 353 354 355
       <method name="getRecordPath" tp:name-for-bindings="getRecordPath">
           <arg type="s" name="rec" direction="out">
           </arg>
       </method>

       <method name="setRecordPath" tp:name-for-bindings="setRecordPath">
           <arg type="s" name="rec" direction="in">
           </arg>
       </method>
356

357 358 359 360 361 362 363 364 365 366 367 368 369 370 371
       <method name="getIsAlwaysRecording" tp:name-for-bindings="getIsAlwaysRecording">
           <arg type="b" name="res" direction="out">
           </arg>
       </method>

       <method name="setIsAlwaysRecording" tp:name-for-bindings="setIsAlwaysRecording">
           <arg type="b" name="enabled" direction="in">
           </arg>
       </method>

       <!--      ///////////////////////               -->

       <!-- Codecs-related methods -->

       <method name="getAudioCodecList" tp:name-for-bindings="getAudioCodecList">
372
           <annotation name="org.qtproject.QtDBus.QtTypeName.Out0" value="VectorInt"/>
373 374 375 376 377 378 379
           <arg type="ai" name="list" direction="out">
           </arg>
       </method>

       <method name="getAudioCodecDetails" tp:name-for-bindings="getAudioCodecDetails">
           <arg type="i" name="payload" direction="in">
           </arg>
380
           <annotation name="org.qtproject.QtDBus.QtTypeName.Out0" value="VectorString"/>
381 382 383 384 385
           <arg type="as" name="details" direction="out">
           </arg>
       </method>

       <method name="getActiveAudioCodecList" tp:name-for-bindings="getActiveAudioCodecList">
386
           <annotation name="org.qtproject.QtDBus.QtTypeName.Out0" value="VectorInt"/>
387 388 389 390 391 392 393
           <arg type="s" name="accountID" direction="in">
           </arg>
           <arg type="ai" name="list" direction="out">
           </arg>
       </method>

       <method name="setActiveAudioCodecList" tp:name-for-bindings="setActiveAudioCodecList">
394
           <annotation name="org.qtproject.QtDBus.QtTypeName.In0" value="VectorString"/>
395 396 397 398 399
           <arg type="as" name="list" direction="in">
           </arg>
           <arg type="s" name="accountID" direction="in">
           </arg>
       </method>
400

401 402 403
       <!-- Audio devices methods -->

       <method name="getAudioPluginList" tp:name-for-bindings="getAudioPluginList">
404
           <annotation name="org.qtproject.QtDBus.QtTypeName.Out0" value="VectorString"/>
405 406 407 408 409 410 411 412 413 414
           <arg type="as" name="list" direction="out">
           </arg>
       </method>

       <method name="setAudioPlugin" tp:name-for-bindings="setAudioPlugin">
           <arg type="s" name="audioPlugin" direction="in">
           </arg>
       </method>

       <method name="getAudioOutputDeviceList" tp:name-for-bindings="getAudioOutputDeviceList">
415
           <annotation name="org.qtproject.QtDBus.QtTypeName.Out0" value="VectorString"/>
416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435
           <arg type="as" name="list" direction="out">
           </arg>
       </method>

       <method name="setAudioOutputDevice" tp:name-for-bindings="setAudioOutputDevice">
           <arg type="i" name="index" direction="in">
           </arg>
       </method>

       <method name="setAudioInputDevice" tp:name-for-bindings="setAudioInputDevice">
           <arg type="i" name="index" direction="in">
           </arg>
       </method>

       <method name="setAudioRingtoneDevice" tp:name-for-bindings="setAudioRingtoneDevice">
           <arg type="i" name="index" direction="in">
           </arg>
       </method>

       <method name="getAudioInputDeviceList" tp:name-for-bindings="getAudioInputDeviceList">
436
           <annotation name="org.qtproject.QtDBus.QtTypeName.Out0" value="VectorString"/>
437 438 439 440 441 442
           <arg type="as" name="list" direction="out">
           </arg>
       </method>


       <method name="getCurrentAudioDevicesIndex" tp:name-for-bindings="getCurrentAudioDevicesIndex">
443
           <annotation name="org.qtproject.QtDBus.QtTypeName.Out0" value="VectorString"/>
444 445 446 447
           <arg type="as" name="list" direction="out">
           </arg>
       </method>

448
       <method name="getAudioInputDeviceIndex" tp:name-for-bindings="getAudioInputDeviceIndex">
449
           <arg type="s" name="devname" direction="in">
450 451 452 453 454 455
           </arg>
           <arg type="i" name="index" direction="out">
           </arg>
       </method>

       <method name="getAudioOutputDeviceIndex" tp:name-for-bindings="getAudioOutputDeviceIndex">
456
           <arg type="s" name="devname" direction="in">
457 458 459 460 461 462 463 464 465
           </arg>
           <arg type="i" name="index" direction="out">
           </arg>
       </method>

       <method name="getCurrentAudioOutputPlugin" tp:name-for-bindings="getCurrentAudioOutputPlugin">
           <arg type="s" name="plugin" direction="out">
           </arg>
       </method>
466

467 468
       <method name="getRingtoneList" tp:name-for-bindings="getRingtoneList">
           <tp:added version="1.1.1"/>
469
           <annotation name="org.qtproject.QtDBus.QtTypeName.Out0" value="MapStringString"/>
470 471 472
           <tp:docstring>
                Get a map [Path,Filename] of available ringtone. Note, set the ringtone with the complete path
           </tp:docstring>
473
           <arg type="a{ss}" name="list" direction="out">
474 475 476
           </arg>
       </method>

Tristan Matthews's avatar
Tristan Matthews committed
477
       <!--    General Settings Panel         -->
478

479
       <method name="getNoiseSuppressState" tp:name-for-bindings="getNoiseSuppressState">
480
           <arg type="b" name="state" direction="out">
481 482 483 484
           </arg>
       </method>

       <method name="setNoiseSuppressState" tp:name-for-bindings="setNoiseSuppressState">
485
               <arg type="b" name="state" direction="in">
486 487 488
               </arg>
       </method>

489
       <method name="isAgcEnabled" tp:name-for-bindings="isAgcEnabled">
490 491 492 493
           <arg type="b" name="enabled" direction="out">
           </arg>
       </method>

494
       <method name="setAgcState" tp:name-for-bindings="setAgcState">
495 496 497 498
               <arg type="b" name="enabled" direction="in">
               </arg>
       </method>

499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517
       <!--    General Settings Panel         -->

       <method name="isIax2Enabled" tp:name-for-bindings="isIax2Enabled">
           <arg type="i" name="res" direction="out">
           </arg>
       </method>

       <method name="getHistoryLimit" tp:name-for-bindings="getHistoryLimit">
           <arg type="i" name="days" direction="out">
           </arg>
       </method>

       <method name="setHistoryLimit" tp:name-for-bindings="setHistoryLimit">
           <arg type="i" name="days" direction="in">
           </arg>
       </method>

       <!-- Hook configuration -->
       <method name="getHookSettings" tp:name-for-bindings="getHookSettings">
518
           <annotation name="org.qtproject.QtDBus.QtTypeName.Out0" value="MapStringString"/>
519 520 521 522 523
           <arg type="a{ss}" name="settings" direction="out">
           </arg>
       </method>

       <method name="setHookSettings" tp:name-for-bindings="setHookSettings">
524
           <annotation name="org.qtproject.QtDBus.QtTypeName.In0" value="MapStringString"/>
525 526 527
           <arg type="a{ss}" name="settings" direction="in">
           </arg>
       </method>
528

529
       <method name="getHistory" tp:name-for-bindings="getHistory">
530
           <annotation name="org.qtproject.QtDBus.QtTypeName.Out0" value="VectorMapStringString"/>
531 532
           <!-- Return a List of type Dict<string, string> >...a List of Dicts -->
           <arg type="aa{ss}" name="entries" direction="out"/>
533
       </method>
534

535 536 537 538
       <method name="clearHistory" tp:name-for-bindings="clearHistory">
       </method>

       <signal name="accountsChanged" tp:name-for-bindings="accountsChanged">
539
       </signal>
540

541 542 543
       <signal name="historyChanged" tp:name-for-bindings="historyChanged">
       </signal>

544 545
       <!-- FIXME: we should rethink these two signals -->
       <!-- Used by IAX and SIP accounts -->
546 547 548 549 550
       <signal name="registrationStateChanged" tp:name-for-bindings="registrationStateChanged">
           <arg type="s" name="accountID"/>
           <arg type="i" name="registration_state"/>
       </signal>

551 552 553
       <!-- Only used by SIP accounts, data is directly from pjsip -->
       <signal name="sipRegistrationStateChanged" tp:name-for-bindings="sipRegistrationStateChanged">
           <tp:docstring>
Adrien Béraud's avatar
Adrien Béraud committed
554
               <p>Account state changed, Ring received a notification from registrar.</p>
555
           </tp:docstring>
556
           <annotation name="org.freedesktop.DBus.Deprecated" value="true"/>
557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573
           <arg type="s" name="accountID" >
               <tp:docstring>
                   The account ID
               </tp:docstring>
           </arg>
           <arg type="s" name="state">
               <tp:docstring>
                   Description string
               </tp:docstring>
           </arg>
           <arg type="i" name="code">
               <tp:docstring>
                   The SIP message code
               </tp:docstring>
           </arg>
       </signal>

574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591
       <signal name="volatileAccountDetailsChanged" tp:name-for-bindings="volatileAccountDetailsChanged">
           <arg type="s" name="accountID">
               <tp:docstring>
                   The account ID
               </tp:docstring>
           </arg>
           <annotation name="org.qtproject.QtDBus.QtTypeName.Out1" value="MapStringString"/>
           <arg type="a{ss}" name="details" tp:type="String_String_Map">
               <tp:docstring>
                   Account.registrationCoarseStatus      ( Coarse status like, UNREGISTERED or TRYING )
                   Account.registrationStatus            ( Error code, like 200 (OK) or 408 (Timeout) )
                   Account.registrationStatusDescription ( A technical error message (from PJSIP)     )
                   Account.lastSuccessfulRegister        ( Timestamp of the last "REGISTERED" event   )
                   Account.presenceStatus                ( Published presence status                  )
                   Account.presenceNote                  ( Published presence note (status string)    )
               </tp:docstring>
           </arg>
       </signal>
592

593 594 595 596 597 598 599 600 601 602
       <signal name="stunStatusFailure" tp:name-for_bindings="stunStatusFailure">
           <arg type="s" name="reason">
           </arg>
       </signal>

       <signal name="stunStatusSuccess" tp:name-for_bindings="stunStatusSuccess">
           <arg type="s" name="message">
           </arg>
       </signal>

603 604 605
       <signal name="errorAlert" tp:name-for-bindings="errorAlert">
           <arg type="i" name="code">
           </arg>
606
       </signal>
607 608 609

       <!-- TLS Methods -->
       <method name="getSupportedTlsMethod" tp:name-for-bindings="getSupportedTlsMethod">
610
           <annotation name="org.qtproject.QtDBus.QtTypeName.Out0" value="VectorString"/>
611 612 613 614
           <arg type="as" name="list" direction="out">
           </arg>
       </method>

615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634
        <method name="getSupportedCiphers" tp:name-for-bindings="getSupportedCiphers">
           <tp:added version="2.0.0"/>
           <tp:docstring>
                Returns a list of supported encryption ciphers used to encrypt SIP messages. The list depends on the TLS library being used.
                Only registered SIP accounts currently support setting custom ciphers. This method returns an empty list if TLS support is disabled in either pjproject or Ring.
           </tp:docstring>
           <arg type="s" name="accountID" direction="in">
                <tp:docstring>
                    A SIP account id, other account IDs will be rejected.
                </tp:docstring>
           </arg>
           <annotation name="org.qtproject.QtDBus.QtTypeName.Out0" value="VectorString"/>
           <arg type="as" name="list" direction="out">
               <tp:docstring>
                   A list of randomly sorted cipher names. The order may or may
                   not be significant depending on the SSL library being used.
               </tp:docstring>
           </arg>
       </method>

635
       <method name="getTlsSettingsDefault" tp:name-for-bindings="getTlsSettingsDefault">
636
                   <annotation name="org.qtproject.QtDBus.QtTypeName.Out0" value="MapStringString"/>
637 638 639 640 641
           <arg type="a{ss}" name="details" direction="out">
           </arg>
       </method>

       <method name="getTlsSettings" tp:name-for-bindings="getTlsSettings">
642
           <annotation name="org.qtproject.QtDBus.QtTypeName.Out0" value="MapStringString"/>
643 644 645 646 647
           <arg type="a{ss}" name="details" direction="out">
           </arg>
       </method>

       <method name="setTlsSettings" tp:name-for-bindings="setTlsSettings">
648
           <annotation name="org.qtproject.QtDBus.QtTypeName.In0" value="MapStringString"/>
649 650 651 652
           <arg type="a{ss}" name="details" direction="in">
           </arg>
       </method>

653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668
       <method name="validateCertificate" tp:name-for-bindings="validateCertificate">
           <arg type="s" name="accountId" direction="in"></arg>
           <arg type="s" name="certificatePath" direction="in">
              <tp:docstring>
               <p>A certificate path</p>
              </tp:docstring>
           </arg>
           <arg type="s" name="privateKeyPath" direction="in">
              <tp:docstring>
               <p>An optional path a the private key for the certificate</p>
              </tp:docstring>
           </arg>
           <annotation name="org.qtproject.QtDBus.QtTypeName.Out0" value="MapStringString"/>
           <arg type="a{ss}" name="details" direction="out">
              <tp:docstring>
               <p>A key-value list of all certificate validation</p>
669
               The constants used as keys are defined in the "security.h" constants header file
670 671 672 673 674 675 676 677 678 679 680 681 682 683
              </tp:docstring>
           </arg>
       </method>

       <method name="getCertificateDetails" tp:name-for-bindings="getCertificateDetails">
           <arg type="s" name="certificatePath" direction="in">
              <tp:docstring>
               <p>A certificate path</p>
              </tp:docstring>
           </arg>
           <annotation name="org.qtproject.QtDBus.QtTypeName.Out0" value="MapStringString"/>
           <arg type="a{ss}" name="details" direction="out">
              <tp:docstring>
               <p>A key-value list of all certificate details</p>
684
               The constants used as keys are defined in the "security.h" constants header file
685 686 687 688
              </tp:docstring>
           </arg>
       </method>

689 690 691 692 693 694 695 696
       <method name="getAddrFromInterfaceName" tp:name-for-bindings="getAddrFromInterfaceName">
           <arg type="s" name="interface" direction="in">
           </arg>
           <arg type="s" name="address" direction="out">
           </arg>
       </method>

       <method name="getAllIpInterface" tp:name-for-bindings="getAllIpInterface">
697
           <annotation name="org.qtproject.QtDBus.QtTypeName.Out0" value="VectorString"/>
698 699 700 701 702
           <arg type="as" name="list" direction="out">
           </arg>
       </method>

       <method name="getAllIpInterfaceByName" tp:name-for-bindings="getAllIpInterfaceByName">
703
           <annotation name="org.qtproject.QtDBus.QtTypeName.Out0" value="VectorString"/>
704 705 706 707 708
           <arg type="as" name="list" direction="out">
           </arg>
       </method>

       <method name="getShortcuts" tp:name-for-bindings="getShortcuts">
709
                   <annotation name="org.qtproject.QtDBus.QtTypeName.Out0" value="MapStringString"/>
710 711 712 713 714
           <arg type="a{ss}" name="shortcutsMap" direction="out">
           </arg>
       </method>

       <method name="setShortcuts" tp:name-for-bindings="setShortcuts">
715
                   <annotation name="org.qtproject.QtDBus.QtTypeName.In0" value="MapStringString"/>
716 717 718
           <arg type="a{ss}" name="shortcutsMap" direction="in">
           </arg>
       </method>
719
   </interface>
720
</node>