dbus-interfaces.xml 27.5 KB
Newer Older
1 2 3
<!DOCTYPE node PUBLIC
"-//freedesktop//DTD D-BUS Object Introspection 1.0//EN"
"http://www.freedesktop.org/standards/dbus/1.0/introspect.dtd">
4 5

<!--
Debarshi Ray's avatar
Debarshi Ray committed
6 7
 Copyright © 2014 Pranav Kant
 Copyright © 2011 – 2017 Red Hat, Inc.
8 9 10 11 12 13 14 15 16 17 18 19

 This library is free software; you can redistribute it and/or
 modify it under the terms of the GNU Lesser General Public
 License as published by the Free Software Foundation; either
 version 2 of the License, or (at your option) any later version.

 This library is distributed in the hope that it will be useful,
 but WITHOUT ANY WARRANTY; without even the implied warranty of
 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 Lesser General Public License for more details.

 You should have received a copy of the GNU Lesser General
Daniel Mustieles's avatar
Daniel Mustieles committed
20
 Public License along with this library; if not, see <http://www.gnu.org/licenses/>.
21 22
-->

23 24 25 26 27 28 29
<node name="/" xmlns:doc="http://www.freedesktop.org/dbus/1.0/doc.dtd">

  <!-- ********************************************************************** -->

  <!--
      org.gnome.OnlineAccounts.Account:

30
      The base account interface.
31 32
  -->
  <interface name="org.gnome.OnlineAccounts.Account">
David Zeuthen's avatar
David Zeuthen committed
33 34 35 36 37 38 39 40 41
    <!--
        ProviderType:
        The type of provider of the account.

        This value describes how data is accessed, e.g. what API
        applications should use. Use
        #org.gnome.OnlineAccounts.Account:ProviderName for the name of
        the provider (which might differ from the provider name in
        hosted scenarios) to display in the user interface.
42
    -->
43
    <property name="ProviderType" type="s" access="read"/>
44

David Zeuthen's avatar
David Zeuthen committed
45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62
    <!--
        ProviderName:
        The name of the provider to display in the user interface.
    -->
    <property name="ProviderName" type="s" access="read"/>

    <!--
        ProviderIcon:
        The icon/logo of the provider.

        This is a serialized <ulink
        url="http://developer.gnome.org/gio/unstable/GIcon.html">GIcon</ulink>
        - use e.g. <ulink
        url="http://developer.gnome.org/gio/unstable/GIcon.html#g-icon-new-for-string">g_icon_new_for_string()</ulink>
        to create an instance.
    -->
    <property name="ProviderIcon" type="s" access="read"/>

63 64 65 66
    <!-- Id: An identifier for this account.
         This identifier cannot be changed and should never be
         displayed in any user interface.
      -->
67 68
    <property name="Id" type="s" access="read"/>

Debarshi Ray's avatar
Debarshi Ray committed
69 70 71 72 73 74 75 76 77 78 79
    <!-- IsLocked:
         @since: 3.16.0

         Whether or not the user is discouraged from removing this account.

         Locked accounts can be those that there added by the administrator to
         pre-configure systems in an enterprise deployment. If %TRUE, the UI
         should prevent, or atleast discourage, removal of these accounts.
    -->
    <property name="IsLocked" type="b" access="read"/>

80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95
    <!-- IsTemporary:

         Whether or not the account is remembered from session to session.

         Temporary accounts are added implicitly when the user is granted
         credentials from some mechanism other than Online Accounts, but that
         Online Accounts still knows how to deal with.

         They are specific to the machine/session and are silently disregarded
         after logout.

         Accounts are permanant by default unless created with "IsTemporary"
         "true" detail.
      -->
    <property name="IsTemporary" type="b" access="readwrite"/>

David Zeuthen's avatar
David Zeuthen committed
96
    <!-- AttentionNeeded: Set to %TRUE if the account is in need of attention.
97 98

         This is used when a human operator is needed to service the
