Home · All Classes · All Namespaces · Modules · Functions · Files
Signals | Public Member Functions | Static Public Member Functions | Protected Member Functions | Properties

Tp::Client::ConnectionInterfaceBalanceInterface Class Reference
[Connection proxies]

#include <TelepathyQt4/Connection>

Inherits Tp::AbstractInterface.

List of all members.

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.Connection.Interface.Balance."


Constructor & Destructor Documentation

Tp::Client::ConnectionInterfaceBalanceInterface::ConnectionInterfaceBalanceInterface ( const QString &  busName,
const QString &  objectPath,
QObject *  parent = 0 
)

Creates a ConnectionInterfaceBalanceInterface 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.
Tp::Client::ConnectionInterfaceBalanceInterface::ConnectionInterfaceBalanceInterface ( const QDBusConnection &  connection,
const QString &  busName,
const QString &  objectPath,
QObject *  parent = 0 
)

Creates a ConnectionInterfaceBalanceInterface 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.
Tp::Client::ConnectionInterfaceBalanceInterface::ConnectionInterfaceBalanceInterface ( Tp::DBusProxy proxy  ) 

Creates a ConnectionInterfaceBalanceInterface 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.
Tp::Client::ConnectionInterfaceBalanceInterface::ConnectionInterfaceBalanceInterface ( const Tp::Client::ConnectionInterface mainInterface  )  [explicit]

Creates a ConnectionInterfaceBalanceInterface associated with the same object as the given proxy. Additionally, the created proxy will have the same parent as the given proxy.

Parameters:
mainInterface The proxy to use.
Tp::Client::ConnectionInterfaceBalanceInterface::ConnectionInterfaceBalanceInterface ( const Tp::Client::ConnectionInterface mainInterface,
QObject *  parent 
)

Creates a ConnectionInterfaceBalanceInterface associated with the same object as the given proxy. However, a different parent object can be specified.

Parameters:
mainInterface The proxy to use.
parent Passed to the parent class constructor.

Member Function Documentation

static const char* Tp::Client::ConnectionInterfaceBalanceInterface::staticInterfaceName (  )  [inline, static]

Returns the name of the interface "org.freedesktop.Telepathy.Connection.Interface.Balance", which this class represents.

Returns:
The D-Bus interface name.
TELEPATHY_QT4_DEPRECATED Tp::CurrencyAmount Tp::Client::ConnectionInterfaceBalanceInterface::AccountBalance (  )  const [inline]

Getter for the remote object property "AccountBalance".

Don't use this: it blocks the main loop. Use the asynchronous requestPropertyAccountBalance() instead.

Returns:
The value of the property, or a default-constructed value if the property is not readable.
Tp::PendingVariant* Tp::Client::ConnectionInterfaceBalanceInterface::requestPropertyAccountBalance (  )  const [inline]

Asynchronous getter for the remote object property "AccountBalance" of type Tp::CurrencyAmount.

The user's balance on the account corresponding to this <tp:dbus-ref namespace="org.freedesktop.Telepathy">Connection</tp:dbus-ref>. A negative amount may be possible on some services, and indicates that the user owes money to the service provider.

On initial connection, this property may have an unknown value, represented by Amount = 0, Scale = 2**32 - 1 (the largest possible 32-bit unsigned integer) and Currency = "".

Returns:
A pending variant which will emit finished when the property has been retrieved.
Tp::PendingVariantMap* Tp::Client::ConnectionInterfaceBalanceInterface::requestAllProperties (  )  const [inline]

Request all of the DBus properties on the interface.

Returns:
A pending variant map which will emit finished when the properties have been retrieved.
void Tp::Client::ConnectionInterfaceBalanceInterface::BalanceChanged ( const Tp::CurrencyAmount balance  )  [signal]

Represents the signal "BalanceChanged" on the remote object.

Emitted when the user's balance has changed.

Parameters:
balance 

The new value of the <tp:member-ref>AccountBalance</tp:member-ref> property.

void Tp::Client::ConnectionInterfaceBalanceInterface::invalidate ( Tp::DBusProxy proxy,
const QString &  error,
const QString &  message 
) [protected, virtual]

Reimplemented from Tp::AbstractInterface.


Property Documentation

Tp::CurrencyAmount Tp::Client::ConnectionInterfaceBalanceInterface::AccountBalance [read]

Represents property "AccountBalance" on the remote object.

The user's balance on the account corresponding to this <tp:dbus-ref namespace="org.freedesktop.Telepathy">Connection</tp:dbus-ref>. A negative amount may be possible on some services, and indicates that the user owes money to the service provider.

On initial connection, this property may have an unknown value, represented by Amount = 0, Scale = 2**32 - 1 (the largest possible 32-bit unsigned integer) and Currency = "".


Copyright © 2008-2010 Collabora Ltd. and Nokia Corporation
Telepathy-Qt4 0.4.4