Account — Telepathy D-Bus Interface Specification

# Interface Account

Interface Index (Compact) | Summary | Description | Methods | Signals | Properties

### Methods

Remove | () | → | nothing |
UpdateParameters | (a{sv}: Set, as: Unset) | → | as: Reconnect_Required |
Reconnect | () | → | nothing |

### Signals

Removed | () |
AccountPropertyChanged | (a{sv}: Properties) |

### Properties

Interfaces | as (DBus_Interface_List) | Read only |  |
DisplayName | s | Read/Write |  |
Icon | s | Read/Write |  |
Valid | b | Read only |  |
Enabled | b | Read/Write |  |
Nickname | s | Read/Write |  |
Service | s | Read/Write |  |
Parameters | a{sv} | Read only |  |
AutomaticPresence | (uss) (Simple_Presence) | Read/Write |  |
ConnectAutomatically | b | Read/Write |  |
Connection | o | Read only |  |
ConnectionStatus | u (Connection_Status) | Read only |  |
ConnectionStatusReason | u (Connection_Status_Reason) | Read only |  |
ConnectionError | s (DBus_Error_Name) | Read only |  |
ConnectionErrorDetails | a{sv} (String_Variant_Map) | Read only |  |
CurrentPresence | (uss) (Simple_Presence) | Read only |  |
RequestedPresence | (uss) (Simple_Presence) | Read/Write |  |
ChangingPresence | b | Read only |  |
NormalizedName | s | Read only |  |
HasBeenOnline | b | Read only |  |

Added in 0.17.2.
Changed in 0.17.6. moved the Avatar property to a separate interface

### Description

An Account object encapsulates the necessary details to make a Telepathy connection.

Accounts are uniquely identified by object path. The object path of an Account MUST take the form `/org/freedesktop/Telepathy/Account/cm/proto/acct`, where:

- cm is the same Connection_Manager_Name that appears in the connection manager's well-known bus name and object path
- proto is the Protocol name as seen in ConnectionManager.ListProtocols, but with "-" replaced with "_" (i.e. the same as in the object-path of a Connection)
- acct is an arbitrary string of ASCII letters, digits and underscores, starting with a letter or underscore, which uniquely identifies this account
- Clients SHOULD parse the object path to discover the connection manager and protocol
- Clients MUST NOT attempt to parse acct
- Clients MUST NOT assume that acct matches the connection-specific part of a Connection's object-path and bus name
- The account manager SHOULD choose acct such that if an account is deleted, its object path will be re-used if and only if the new account is in some sense "the same" (incorporating the 'account' parameter in some way is recommended)

##### Rationale:

This API avoids specifying the "profiles" used in Mission Control 4.x or the "presets" that have been proposed to replace them. An optional interface will be provided for AM implementations that want to provide presets.

There is deliberately no functionality here for opening channels; we intend to provide that in the channel dispatcher.

Other missing features which would be better in their own interfaces:

- dynamic parameter-providing (aka provisioning)
- saved server capabilities
- account conditions
- account grouping

# Methods

(Permalink)

## Remove () → nothing

Delete the account.

### Possible Errors

- Permission Denied
The user is not permitted to perform the requested operation.

(Permalink)

## UpdateParameters (a{sv}: Set, as: Unset) → as: Reconnect_Required

Changed in 0.17.16. parameters which are also D-Bus properties can and should be updated on existing Connections
Changed in 0.17.24. return an array of the parameters that won't change until the account is reconnected

### Parameters

- Set — a{sv}
A mapping from parameter names to their values. These parameters should be stored for future use.
- Unset — as
A list of the names of parameters to be removed from the set of stored values, allowing the default values to be used. If the given parameters were not, in fact, stored, or even if they do not exist at all, the account manager MUST accept this without error.

### Returns

- Reconnect_Required — as

If all of the updates could be applied to the active Connection (if any), the empty list, signifying that no reconnection is required for the new parameters to take effect. For example, if the only parameter updated is `...Cellular.MessageValidityPeriod`, the new value can be applied immediately to the connection.

Otherwise, a list of the names of parameters with changes that will not take effect until the account is reconnected. User interfaces that require "instant apply" semantics MAY call Reconnect in response to receiving a non-empty list. For example, if the caller updates both `...Anonymity.AnonymityMandatory` and `require-encryption`, the former can be applied to the current connection, but the latter needs a reconnect to take effect, so this method should return `["require-encryption"]`.