99
         account (e.g. for authentication and/or authorization).
100
      -->
101
    <property name="AttentionNeeded" type="b" access="read"/>
102

103 104 105 106 107 108 109 110
    <!-- Identity:
         A string that uniquely identifies the account at the
         provider.

         Note that this may be the same string for different kinds of
         providers (for example, if the user is using the same
         email-address for several providers) - use
         #org.gnome.OnlineAccounts.Account:Id to uniquely identify the
111
         account.
112 113 114 115 116 117 118 119 120 121 122 123

         This string might not be suitable for presentation in an user
         interface - use
         #org.gnome.OnlineAccounts.Account:PresentationIdentity instead.
    -->
    <property name="Identity" type="s" access="read"/>

    <!-- PresentationIdentity:
         Like the #org.gnome.OnlineAccounts.Account:Identity property but
         suitable for presentation in an user interface.
    -->
    <property name="PresentationIdentity" type="s" access="read"/>
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 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176
    <!-- MailDisabled:
         If %TRUE, the account will not expose any
         #org.gnome.OnlineAccounts.Mail interface. If the account does not
         provide email-like messaging capabilities, this property does
         nothing.

         Note that the #org.gnomeOnlineAccounts.Mail interface is added or
         removed from the account asynchronously.
    -->
    <property name="MailDisabled" type="b" access="readwrite"/>

    <!-- CalendarDisabled:
         If %TRUE, the account will not expose any
         #org.gnome.OnlineAccounts.Calendar interface. If the account does not
         provide calendar-like capabilities, this property does nothing.

         Note that the #org.gnomeOnlineAccounts.Calendar interface is added or
         removed from the account asynchronously.
    -->
    <property name="CalendarDisabled" type="b" access="readwrite"/>

    <!-- ContactsDisabled:
         If %TRUE, the account will not expose any
         #org.gnome.OnlineAccounts.Contacts interface. If the account does not
         provide contacts-like capabilities, this property does nothing.

         Note that the #org.gnomeOnlineAccounts.Contacts interface is added or
         removed from the account asynchronously.
    -->
    <property name="ContactsDisabled" type="b" access="readwrite"/>

    <!-- ChatDisabled:
         If %TRUE, the account will not expose any
         #org.gnome.OnlineAccounts.Chat interface. If the account does not
         provide chat-like messaging capabilities, this property does
         nothing.

         Note that the #org.gnomeOnlineAccounts.Chat interface is added or
         removed from the account asynchronously.
    -->
    <property name="ChatDisabled" type="b" access="readwrite"/>

    <!-- DocumentsDisabled:
         If %TRUE, the account will not expose any
         #org.gnome.OnlineAccounts.Documents interface. If the account does not
         provide documents-like capabilities, this property does nothing.

         Note that the #org.gnomeOnlineAccounts.Documents interface is added or
         removed from the account asynchronously.
    -->
    <property name="DocumentsDisabled" type="b" access="readwrite"/>

177 178 179 180 181 182 183 184 185 186 187 188
    <!-- MapsDisabled:
         @since: 3.14.0

         If %TRUE, the account will not expose any
         #org.gnome.OnlineAccounts.Maps interface. If the account does not
         provide maps-like capabilities, this property does nothing.

         Note that the #org.gnomeOnlineAccounts.Maps interface is added or
         removed from the account asynchronously.
    -->
    <property name="MapsDisabled" type="b" access="readwrite"/>

189 190 191 192 193 194 195 196 197 198 199 200
    <!-- MusicDisabled:
         @since: 3.18.0

         If %TRUE, the account will not expose any
         #org.gnome.OnlineAccounts.Music interface. If the account does not
         provide music-like capabilities, this property does nothing.

         Note that the #org.gnomeOnlineAccounts.Music interface is added or
         removed from the account asynchronously.
    -->
    <property name="MusicDisabled" type="b" access="readwrite"/>

