|
Packit |
79f644 |
|
|
Packit |
79f644 |
|
|
Packit |
79f644 |
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
|
|
Packit |
79f644 |
|
|
Packit |
79f644 |
]>
|
|
Packit |
79f644 |
<book id="goa" xmlns:xi="http://www.w3.org/2003/XInclude">
|
|
Packit |
79f644 |
<bookinfo>
|
|
Packit |
79f644 |
<title>GNOME Online Accounts Reference Manual</title>
|
|
Packit |
79f644 |
<releaseinfo>Version &version;</releaseinfo>
|
|
Packit |
79f644 |
<authorgroup>
|
|
Packit |
79f644 |
<author>
|
|
Packit |
79f644 |
<firstname>David</firstname>
|
|
Packit |
79f644 |
<surname>Zeuthen</surname>
|
|
Packit |
79f644 |
<affiliation>
|
|
Packit |
79f644 |
<address>
|
|
Packit |
79f644 |
<email>zeuthen@gmail.com</email>
|
|
Packit |
79f644 |
</address>
|
|
Packit |
79f644 |
</affiliation>
|
|
Packit |
79f644 |
</author>
|
|
Packit |
79f644 |
<author>
|
|
Packit |
79f644 |
<firstname>Debarshi</firstname>
|
|
Packit |
79f644 |
<surname>Ray</surname>
|
|
Packit |
79f644 |
<affiliation>
|
|
Packit |
79f644 |
<address>
|
|
Packit |
79f644 |
<email>debarshir@gnome.org</email>
|
|
Packit |
79f644 |
</address>
|
|
Packit |
79f644 |
</affiliation>
|
|
Packit |
79f644 |
</author>
|
|
Packit |
79f644 |
</authorgroup>
|
|
Packit |
79f644 |
|
|
Packit |
79f644 |
<copyright>
|
|
Packit |
79f644 |
<year>2011 – 2017</year>
|
|
Packit |
79f644 |
<holder>The GOA Authors</holder>
|
|
Packit |
79f644 |
</copyright>
|
|
Packit |
79f644 |
|
|
Packit |
79f644 |
<legalnotice>
|
|
Packit |
79f644 |
<para>
|
|
Packit |
79f644 |
Permission is granted to copy, distribute and/or modify this
|
|
Packit |
79f644 |
document under the terms of the <citetitle>GNU Free
|
|
Packit |
79f644 |
Documentation License</citetitle>, Version 1.1 or any later
|
|
Packit |
79f644 |
version published by the Free Software Foundation with no
|
|
Packit |
79f644 |
Invariant Sections, no Front-Cover Texts, and no Back-Cover
|
|
Packit |
79f644 |
Texts. You may obtain a copy of the <citetitle>GNU Free
|
|
Packit |
79f644 |
Documentation License</citetitle> from the Free Software
|
|
Packit |
79f644 |
Foundation by visiting
|
|
Packit |
79f644 |
url="http://www.fsf.org">their Web site</ulink> or by writing
|
|
Packit |
79f644 |
to:
|
|
Packit |
79f644 |
<address>
|
|
Packit |
79f644 |
<street>51 Franklin Street</street>, Suite 500
|
|
Packit |
79f644 |
<city>Boston</city>, <state>MA</state> <postcode>02110-1335</postcode>
|
|
Packit |
79f644 |
<country>USA</country>
|
|
Packit |
79f644 |
</address>
|
|
Packit |
79f644 |
</para>
|
|
Packit |
79f644 |
<para>
|
|
Packit |
79f644 |
Many of the names used by companies to distinguish their
|
|
Packit |
79f644 |
products and services are claimed as trademarks. Where those
|
|
Packit |
79f644 |
names appear in any GNOME documentation, and those trademarks
|
|
Packit |
79f644 |
are made aware to the members of the GNOME project, the names
|
|
Packit |
79f644 |
have been printed in caps or initial caps.
|
|
Packit |
79f644 |
</para>
|
|
Packit |
79f644 |
</legalnotice>
|
|
Packit |
79f644 |
</bookinfo>
|
|
Packit |
79f644 |
|
|
Packit |
79f644 |
<xi:include href="xml/goa-overview.xml"/>
|
|
Packit |
79f644 |
|
|
Packit |
79f644 |
<part id="ref-dbus">
|
|
Packit |
79f644 |
<title>D-Bus API Reference</title>
|
|
Packit |
79f644 |
<chapter id="ref-dbus-overview">
|
|
Packit |
79f644 |
<title>Objects & Names</title>
|
|
Packit |
79f644 |
<sect1 id="ref-dbus-well-known-name">
|
|
Packit |
79f644 |
<title>The org.gnome.OnlineAccounts bus name</title>
|
|
Packit |
79f644 |
<para>
|
|
Packit |
79f644 |
The D-Bus name <literal>org.gnome.OnlineAccounts</literal>
|
|
Packit |
79f644 |
on the session bus is used by the GOA daemon,
|
|
Packit |
79f644 |
linkend="goa-daemon.8">goa-daemon</link>. If this daemon
|
|
Packit |
79f644 |
isn't running, it will be started if D-Bus messages are sent
|
|
Packit |
79f644 |
to the name.
|
|
Packit |
79f644 |
</para>
|
|
Packit |
79f644 |
</sect1>
|
|
Packit |
79f644 |
<sect1 id="ref-dbus-well-known-object">
|
|
Packit |
79f644 |
<title>The /org/gnome/OnlineAccounts and /org/gnome/OnlineAccounts/Manager objects</title>
|
|
Packit |
79f644 |
<para>
|
|
Packit |
79f644 |
The process that owns the well-known D-Bus name
|
|
Packit |
79f644 |
linkend="ref-dbus-well-known-name">org.gnome.OnlineAccounts</link>
|
|
Packit |
79f644 |
on the session bus (typically
|
|
Packit |
79f644 |
linkend="goa-daemon.8">goa-daemon</link>) exports an object
|
|
Packit |
79f644 |
at the well-known path
|
|
Packit |
79f644 |
<literal>/org/gnome/OnlineAccounts</literal>. This object
|
|
Packit |
79f644 |
implements the
|
|
Packit |
79f644 |
url="http://dbus.freedesktop.org/doc/dbus-specification.html#standard-interfaces-objectmanager">org.freedesktop.DBus.ObjectManager</ulink>
|
|
Packit |
79f644 |
interface and should be used by clients to discover other
|
|
Packit |
79f644 |
objects.
|
|
Packit |
79f644 |
</para>
|
|
Packit |
79f644 |
<para>
|
|
Packit |
79f644 |
One of the objects in the
|
|
Packit |
79f644 |
<literal>/org/gnome/OnlineAccounts</literal> hierarchy
|
|
Packit |
79f644 |
is an object at the path
|
|
Packit |
79f644 |
<literal>/org/gnome/OnlineAccounts/Manager</literal> which
|
|
Packit |
79f644 |
implements the
|
|
Packit |
79f644 |
linkend="gdbus-interface-org-gnome-OnlineAccounts-Manager.top_of_page">org.gnome.OnlineAccounts.Manager</link>
|
|
Packit |
79f644 |
interface.
|
|
Packit |
79f644 |
</para>
|
|
Packit |
79f644 |
</sect1>
|
|
Packit |
79f644 |
</chapter>
|
|
Packit |
79f644 |
|
|
Packit |
79f644 |
<chapter>
|
|
Packit |
79f644 |
<title>Core Interfaces</title>
|
|
Packit |
79f644 |
<xi:include href="../src/goa/goa-generated-doc-org.gnome.OnlineAccounts.Account.xml"/>
|
|
Packit |
79f644 |
<xi:include href="../src/goa/goa-generated-doc-org.gnome.OnlineAccounts.Manager.xml"/>
|
|
Packit |
79f644 |
</chapter>
|
|
Packit |
79f644 |
<chapter>
|
|
Packit |
79f644 |
<title>Credentials Interfaces</title>
|
|
Packit |
79f644 |
<xi:include href="../src/goa/goa-generated-doc-org.gnome.OnlineAccounts.OAuthBased.xml"/>
|
|
Packit |
79f644 |
<xi:include href="../src/goa/goa-generated-doc-org.gnome.OnlineAccounts.OAuth2Based.xml"/>
|
|
Packit |
79f644 |
<xi:include href="../src/goa/goa-generated-doc-org.gnome.OnlineAccounts.PasswordBased.xml"/>
|
|
Packit |
79f644 |
</chapter>
|
|
Packit |
79f644 |
<chapter>
|
|
Packit |
79f644 |
<title>Service-specific Interfaces</title>
|
|
Packit |
79f644 |
<xi:include href="../src/goa/goa-generated-doc-org.gnome.OnlineAccounts.Mail.xml"/>
|
|
Packit |
79f644 |
<xi:include href="../src/goa/goa-generated-doc-org.gnome.OnlineAccounts.Calendar.xml"/>
|
|
Packit |
79f644 |
<xi:include href="../src/goa/goa-generated-doc-org.gnome.OnlineAccounts.Contacts.xml"/>
|
|
Packit |
79f644 |
<xi:include href="../src/goa/goa-generated-doc-org.gnome.OnlineAccounts.Chat.xml"/>
|
|
Packit |
79f644 |
<xi:include href="../src/goa/goa-generated-doc-org.gnome.OnlineAccounts.Documents.xml"/>
|
|
Packit |
79f644 |
<xi:include href="../src/goa/goa-generated-doc-org.gnome.OnlineAccounts.Maps.xml"/>
|
|
Packit |
79f644 |
<xi:include href="../src/goa/goa-generated-doc-org.gnome.OnlineAccounts.Music.xml"/>
|
|
Packit |
79f644 |
<xi:include href="../src/goa/goa-generated-doc-org.gnome.OnlineAccounts.Photos.xml"/>
|
|
Packit |
79f644 |
<xi:include href="../src/goa/goa-generated-doc-org.gnome.OnlineAccounts.Printers.xml"/>
|
|
Packit |
79f644 |
<xi:include href="../src/goa/goa-generated-doc-org.gnome.OnlineAccounts.Files.xml"/>
|
|
Packit |
79f644 |
<xi:include href="../src/goa/goa-generated-doc-org.gnome.OnlineAccounts.Exchange.xml"/>
|
|
Packit |
79f644 |
<xi:include href="../src/goa/goa-generated-doc-org.gnome.OnlineAccounts.MediaServer.xml"/>
|
|
Packit |
79f644 |
<xi:include href="../src/goa/goa-generated-doc-org.gnome.OnlineAccounts.Ticketing.xml"/>
|
|
Packit |
79f644 |
<xi:include href="../src/goa/goa-generated-doc-org.gnome.OnlineAccounts.Todo.xml"/>
|
|
Packit |
79f644 |
</chapter>
|
|
Packit |
79f644 |
</part>
|
|
Packit |
79f644 |
|
|
Packit |
79f644 |
<part id="ref-library">
|
|
Packit |
79f644 |
<title>Client Library API Reference</title>
|
|
Packit |
79f644 |
<xi:include href="xml/goaclient.xml"/>
|
|
Packit |
79f644 |
<xi:include href="xml/goaerror.xml"/>
|
|
Packit |
79f644 |
<xi:include href="xml/goaversion.xml"/>
|
|
Packit |
79f644 |
<chapter id="ref-library-generated">
|
|
Packit |
79f644 |
<title>Generated Code</title>
|
|
Packit |
79f644 |
<xi:include href="xml/GoaObject.xml"/>
|
|
Packit |
79f644 |
<xi:include href="xml/GoaObjectManagerClient.xml"/>
|
|
Packit |
79f644 |
<xi:include href="xml/GoaManager.xml"/>
|
|
Packit |
79f644 |
<xi:include href="xml/GoaAccount.xml"/>
|
|
Packit |
79f644 |
<xi:include href="xml/GoaOAuthBased.xml"/>
|
|
Packit |
79f644 |
<xi:include href="xml/GoaOAuth2Based.xml"/>
|
|
Packit |
79f644 |
<xi:include href="xml/GoaPasswordBased.xml"/>
|
|
Packit |
79f644 |
<xi:include href="xml/GoaMail.xml"/>
|
|
Packit |
79f644 |
<xi:include href="xml/GoaCalendar.xml"/>
|
|
Packit |
79f644 |
<xi:include href="xml/GoaContacts.xml"/>
|
|
Packit |
79f644 |
<xi:include href="xml/GoaChat.xml"/>
|
|
Packit |
79f644 |
<xi:include href="xml/GoaDocuments.xml"/>
|
|
Packit |
79f644 |
<xi:include href="xml/GoaMaps.xml"/>
|
|
Packit |
79f644 |
<xi:include href="xml/GoaMusic.xml"/>
|
|
Packit |
79f644 |
<xi:include href="xml/GoaPhotos.xml"/>
|
|
Packit |
79f644 |
<xi:include href="xml/GoaFiles.xml"/>
|
|
Packit |
79f644 |
<xi:include href="xml/GoaExchange.xml"/>
|
|
Packit |
79f644 |
<xi:include href="xml/GoaMediaServer.xml"/>
|
|
Packit |
79f644 |
<xi:include href="xml/GoaTicketing.xml"/>
|
|
Packit |
79f644 |
<xi:include href="xml/GoaTodo.xml"/>
|
|
Packit |
79f644 |
<xi:include href="xml/GoaReadLater.xml"/>
|
|
Packit |
79f644 |
<xi:include href="xml/GoaPrinters.xml"/>
|
|
Packit |
79f644 |
</chapter>
|
|
Packit |
79f644 |
</part>
|
|
Packit |
79f644 |
|
|
Packit |
79f644 |
<part id="ref-backend-library">
|
|
Packit |
79f644 |
<title>Backend Library API Reference</title>
|
|
Packit |
79f644 |
<chapter>
|
|
Packit |
79f644 |
<title>Core</title>
|
|
Packit |
79f644 |
<xi:include href="xml/goautil.xml"/>
|
|
Packit |
79f644 |
<xi:include href="xml/goaprovider.xml"/>
|
|
Packit |
79f644 |
<xi:include href="xml/goaoauthprovider.xml"/>
|
|
Packit |
79f644 |
<xi:include href="xml/goaoauth2provider.xml"/>
|
|
Packit |
79f644 |
</chapter>
|
|
Packit |
79f644 |
</part>
|
|
Packit |
79f644 |
|
|
Packit |
79f644 |
<part id="tools-fileformats">
|
|
Packit |
79f644 |
<title>Tools, File Formats and Manual Pages</title>
|
|
Packit |
79f644 |
<xi:include href="xml/goa-daemon.xml"/>
|
|
Packit |
79f644 |
</part>
|
|
Packit |
79f644 |
|
|
Packit |
79f644 |
<index>
|
|
Packit |
79f644 |
<title>Index</title>
|
|
Packit |
79f644 |
</index>
|
|
Packit |
79f644 |
|
|
Packit |
79f644 |
<chapter id="gio-hierarchy">
|
|
Packit |
79f644 |
<title>Object Hierarchy</title>
|
|
Packit |
79f644 |
<xi:include href="xml/tree_index.sgml"/>
|
|
Packit |
79f644 |
</chapter>
|
|
Packit |
79f644 |
|
|
Packit |
79f644 |
<xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include>
|
|
Packit |
79f644 |
</book>
|