org.gnome.OnlineAccounts.Account

org.gnome.OnlineAccounts.Account

Methods

Remove            ();
EnsureCredentials (OUT i expires_in);

Properties

ProviderType          readable   s
ProviderName          readable   s
ProviderIcon          readable   s
Id                    readable   s
AttentionNeeded       readable   b
Identity              readable   s
PresentationIdentity  readable   s

Description

The base account interface.

Method Details

The Remove() method

Remove ();

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


The EnsureCredentials() method

EnsureCredentials (OUT i expires_in);

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

OUT i expires_in:

The duration that the cached credentials are valid for, in seconds, or 0 if unknown.

Property Details

The "ProviderType" property

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 "ProviderName" for the name of the provider (which might differ from the provider name in hosted scenarios) to display in the user interface.


The "ProviderName" property

ProviderName  readable   s

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


The "ProviderIcon" property

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.


The "Id" property

Id  readable   s

An identifier for this account.

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


The "AttentionNeeded" property

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


The "Identity" property

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 "Id" to uniquely identify the account.

This string might not be suitable for presentation in an user interface - use "PresentationIdentity" instead.


The "PresentationIdentity" property

PresentationIdentity  readable   s

Like the "Identity" property but suitable for presentation in an user interface.