201 202 203 204 205 206 207 208 209 210 211 212
    <!-- PrintersDisabled:
         @since: 3.12.0

         If %TRUE, the account will not expose any
         #org.gnome.OnlineAccounts.Printers interface. If the account does not
         provide printers-like capabilities, this property does nothing.

         Note that the #org.gnomeOnlineAccounts.Printers interface is added or
         removed from the account asynchronously.
    -->
    <property name="PrintersDisabled" type="b" access="readwrite"/>

213 214 215 216 217 218 219 220 221 222 223 224
    <!-- PhotosDisabled:
         @since: 3.8.0

         If %TRUE, the account will not expose any
         #org.gnome.OnlineAccounts.Photos interface. If the account does not
         provide photos-like capabilities, this property does nothing.

         Note that the #org.gnomeOnlineAccounts.Photos interface is added or
         removed from the account asynchronously.
    -->
    <property name="PhotosDisabled" type="b" access="readwrite"/>

225
    <!-- FilesDisabled:
Debarshi Ray's avatar
Debarshi Ray committed
226 227
         @since: 3.8.0

228 229 230 231 232 233 234 235 236
         If %TRUE, the account will not expose any
         #org.gnome.OnlineAccounts.Files interface. If the account does not
         provide files-like capabilities, this property does nothing.

         Note that the #org.gnomeOnlineAccounts.Files interface is added or
         removed from the account asynchronously.
    -->
    <property name="FilesDisabled" type="b" access="readwrite"/>

237
    <!-- TicketingDisabled:
Debarshi Ray's avatar
Debarshi Ray committed
238 239
         @since: 3.6.0

240 241 242 243 244 245 246 247 248
         If %TRUE, the account will not expose any
         #org.gnome.OnlineAccounts.Ticketing interface. If the account does not
         provide ticketing-like capabilities, this property does nothing.

         Note that the #org.gnomeOnlineAccounts.Ticketing interface is added or
         removed from the account asynchronously.
    -->
    <property name="TicketingDisabled" type="b" access="readwrite"/>

249 250 251 252 253 254 255 256 257 258 259 260
    <!-- TodoDisabled:
         @since: 3.26.0

         If %TRUE, the account will not expose any
         #org.gnome.OnlineAccounts.Todo interface. If the account does not
         provide todo-like capabilities, this property does nothing.

         Note that the #org.gnomeOnlineAccounts.Todo interface is added or
         removed from the account asynchronously.
    -->
    <property name="TodoDisabled" type="b" access="readwrite"/>

Bastien Nocera's avatar
Bastien Nocera committed
261
    <!-- ReadLaterDisabled:
262
         @since: 3.12.0
Bastien Nocera's avatar
Bastien Nocera committed
263 264 265 266 267 268 269 270 271 272

         If %TRUE, the account will not expose any
         #org.gnome.OnlineAccounts.ReadLater interface. If the account does not
         provide read-later-like capabilities, this property does nothing.

         Note that the #org.gnomeOnlineAccounts.ReadLater interface is added or
         removed from the account asynchronously.
    -->
    <property name="ReadLaterDisabled" type="b" access="readwrite"/>

273 274 275 276 277 278 279 280
    <!--
        Remove:

        Removes the account. Note that this does not removes the
        account at the remote service.
    -->
    <method name="Remove"/>

281 282
    <!--
        EnsureCredentials:
David Zeuthen's avatar
David Zeuthen committed
283
        @expires_in: The duration that the cached credentials are valid for, in seconds, or 0 if unknown.
284 285

        Ensures that valid credentials exist for the account and
286 287 288 289 290 291 292
        returns how long they are still valid for, if known. Returns
        an error if the cached credentials are not valid or
        non-existant.

        If this method fails because the token service indicates that
        authorization has expired, the
        #org.gnome.OnlineAccounts.Account:AttentionNeeded property
