Home · All Classes · All Namespaces · Modules · Functions · Files
Tp::Client::AccountInterface

AccountInterface Class Reference
[Account proxies]

#include <TelepathyQt4/AccountManager>

Inherits Tp::AbstractInterface.

List of all members.

Public Slots

Signals

Public Member Functions

Static Public Member Functions

Protected Member Functions

Properties

Detailed Description

Proxy class providing a 1:1 mapping of the D-Bus interface "org.freedesktop.Telepathy.Account."

Constructor & Destructor Documentation

AccountInterface ( const QString &  busName,
const QString &  objectPath,
QObject *  parent = 0 
)

Creates a AccountInterface associated with the given object on the session bus.

Parameters:
busName Name of the service the object is on.
objectPath Path to the object on the service.
parent Passed to the parent class constructor.
AccountInterface ( const QDBusConnection &  connection,
const QString &  busName,
const QString &  objectPath,
QObject *  parent = 0 
)

Creates a AccountInterface associated with the given object on the given bus.

Parameters:
connection The bus via which the object can be reached.
busName Name of the service the object is on.
objectPath Path to the object on the service.
parent Passed to the parent class constructor.
AccountInterface ( Tp::DBusProxy *  proxy  ) 

Creates a AccountInterface associated with the same object as the given proxy.

Parameters:
proxy The proxy to use. It will also be the QObject::parent() for this object.

Member Function Documentation

static const char* staticInterfaceName (  )  [inline, static]

Returns the name of the interface "org.freedesktop.Telepathy.Account", which this class represents.

Returns:
The D-Bus interface name.
QStringList Interfaces (  )  const [inline]

Getter for the remote object property "Interfaces".

Don't use this: it blocks the main loop.

Returns:
The value of the property, or a default-constructed value if the property is not readable.
QString DisplayName (  )  const [inline]

Getter for the remote object property "DisplayName".

Don't use this: it blocks the main loop.

Returns:
The value of the property, or a default-constructed value if the property is not readable.
void setDisplayName ( const QString &  newValue  )  [inline]

Setter for the remote object property "DisplayName".

Don't use this: it blocks the main loop.

Parameters:
newValue The value to set the property to.
QString Icon (  )  const [inline]

Getter for the remote object property "Icon".

Don't use this: it blocks the main loop.

Returns:
The value of the property, or a default-constructed value if the property is not readable.
void setIcon ( const QString &  newValue  )  [inline]

Setter for the remote object property "Icon".

Don't use this: it blocks the main loop.

Parameters:
newValue The value to set the property to.
bool Valid (  )  const [inline]

Getter for the remote object property "Valid".

Don't use this: it blocks the main loop.

Returns:
The value of the property, or a default-constructed value if the property is not readable.
bool Enabled (  )  const [inline]

Getter for the remote object property "Enabled".

Don't use this: it blocks the main loop.

Returns:
The value of the property, or a default-constructed value if the property is not readable.
void setEnabled ( bool  newValue  )  [inline]

Setter for the remote object property "Enabled".

Don't use this: it blocks the main loop.

Parameters:
newValue The value to set the property to.
QString Nickname (  )  const [inline]

Getter for the remote object property "Nickname".

Don't use this: it blocks the main loop.

Returns:
The value of the property, or a default-constructed value if the property is not readable.
void setNickname ( const QString &  newValue  )  [inline]

Setter for the remote object property "Nickname".

Don't use this: it blocks the main loop.

Parameters:
newValue The value to set the property to.
QVariantMap Parameters (  )  const [inline]

Getter for the remote object property "Parameters".

Don't use this: it blocks the main loop.

Returns:
The value of the property, or a default-constructed value if the property is not readable.
Tp::SimplePresence AutomaticPresence (  )  const [inline]

Getter for the remote object property "AutomaticPresence".

Don't use this: it blocks the main loop.

Returns:
The value of the property, or a default-constructed value if the property is not readable.
void setAutomaticPresence ( const Tp::SimplePresence &  newValue  )  [inline]

Setter for the remote object property "AutomaticPresence".

Don't use this: it blocks the main loop.

Parameters:
newValue The value to set the property to.
bool ConnectAutomatically (  )  const [inline]

Getter for the remote object property "ConnectAutomatically".

Don't use this: it blocks the main loop.

Returns:
The value of the property, or a default-constructed value if the property is not readable.
void setConnectAutomatically ( bool  newValue  )  [inline]

