Goa – 1.0: org.gnome.OnlineAccounts.Account D-Bus Interface
Description: Reference for Goa-1.0: org.gnome.OnlineAccounts.Account D-Bus Interface

#### org.gnome.OnlineAccounts.Account D-Bus Interface [src]

# org.gnome.OnlineAccounts.Account

## Description

The base account interface.

### Properties

### org.gnome.OnlineAccounts.Account:ProviderType

        ProviderType readable s

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.

### org.gnome.OnlineAccounts.Account:ProviderName

        ProviderName readable s

The name of the provider to display in the user interface.

### org.gnome.OnlineAccounts.Account:ProviderIcon

        ProviderIcon readable s

The icon/logo of the provider.

This is a serialized GIcon - use e.g. g_icon_new_for_string() to create an instance.

### org.gnome.OnlineAccounts.Account:Id

        Id readable s

An identifier for this account.

        This identifier cannot be changed and should never be
        displayed in any user interface.

### org.gnome.OnlineAccounts.Account:IsLocked

        IsLocked readable b

`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.

### org.gnome.OnlineAccounts.Account:IsTemporary

        IsTemporary readwrite b

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.

### org.gnome.OnlineAccounts.Account:AttentionNeeded

        AttentionNeeded readable b

Set to `TRUE` if the account is in need of attention. This is used when a human operator is needed to service the account (e.g. for authentication and/or authorization).

### org.gnome.OnlineAccounts.Account:Identity

        Identity readable s

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 account.

This string might not be suitable for presentation in an user interface - use `org.gnome.OnlineAccounts.Account:PresentationIdentity`_ instead.

### org.gnome.OnlineAccounts.Account:PresentationIdentity

        PresentationIdentity readable s

Like the `org.gnome.OnlineAccounts.Account:Identity`_ property but suitable for presentation in an user interface.

### org.gnome.OnlineAccounts.Account:MailDisabled

        MailDisabled readwrite b

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.

### org.gnome.OnlineAccounts.Account:CalendarDisabled

        CalendarDisabled readwrite b

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.

### org.gnome.OnlineAccounts.Account:ContactsDisabled

        ContactsDisabled readwrite b

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.

### org.gnome.OnlineAccounts.Account:ChatDisabled

        ChatDisabled readwrite b

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.

### org.gnome.OnlineAccounts.Account:DocumentsDisabled

        DocumentsDisabled readwrite b

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.

Warning: This property is deprecated.

### org.gnome.OnlineAccounts.Account:MapsDisabled

        MapsDisabled readwrite b

`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.

Warning: This property is deprecated.

### org.gnome.OnlineAccounts.Account:MusicDisabled

        MusicDisabled readwrite b

`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.

### org.gnome.OnlineAccounts.Account:PrintersDisabled

        PrintersDisabled readwrite b

`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.

Warning: This property is deprecated.

### org.gnome.OnlineAccounts.Account:PhotosDisabled

        PhotosDisabled readwrite b

`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.

### org.gnome.OnlineAccounts.Account:FilesDisabled

        FilesDisabled readwrite b

`since`: 3.8.0

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.

### org.gnome.OnlineAccounts.Account:TicketingDisabled

        TicketingDisabled readwrite b

`since`: 3.6.0

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.

### org.gnome.OnlineAccounts.Account:TodoDisabled

        TodoDisabled readwrite b

`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.

Warning: This property is deprecated.

### org.gnome.OnlineAccounts.Account:ReadLaterDisabled

        ReadLaterDisabled readwrite b

`since`: 3.12.0

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.

Warning: This property is deprecated.

### Methods

### org.gnome.OnlineAccounts.Account.Remove

        Remove ()

Removes the account. Note that this does not removes the account at the remote service.

### org.gnome.OnlineAccounts.Account.EnsureCredentials

        EnsureCredentials (
          OUT expires_in i
        )

Ensures that valid credentials exist for the account and 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 will be set to `TRUE`. On the other hand, if this property was already `TRUE` and this method succeeds, it is set to `FALSE`.