David Zeuthen's avatar
David Zeuthen committed
293 294
        will be set to %TRUE. On the other hand, if this property was
        already %TRUE and this method succeeds, it is set to %FALSE.
295 296 297 298
    -->
    <method name="EnsureCredentials">
      <arg name="expires_in" type="i" direction="out"/>
    </method>
299 300
  </interface>

301
  <!--
302
      org.gnome.OnlineAccounts.OAuth2Based:
303

304
      An account object implements this interface if <ulink
David Zeuthen's avatar
David Zeuthen committed
305 306
      url="http://oauth.net/2/">OAuth 2.0</ulink> tokens are used for
      accessing it.
307
  -->
308
  <interface name="org.gnome.OnlineAccounts.OAuth2Based">
309 310
    <!--
      GetAccessToken:
311
      @access_token: The access token.
David Zeuthen's avatar
David Zeuthen committed
312
      @expires_in: The duration that the returned token is valid for, in seconds, or 0 if unknown.
313

314 315 316 317 318
      Use this method to obtain an access token that can be used to
      access services for the account. Because networking is involved,
      this method may take a very long time to complete.

      Note that calls to this method are logged.
319 320 321 322 323
    -->
    <method name="GetAccessToken">
      <arg name="access_token" type="s" direction="out"/>
      <arg name="expires_in" type="i" direction="out"/>
    </method>
324 325 326 327 328 329

    <!-- ClientId: The client id. -->
    <property name="ClientId" type="s" access="read"/>

    <!-- ClientSecret: The client secret. -->
    <property name="ClientSecret" type="s" access="read"/>
330 331
  </interface>

332 333 334 335
  <!--
      org.gnome.OnlineAccounts.OAuthBased:

      An account object implements this interface if <ulink
David Zeuthen's avatar
David Zeuthen committed
336 337
      url="http://oauth.net">OAuth 1.0</ulink> tokens are used for
      accessing it.
338 339 340 341 342 343
  -->
  <interface name="org.gnome.OnlineAccounts.OAuthBased">
    <!--
      GetAccessToken:
      @access_token: The access token.
      @access_token_secret: The access token secret.
David Zeuthen's avatar
David Zeuthen committed
344
      @expires_in: The duration that the returned token is valid for, in seconds, or 0 if unknown.
345

346 347 348
      Use this method to obtain an access token that can be used to to
      access services for the account. Because networking is involved,
      this method may take a very long time to complete.
349

350
      Note that calls to this method are logged.
351 352 353 354 355 356 357
    -->
    <method name="GetAccessToken">
      <arg name="access_token" type="s" direction="out"/>
      <arg name="access_token_secret" type="s" direction="out"/>
      <arg name="expires_in" type="i" direction="out"/>
    </method>

358 359 360 361 362
    <!-- ConsumerKey: The consumer key. -->
    <property name="ConsumerKey" type="s" access="read"/>

    <!-- ConsumerSecret: The consumer secret. -->
    <property name="ConsumerSecret" type="s" access="read"/>
363 364
  </interface>

365 366
  <!--
      org.gnome.OnlineAccounts.PasswordBased:
Debarshi Ray's avatar
Debarshi Ray committed
367
      @since: 3.6.0