Setter for the remote object property "ConnectAutomatically".

Don't use this: it blocks the main loop.

Parameters:
newValue The value to set the property to.
QDBusObjectPath Connection (  )  const [inline]

Getter for the remote object property "Connection".

Don't use this: it blocks the main loop.

Returns:
The value of the property, or a default-constructed value if the property is not readable.
uint ConnectionStatus (  )  const [inline]

Getter for the remote object property "ConnectionStatus".

Don't use this: it blocks the main loop.

Returns:
The value of the property, or a default-constructed value if the property is not readable.
uint ConnectionStatusReason (  )  const [inline]

Getter for the remote object property "ConnectionStatusReason".

Don't use this: it blocks the main loop.

Returns:
The value of the property, or a default-constructed value if the property is not readable.
Tp::SimplePresence CurrentPresence (  )  const [inline]

Getter for the remote object property "CurrentPresence".

Don't use this: it blocks the main loop.

Returns:
The value of the property, or a default-constructed value if the property is not readable.
Tp::SimplePresence RequestedPresence (  )  const [inline]

Getter for the remote object property "RequestedPresence".

Don't use this: it blocks the main loop.

Returns:
The value of the property, or a default-constructed value if the property is not readable.
void setRequestedPresence ( const Tp::SimplePresence &  newValue  )  [inline]

Setter for the remote object property "RequestedPresence".

Don't use this: it blocks the main loop.

Parameters:
newValue The value to set the property to.
QString NormalizedName (  )  const [inline]

Getter for the remote object property "NormalizedName".

Don't use this: it blocks the main loop.

Returns:
The value of the property, or a default-constructed value if the property is not readable.
bool HasBeenOnline (  )  const [inline]

Getter for the remote object property "HasBeenOnline".

Don't use this: it blocks the main loop.

Returns:
The value of the property, or a default-constructed value if the property is not readable.
QDBusPendingReply Remove (  )  [inline, slot]

Begins a call to the D-Bus method "Remove" on the remote object.

Delete the account.

QDBusPendingReply<QStringList> UpdateParameters ( const QVariantMap &  set,
const QStringList &  unset 
) [inline, slot]

Begins a call to the D-Bus method "UpdateParameters" on the remote object.

Change the value of the <tp:member-ref>Parameters</tp:member-ref> property.

If any of the changed parameters' <tp:type>Conn_Mgr_Param_Flags</tp:type> include DBus_Property, the change will be applied to the corresponding D-Bus Property on the active <tp:member-ref>Connection</tp:member-ref>, if there is one. Changes to other parameters will not take effect until the next time the account is disconnected and reconnected.

<tp: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. </tp:rationale>

Parameters:
set A mapping from parameter names to their values. These parameters should be stored for future use.
unset 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:

A list of the names of parameters with changes that will not take effect until the account is reconnected (this may be empty, e.g. if all the parameters are D-Bus properties or parameters for which the account manager has specific support). User interfaces that require "instant apply" semantics MAY call Reconnect in response to receiving a non-empty list.

QDBusPendingReply Reconnect (  )  [inline, slot]

Begins a call to the D-Bus method "Reconnect" on the remote object.

Re-connect this account. If the account is currently disconnected and the requested presence is offline, or if the account is not <tp:member-ref>Enabled</tp:member-ref> or not <tp:member-ref>Valid</tp:member-ref>, 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 <tp:member-ref>RequestedPresence</tp:member-ref>, setting its value to (OFFLINE, "offline", ""), waiting for the change to take effect, then setting its value to the value that was previously remembered.

<tp:rationale>

Clients desiring "instant apply" semantics for CM parameters MAY call this method to achieve that. </tp:rationale>

In particular, if the account's <tp:member-ref>Connection</tp:member-ref> is in the Connecting state, calling this method causes the attempt to connect to be aborted and re-tried.

<tp:rationale>

This is necessary to ensure that the new parameters are picked up. </tp:rationale>

void Removed (  )  [signal]

Represents the signal "Removed" on the remote object.

This account has been removed. 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.

void AccountPropertyChanged ( const QVariantMap &  properties  )  [signal]

Represents the signal "AccountPropertyChanged" on the remote object.

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.

Parameters:
properties 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.
virtual void invalidate ( Tp::DBusProxy *  ,
const QString &  ,
const QString &   
) [protected, virtual]

Property Documentation

QStringList Interfaces [read]

Represents property "Interfaces" on the remote object.