Change the value of the Parameters property.

If any of the Set parameters’ Conn_Mgr_Param_Flags include `DBus_Property`, the change will be applied immediately to the corresponding D-Bus Property on the active Connection, if there is one. If any of the Unset parameters’ Conn_Mgr_Param_Flags include both `DBus_Property` and `Has_Default`, the corresponding D-Bus Property on the connection will be set to the default value. Changes to other parameters will not take effect until the next time the account is disconnected and reconnected. (If parameters are explicitly set to their default value, or are unset when previously set to their default value, the account manager MAY decide that no reconnection is necessary to make the change take effect.)

##### Rationale:

In general, reconnecting is a destructive operation that shouldn't happen as a side-effect. In particular, migration tools that twiddle the settings of all accounts shouldn't cause an automatic disconnect and reconnect.

### Possible Errors

- Permission Denied
The user is not permitted to perform the requested operation.
- Invalid Argument
Raised when one of the provided arguments is invalid.

(Permalink)

## Reconnect () → nothing

Added in 0.17.24.

Re-connect this account. If the account is currently disconnected and the requested presence is offline, or if the account is not Enabled or not Valid, this does nothing.

If the account is disconnected and the requested presence is not offline, this forces an attempt to connect with the requested presence immediately.

If the account is connecting or connected, this is equivalent to remembering the current value of RequestedPresence, setting its value to (OFFLINE, "offline", ""), waiting for the change to take effect, then setting its value to the value that was previously remembered.

##### Rationale:

Clients desiring "instant apply" semantics for CM parameters MAY call this method to achieve that.

In particular, if the account's Connection is in the Connecting state, calling this method causes the attempt to connect to be aborted and re-tried.

##### Rationale:

This is necessary to ensure that the new parameters are picked up.

# Signals

(Permalink)

## Removed ()

This account has been removed.

##### Rationale:

This is redundant with AccountRemoved, but it's still worth having, to avoid having to bind to AccountManager.AccountRemoved to tell you whether your Account is valid — ideally, an account-editing UI should only care about a single Account.
(Permalink)

## AccountPropertyChanged (a{sv}: Properties)

### Parameters

- Properties — a{sv}
A map from property names in this namespace (e.g. Nickname) to values. Properties whose values have not changed SHOULD be omitted, but this need not be done.

The values of one or more properties on this interface (that do not specify that this signal does not apply to them) may have changed. This does not cover properties of other interfaces, which must provide their own change notification if appropriate.

# Properties

Accessed using the org.freedesktop.DBus.Properties interface.
(Permalink)

## Interfaces — as (DBus_Interface_List)

Read only
A list of the extra interfaces provided by this account.
(Permalink)

## DisplayName — s

Read/Write
The user-visible name of this account. This SHOULD be chosen by the user at account creation time. The account creation user interface is responsible for setting a reasonable default value in the user's locale; something like "Jabber (bob@example.com)" would be sensible.
(Permalink)

## Icon — s

Read/Write
The name of an icon in the system's icon theme, such as "im-msn", or the empty string to not specify an icon. If the icon is set to an empty string, the account manager or any client MAY derive a default icon, for instance from the protocol.
(Permalink)

## Valid — b

Read only
If true, this account is considered by the account manager to be complete and usable. If false, user action is required to make it usable, and it will never attempt to connect (for instance, this might be caused by the absence of a required parameter).

##### Rationale:

For connection managers with a plugin architecture, like telepathy-haze, we have little or no control over the parameters offered; for platforms with package management, we have little or no control over the CMs offered. NMC 4.x would just pretend the account didn't exist in these circumstances, but silent data loss is bad, and UIs with CM-specific knowledge (or a user filling in newly-required parameters) might be able to rescue a broken account.
(Permalink)

## Enabled — b

Read/Write

This property gives the users the possibility to prevent an account from being used. This flag does not change the validity of the account.

A disabled account can never be put online.

##### Rationale:

Use cases:

- user has two or more accounts capable of calling contact X, but he doesn't want the UI to prompt him everytime about which one he wants to use for the call. He can then disable all the equivalent accounts but one.
- There is some temporary server error and the user doesn't want to be be bother by error messages, or change the account configuration: temporarily disabling the account is quicker.

The AccountManager SHOULD allow this property to be set on invalid accounts, but MUST NOT attempt to put invalid accounts online even if they become Enabled.

##### Rationale:

There doesn't seem to be any good reason not to allow this.

(Permalink)

## Nickname — s

Read/Write
The nickname to set on this account for display to other contacts, as set by the user. When the account becomes connected, the account manager SHOULD set this as the user's alias using SetAliases if appropriate.

##### Rationale:

In a later specification revision, we plan to separate the concepts of a contact's nickname as set by themselves, and the local name for them in our contact list (a "handle" or "pet name" as described in XEP-0165 and its references). The terminology change from alias to nickname here is a step in that direction.
(Permalink)

## Service — s

Read/Write
Added in 0.19.8.

Some protocols, like XMPP and SIP, are used by various different user-recognised brands, such as Google Talk and Ovi by Nokia. On accounts for such services, this property SHOULD be set to a string describing the service, which MUST consist only of ASCII letters, numbers and hyphen/minus signs, and start with a letter (matching the requirements for Protocol). For the `jabber` protocol, one of the following service names should be used if possible:

- `google-talk` (for Google's IM service)
- `ovi-chat` (for Ovi's IM service)
- `facebook` (for Facebook's IM service)
- `lj-talk` (for LiveJournal's IM service)

The Icon property SHOULD be set to a corresponding brand-specific icon name, if possible. In the future, this property may be used as an index into additional service-specific customizations. If this property is the empty string (or missing), the service is determined by the protocol name (either because this is a single-service protocol like `msn`, or because this is just a generic `jabber` or `sip` account without specific branding).

This property MAY be set, if appropriate, when calling CreateAccount. Updating this property will fail on externally-stored accounts whose StorageRestrictions include `Cannot_Set_Service`.

(Permalink)

## Parameters — a{sv}

Read only

A map from connection manager parameter names (as in the ConnectionManager interface) to their values. This property includes only those parameters that are stored for this account, and SHOULD only include those parameters that the user has explicitly set.

This property cannot be altered using `org.freedesktop.DBus.Properties.Set()`; use UpdateParameters instead.

(Permalink)

## AutomaticPresence — (uss) (Simple_Presence)

Read/Write

The presence status that this account should have if it is brought online.

##### Rationale:

In ITOS2007 and ITOS2008 this is a global preference, not visible on D-Bus (the "default presence"). "Automatic presence" better describes when it is used.

Setting this property MUST NOT actually change the account's status until the next time it is (re)connected for some reason.

The value of this property MUST be one that would be acceptable for RequestedPresence, with the additional restriction that the Connection_Presence_Type MUST NOT be Offline.

##### Rationale:

Otherwise, it would not be possible to use this presence to bring the account online for a channel request.

(Permalink)

## ConnectAutomatically — b

Read/Write
If true, the account manager SHOULD attempt to put this account online with the AutomaticPresence whenever possible (in the base Account interface this is deliberately left vague). If false, it MUST NOT put the account online automatically in response to, for instance, connectivity changes, but SHOULD still put the account online with the AutomaticPresence if requested by the user (for instance, if the user tries to start a conversation using this account).
(Permalink)

## Connection — o

Read only

Either the object path of the Connection to this account, or the special value `'/'` if there is no connection.

If this object path is not '/', the Connection's well-known bus name can be derived from this object path by removing the first '/' and replacing subsequent '/' characters with '.'.

##### Rationale:

Object paths aren't nullable, so we can't use an empty string.
(Permalink)

## ConnectionStatus — u (Connection_Status)

Read only
If the Connection property is non-empty, the status of that connection. If the Connection property is the empty string, this property may either be Disconnected (indicating that the account manager is not attempting to bring it online), or Connecting (indicating that the account manager is attempting to connect). The account manager is expected to set this by observing signals from the Connection.

##### Rationale:

If the AM is doing some sort of backoff/delay on reconnection attempts, the account's status is conceptually "Connecting" even though there is no Connection.
(Permalink)

## ConnectionStatusReason — u (Connection_Status_Reason)

Read only
The reason for the last change to ConnectionStatus. The account manager is expected to set this by observing signals from the Connection.

##### Rationale:

If you weren't watching the Connection at the time it failed, you can't tell why - unless the AM can tell you.
(Permalink)

## ConnectionError — s (DBus_Error_Name)

Read only
Added in 0.19.7.

If the last connection to this account failed with an error, the D-Bus error name of that error; otherwise, the empty string. The account manager is expected to set this by observing the Connection.ConnectionError and Connection.StatusChanged signals.

If ConnectionError is received before the connection disconnects, its first argument should be used to set this property; otherwise, the Reason argument of StatusChanged should be converted to a suitable D-Bus error name.

Whenever the Connection connects successfully, this property should be reset to the empty string.

##### Rationale:

This combines the state-recoverability of ConnectionStatusReason with the extensibility of Connection.ConnectionError.

(Permalink)

## ConnectionErrorDetails — a{sv} (String_Variant_Map)

Read only
Added in 0.19.7.

If the last connection to this account failed with an error, a mapping representing any additional information about the last disconnection; otherwise, the empty map. The keys and values are the same as for the second argument of Connection.ConnectionError.

Whenever the Connection connects successfully, this property should be reset to the empty map.

##### Rationale:

This combines the state-recoverability of ConnectionStatusReason with the extensibility of Connection.ConnectionError.

(Permalink)

## CurrentPresence — (uss) (Simple_Presence)

Read only
The actual presence. If the connection is not online, the Connection_Presence_Type SHOULD be Connection_Presence_Type_Offline. If the connection is online but does not support the SimplePresence interface, the type SHOULD be Connection_Presence_Type_Unset. The account manager is expected to set this by observing signals from the Connection.
(Permalink)

## RequestedPresence — (uss) (Simple_Presence)

Read/Write

The requested presence for this account. When this is changed, the account manager should attempt to manipulate the connection manager to make CurrentPresence match RequestedPresence as closely as possible. It should not be saved to any sort of persistent storage.

When the account manager automatically connects an account, it must signal this by setting the RequestedPresence to the same thing as the AutomaticPresence.

The Connection_Presence_Type in this property MUST NOT be Unset, Unknown or Error.

##### Rationale:

Requesting those presence types doesn't make sense.

(Permalink)

## ChangingPresence — b

Read only

If true, a change to the presence of this account is in progress.

Whenever RequestedPresence is set on an account that could go online, or whenever an account with a non-offline RequestedPresence becomes able to go online (for instance because Enabled or Valid changes to True), ChangingPresence MUST change to True, and the two property changes MUST be emitted in the same AccountPropertyChanged signal, before the Set method returns.

When the account manager succeeds or fails in changing the presence, or the connection disconnects due to an error, ChangingPresence MUST change to False as part of the same AccountPropertyChanged signal.

##### Rationale:

This allows UIs to indicate that a presence change is in progress or has finished, even if the change was initiated by a different UI.

For instance, Maemo 5 and Empathy indicate a presence change by having the presence indicator alternate between the RequestedPresence and the CurrentPresence; they should start blinking when ChangingPresence becomes true, and stop when it becomes false.

(Permalink)

## NormalizedName — s

Read only

The normalized user ID of the local user on this account (i.e. the string returned when the InspectHandles method is called on the result of GetSelfHandle for an active connection).

It is unspecified whether this user ID is globally unique.

##### Rationale:

As currently implemented, IRC user IDs are only unique within the same IRCnet. On some saner protocols, the user ID includes a DNS name which provides global uniqueness.

If this value is not known yet (which will always be the case for accounts that have never been online), it will be an empty string.

It is possible that this value will change if the connection manager's normalization algorithm changes, although this SHOULD be avoided.

##### Rationale:

It's not always completely clear what normalization algorithm should be used; for instance, in Gabble, we currently use JIDs, but it would also have been reasonable to use xmpp URIs.

(Permalink)

## HasBeenOnline — b

Read only
If true, this account has successfully been put online at some point in the past.

##### Rationale:

UIs could apply a policy that the 'account' parameter can only be edited in accounts that have never been online, or that ConnectAutomatically cannot be set on such accounts. The account manager should not enforce such policies, but it can expose enough information to UIs that the UI can decide what to do.