368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393

      An account object implements this interface if one or more
      passwords are used for accessing it.
  -->
  <interface name="org.gnome.OnlineAccounts.PasswordBased">
    <!--
      GetPassword:
      @id: An identifier describing what password to get.
      @password: The password.

      Use this method to obtain the passwords used to access the
      account.

      If the account is for a mail account (see
      #org.gnome.OnlineAccounts.Mail), known values for @id includes
      <literal>imap-password</literal> and
      <literal>smtp-password</literal>.

      Note that calls to this method are logged.
    -->
    <method name="GetPassword">
      <arg name="id" type="s" direction="in"/>
      <arg name="password" type="s" direction="out"/>
    </method>
  </interface>

394 395 396
  <!--
      org.gnome.OnlineAccounts.Manager:

397
      An interface used for managing accounts.
398 399
  -->
  <interface name="org.gnome.OnlineAccounts.Manager">
400 401 402

    <!--
        AddAccount:
403 404 405
        @provider: The account provider. See the #org.gnome.OnlineAccounts.Account:ProviderType property for known providers.
        @identity: The identity of the account (cf. the #org.gnome.OnlineAccounts.Account:Identity property).
        @presentation_identity: The identity of the account that is suitable for display in an user interface (cf. the #org.gnome.OnlineAccounts.Account:PresentationIdentity property).
406
        @credentials: The credentials to store.
407
        @details: Extra key/value pairs to set.
408 409 410 411 412 413
        @account_object_path: The object path of the created account.

        Creates a new account. Note that this does not create an
        account at the remote service.
    -->
    <method name="AddAccount">
414 415 416
      <arg name="provider" type="s" direction="in"/>
      <arg name="identity" type="s" direction="in"/>
      <arg name="presentation_identity" type="s" direction="in"/>
417
      <arg name="credentials" type="a{sv}" direction="in"/>
418
      <arg name="details" type="a{ss}" direction="in"/>
419 420 421
      <arg name="account_object_path" type="o" direction="out"/>
    </method>

422 423
  </interface>

424 425 426 427 428 429 430 431

  <!--
      org.gnome.OnlineAccounts.Mail:

      An account object implements this interface if it provides
      email-like messaging capabilities.
  -->
  <interface name="org.gnome.OnlineAccounts.Mail">
432 433 434 435 436 437
    <!-- EmailAddress:
         The email address for the account or blank if there is no
         such address or if it isnt' known or isn't in a standard
         format.
      -->
    <property name="EmailAddress" type="s" access="read"/>
438

439 440 441 442 443 444 445
    <!-- Name:
         @since: 3.8.0
         The full name of the user associated with
         #org.gnome.OnlineAccounts.Mail:EmailAddress.
      -->
    <property name="Name" type="s" access="read"/>

446 447 448 449 450 451 452 453
    <!-- ImapSupported:
         Set to %TRUE if the messages for the account can be accessed
         and manipulated using the
         <ulink url="http://tools.ietf.org/html/rfc3501">IMAP</ulink>
         protocol.
      -->
    <property name="ImapSupported" type="b" access="read"/>

454 455 456 457 458 459
    <!-- ImapAcceptSslErrors:
         @since: 3.8.0
         Accept SSL/TLS errors caused by invalid certificates.
      -->
    <property name="ImapAcceptSslErrors" type="b" access="read"/>

460 461 462 463 464 465 466 467 468 469 470
    <!-- ImapHost:
         The IMAP server to use.

         This may be in any of a number of recognized formats; an IPv6
         address, an IPv4 address, or a domain name. A port override
         may be specified in the usual way with a colon. Ports may be
         given as decimal numbers or symbolic names
         (cf. the <filename>/etc/services</filename> file).

         If a port override is not given, then applications should try
         to connect to port 993 if
471
         #org.gnome.OnlineAccounts.Mail:ImapUseSsl is %TRUE and port
472 473 474 475
         143 if not.
    -->
    <property name="ImapHost" type="s" access="read"/>

476 477 478 479 480 481 482 483 484 485 486 487 488 489 490
    <!-- ImapUseSsl:
         @since: 3.8.0
         Whether SSL should be used.

         This indicates that SSL should be used on a dedicated port.
    -->
    <property name="ImapUseSsl" type="b" access="read"/>

    <!-- ImapUseTls:
         Whether TLS should be used.

         This indicates that STARTTLS should be used on a standard port
         after the connection has been established to obtain a secure
         channel.
    -->
491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507
    <property name="ImapUseTls" type="b" access="read"/>

    <!-- ImapUserName:
         The user name to use for logging in.

         This may be blank if username/password authentication isn't
         used or if the user name of the current user should be used.
    -->
    <property name="ImapUserName" type="s" access="read"/>

    <!-- SmtpSupported:
         Set to %TRUE if the
         <ulink url="http://tools.ietf.org/html/rfc5321">SMTP</ulink>
         protocol can be used to send messages for the account.
      -->
    <property name="SmtpSupported" type="b" access="read"/>

508 509 510 511 512 513
    <!-- SmtpAcceptSslErrors:
         @since: 3.8.0
         Accept SSL/TLS errors caused by invalid certificates.
      -->
    <property name="SmtpAcceptSslErrors" type="b" access="read"/>

514 515 516 517 518 519 520 521 522 523 524
    <!-- SmtpHost:
         The SMTP server to use.

         This may be in any of a number of recognized formats; an IPv6
         address, an IPv4 address, or a domain name. A port override
         may be specified in the usual way with a colon. Ports may be
         given as decimal numbers or symbolic names
         (cf. the <filename>/etc/services</filename> file).

         If a port override is not given, then applications should try
         to connect to port 465 if
525
         #org.gnome.OnlineAccounts.Mail:SmtpUseSsl is %TRUE and port
526 527 528 529
         587 (or 25) if not.
    -->
    <property name="SmtpHost" type="s" access="read"/>

530 531 532 533 534 535 536 537
    <!-- SmtpUseAuth:
         @since: 3.8.0
         Whether authentication is needed

         This indicates whether the server uses authentication.
    -->
    <property name="SmtpUseAuth" type="b" access="read"/>

538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570
    <!-- SmtpAuthLogin:
         @since: 3.12.0
         Whether LOGIN authentication should be used.

         This indicates whether the server uses the
         <ulink url="http://msdn.microsoft.com/en-us/library/cc433484(v=EXCHG.80).aspx">
         LOGIN</ulink> SASL mechanism for SMTP.
    -->
    <property name="SmtpAuthLogin" type="b" access="read"/>

    <!-- SmtpAuthPlain:
         @since: 3.12.0
         Whether PLAIN authentication should be used.

         This indicates whether the server uses the
         <ulink url="http://tools.ietf.org/html/rfc4616">PLAIN</ulink>
         SASL mechanism for SMTP.
    -->
    <property name="SmtpAuthPlain" type="b" access="read"/>

    <!-- SmtpAuthXoauth2:
         @since: 3.12.0
         Whether XOAUTH2 authentication should be used.

         This indicates whether the server uses the non-standard XOAUTH2
         SASL mechanism for SMTP. This is implemented by
         <ulink url="https://developers.google.com/gmail/xoauth2_protocol#the_sasl_xoauth2_mechanism">
         GMail</ulink> and
         <ulink url="http://blogs.office.com/2013/09/12/outlook-com-now-has-imap/">
         Outlook.com</ulink>.
    -->
    <property name="SmtpAuthXoauth2" type="b" access="read"/>

571 572 573 574 575 576 577 578 579 580 581 582 583 584 585
    <!-- SmtpUseSsl:
         @since: 3.8.0
         Whether SSL should be used.

         This indicates that SSL should be used on a dedicated port.
    -->
    <property name="SmtpUseSsl" type="b" access="read"/>

    <!-- SmtpUseTls:
         Whether TLS should be used.

         This indicates that STARTTLS should be used on a standard port
         after the connection has been established to obtain a secure
         channel.
    -->
586 587 588 589 590 591 592 593 594
    <property name="SmtpUseTls" type="b" access="read"/>

    <!-- SmtpUserName:
         The user name to use for logging in.

         This may be blank if username/password authentication isn't
         used or if the user name of the current user should be used.
    -->
    <property name="SmtpUserName" type="s" access="read"/>
595 596
  </interface>

597 598 599 600
  <!--
      org.gnome.OnlineAccounts.Calendar:

      An account object implements this interface if it provides
601 602 603
      calendar-like capabilities. For example, it can represent a
      <ulink url="http://tools.ietf.org/html/rfc4791">CalDAV</ulink>
      server.
604 605
  -->
  <interface name="org.gnome.OnlineAccounts.Calendar">
606 607 608 609 610 611
    <!-- AcceptSslErrors:
         @since: 3.8.0
         Accept SSL/TLS errors caused by invalid certificates.
      -->
    <property name="AcceptSslErrors" type="b" access="read"/>

612
    <!-- Uri:
613
         @since: 3.8.0
614 615 616
         The top-level location of the calendars.
      -->
    <property name="Uri" type="s" access="read"/>
617 618 619 620 621 622
  </interface>

  <!--
      org.gnome.OnlineAccounts.Contacts:

      An account object implements this interface if it provides
623 624 625
      contacts-like capabilities. For example, it can represent a
      <ulink url="http://tools.ietf.org/html/rfc6352">CardDAV</ulink>
      server.
626 627
  -->
  <interface name="org.gnome.OnlineAccounts.Contacts">
628 629 630 631 632 633
    <!-- AcceptSslErrors:
         @since: 3.8.0
         Accept SSL/TLS errors caused by invalid certificates.
      -->
    <property name="AcceptSslErrors" type="b" access="read"/>

634
    <!-- Uri:
635
         @since: 3.8.0
636 637 638
         The top-level location of the contacts.
      -->
    <property name="Uri" type="s" access="read"/>
639 640
  </interface>

Bastien Nocera's avatar
Bastien Nocera committed
641 642 643 644 645 646 647 648 649
  <!--
      org.gnome.OnlineAccounts.Chat:

      An account object implements this interface if it provides
      chat-like capabilities.
  -->
  <interface name="org.gnome.OnlineAccounts.Chat">
  </interface>

650 651 652 653 654 655 656 657 658
  <!--
      org.gnome.OnlineAccounts.Documents:

      An account object implements this interface if it provides
      documents-like capabilities.
  -->
  <interface name="org.gnome.OnlineAccounts.Documents">
  </interface>

659 660 661 662 663 664 665 666 667 668
  <!--
      org.gnome.OnlineAccounts.Maps:
      @since: 3.14.0

      An account object implements this interface if it provides
      maps-like capabilities.
  -->
  <interface name="org.gnome.OnlineAccounts.Maps">
  </interface>

669 670 671 672 673 674 675 676 677 678
  <!--
      org.gnome.OnlineAccounts.Music:
      @since: 3.18.0

      An account object implements this interface if it provides
      music-like capabilities.
  -->
  <interface name="org.gnome.OnlineAccounts.Music">
  </interface>

679 680 681 682 683 684 685 686 687 688
  <!--
      org.gnome.OnlineAccounts.Photos:
      @since: 3.8.0

      An account object implements this interface if it provides
      photos-like capabilities.
  -->
  <interface name="org.gnome.OnlineAccounts.Photos">
  </interface>

689 690 691 692 693 694 695 696 697 698
  <!--
      org.gnome.OnlineAccounts.Files:
      @since: 3.8.0

      An account object implements this interface if it provides
      files-like capabilities. For example, it can represent a
      <ulink url="http://tools.ietf.org/html/rfc4918">WebDAV</ulink>
      server.
  -->
  <interface name="org.gnome.OnlineAccounts.Files">
699 700 701 702 703
    <!-- AcceptSslErrors:
         Accept SSL/TLS errors caused by invalid certificates.
      -->
    <property name="AcceptSslErrors" type="b" access="read"/>

704 705 706 707 708 709 710 711 712 713 714 715
    <!-- Uri:
         The top-level location of the files.

         This is a
         <ulink url="http://developer.gnome.org/gio/stable/GVfs.html">
         Gvfs</ulink>-specific URI meant to be used with
         <ulink url="http://developer.gnome.org/platform-overview/stable/gio">
         GIO</ulink>. It may not work with anything else.
      -->
    <property name="Uri" type="s" access="read"/>
  </interface>

716 717 718 719 720 721 722 723
  <!--
      org.gnome.OnlineAccounts.Exchange:
      @since: 3.6.0

      An account object implements this interface if it represents
      a Microsoft Exchange server.
  -->
  <interface name="org.gnome.OnlineAccounts.Exchange">
724 725 726 727 728 729
    <!-- AcceptSslErrors:
         @since: 3.8.0
         Accept SSL/TLS errors caused by invalid certificates.
      -->
    <property name="AcceptSslErrors" type="b" access="read"/>

730 731 732 733
    <!-- Host:
         The Exchange server to use. This is always a domain name.

         Use this to determine the <ulink
Debarshi Ray's avatar
Debarshi Ray committed
734
         url="http://msdn.microsoft.com/en-us/library/gg591268&percnt;28v&period;exchg.140&percnt;29.aspx">
735 736 737 738 739 740 741 742 743 744 745
         Autodiscover</ulink> service endpoints. eg. if
         #org.gnome.OnlineAccounts.Exchange:Host is
         <literal>bar.com</literal>, then the possible endpoints are
         <literal>https://bar.com/autodiscover/autodiscover.xml
         </literal> and <literal>
         https://autodiscover.bar.com/autodiscover/autodiscover.xml
         </literal>.
      -->
    <property name="Host" type="s" access="read"/>
  </interface>

746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765
  <!--
      org.gnome.OnlineAccounts.MediaServer:
      @since: 3.14

      An account object implements this interface if it provides
      media server like capabilities.
  -->
  <interface name="org.gnome.OnlineAccounts.MediaServer">
    <!-- DlnaSupported:

         True if media server device is DLNA supported.
      -->
    <property name="DlnaSupported" type="b" access="read"/>
    <!-- Udn:

         Unique Device Name. Used to uniquely identify the device.
      -->
    <property name="Udn" type="s" access="read"/>
  </interface>

766 767
  <!--
      org.gnome.OnlineAccounts.Ticketing:
Debarshi Ray's avatar
Debarshi Ray committed
768
      @since: 3.6.0
769 770 771 772 773

      An account object implements this interface if it provides
      ticketing capabilities.
  -->
  <interface name="org.gnome.OnlineAccounts.Ticketing">
774 775 776 777 778 779 780 781 782 783 784
    <!--
      Details:
      @since: 3.18

      Metadata about the tickets getting fetched.
      For kerberos tickets, this may contain a
      preauthentication source used by pkinit
      (such as PKCS11:libcoolkeypk11.so)
      -->
    <property name="Details" type="a{ss}" access="read"/>

785 786 787 788 789 790 791 792 793
    <!--
      GetTicket:

      Use this method to obtain an ticket that can be used to
      access resources for the account.
    -->
    <method name="GetTicket"/>
  </interface>

794 795 796 797 798 799 800 801 802 803
  <!--
      org.gnome.OnlineAccounts.Todo:
      @since: 3.26.0

      An account object implements this interface if it provides
      todo-like capabilities.
  -->
  <interface name="org.gnome.OnlineAccounts.Todo">
  </interface>

Bastien Nocera's avatar
Bastien Nocera committed
804 805
  <!--
      org.gnome.OnlineAccounts.ReadLater:
806
      @since: 3.12.0
Bastien Nocera's avatar
Bastien Nocera committed
807 808 809 810 811 812 813

      An account object implements this interface if it provides
      read-later-like capabilities.
  -->
  <interface name="org.gnome.OnlineAccounts.ReadLater">
  </interface>

814 815 816 817 818 819 820 821 822 823
  <!--
      org.gnome.OnlineAccounts.Printers:
      @since: 3.12.0

      An account object implements this interface if it provides
      network printing capabilities.
  -->
  <interface name="org.gnome.OnlineAccounts.Printers">
  </interface>

824
</node>