A list of the extra interfaces provided by this account.

QString DisplayName [read, write]

Represents property "DisplayName" on the remote object.

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. This approximately corresponds to "display name" in NMC 4.x and Decibel.

QString Icon [read, write]

Represents property "Icon" on the remote object.

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. This approximately corresponds to mc_profile_get_icon_name (or possibly mc_profile_get_branding_icon_name) in NMC 4.x. It's accessed via the account rather than the profile because we no longer have profiles as a core concept.

bool Valid [read]

Represents property "Valid" on the remote object.

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

bool Enabled [read, write]

Represents property "Enabled" on the remote object.

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.

<tp: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.

</tp:rationale>

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.

<tp:rationale>

There doesn't seem to be any good reason not to allow this. </tp:rationale>

QString Nickname [read, write]

Represents property "Nickname" on the remote object.

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. 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. This corresponds to NMC 4.x mc_account_get_alias.

QVariantMap Parameters [read]

Represents property "Parameters" on the remote object.

A map from connection manager parameter names (as in the <tp:dbus-ref namespace="org.freedesktop.Telepathy">ConnectionManager</tp:dbus-ref> 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 Set() - use <tp:member-ref>UpdateParameters</tp:member-ref> instead.

<tp:rationale> This avoids NMC being tied to gconf as a matter of API. </tp:rationale>

Tp::SimplePresence AutomaticPresence [read, write]

Represents property "AutomaticPresence" on the remote object.

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

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

The <tp:type>Connection_Presence_Type</tp:type> in the structure SHOULD NOT be Offline or Unset.

<tp: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. </tp:rationale>

bool ConnectAutomatically [read, write]

Represents property "ConnectAutomatically" on the remote object.

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). This approximately corresponds to NMC 4.x "enabled" and Decibel "autoreconnect".

QDBusObjectPath Connection [read]

Represents property "Connection" on the remote object.

Either the object path of the <tp:dbus-ref namespace="org.freedesktop.Telepathy">Connection</tp:dbus-ref> 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 '.'.

<tp:rationale> Object paths aren't nullable, so we can't use an empty string. </tp:rationale>

uint ConnectionStatus [read]

Represents property "ConnectionStatus" on the remote object.

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. 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. This vaguely corresponds to GetCurrentStatus in NMC 4.x.

uint ConnectionStatusReason [read]

Represents property "ConnectionStatusReason" on the remote object.

The reason for the last change to ConnectionStatus. The account manager is expected to set this by observing signals from the Connection. If you weren't watching the Connection at the time it failed, you can't tell why - unless the AM can tell you. This is part of GetCurrentStatus in NMC 4.x.

Tp::SimplePresence CurrentPresence [read]

Represents property "CurrentPresence" on the remote object.

The actual presence. If the connection is not online, this should be (Connection_Presence_Type_Offline, "", ""). If the connection is online but does not support the SimplePresence interface, this should be (Connection_Presence_Type_Unset, "", ""). The account manager is expected to set this by observing signals from the Connection. This corresponds to GetPresenceActual in NMC 4.x.

Tp::SimplePresence RequestedPresence [read, write]

Represents property "RequestedPresence" on the remote object.

The requested presence for this account. When this is changed, the account manager should attempt to manipulate the connection manager to make <tp:member-ref>CurrentPresence</tp:member-ref> match <tp:member-ref>RequestedPresence</tp:member-ref> 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 <tp:member-ref>AutomaticPresence</tp:member-ref>.

<tp:rationale> This corresponds to e.g. GetPresence and GetPresenceMessage in NMC 4.x. </tp:rationale>

QString NormalizedName [read]

Represents property "NormalizedName" on the remote object.

The normalized user ID of the local user on this account (i.e. the string returned when the <tp:dbus-ref namespace="org.freedesktop.Telepathy.Connection">InspectHandles</tp:dbus-ref> method is called on the result of <tp:dbus-ref namespace="org.freedesktop.Telepathy.Connection">GetSelfHandle</tp:dbus-ref> for an active connection).

It is unspecified whether this user ID is globally unique.

<tp: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. </tp:rationale>

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.

<tp: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. </tp:rationale>

bool HasBeenOnline [read]

Represents property "HasBeenOnline" on the remote object.

If true, this account has successfully been put online at some point in the past. 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.

Copyright © 2009 Collabora Ltd. and Nokia Corporation
Telepathy-Qt4 0.2.1