Ubuntu.OnlineAccounts.Account

Represents an instance of an online account. More...

Properties

• accountId : string
• accountServiceHandle : object
• displayName : string
• enabled : bool
• objectHandle : object
• provider : jsobject

Signals

• synced()

Methods

• void remove()
• void sync()
• void updateDisplayName(string displayName)
• void updateEnabled(bool enabled)

Detailed Description

The Account element represents an online account. It is functional only if its objectHandle property is set to a valid account, which can be obtained with Manager.loadAccount() or Manager.createAccount().

Property Documentation

The account's numeric ID. This is 0 until the account has been stored into the DB.

A C++ object which can be used to instantiate an AccountService by setting it as the value for the AccountService::objectHandle property.

The account's display name (usually the user's login or ID).

This read-only property tells whether the Account is enabled. An application shouldn't use an Account which is disabled.

An opaque handle to the underlying C++ object. Until the property is set, the Account element is uninitialized. Similarly, if the C++ object is destroyed, expect the Account to become invalid.

An immutable object representing the provider which provides the account. The returned object will have at least these members:

• id is the unique identified for this provider
• displayName
• iconName

Signal Documentation

Emitted when the account changes have been stored into the permanent storage.

Method Documentation

Deletes the account from the permanent storage. This method accepts an optional parameter, which tells whether the credentials associated with the account should also be removed:

• Account.RemoveAccountOnly
• Account.RemoveCredentials - the default

Writes the changes to the permanent account storage.

Changes the display name of the account.

See also sync().

Enables or disables the account.

See also sync().