Home · All Classes · All Namespaces · Modules · Functions · Files
Public Slots | Signals | Public Member Functions | Static Public Member Functions | Protected Member Functions
Tp::Client::PropertiesInterfaceInterface Class Reference

#include <TelepathyQt4/Properties>

Inherits Tp::AbstractInterface.

List of all members.

Public Slots

Signals

Public Member Functions

Static Public Member Functions

Protected Member Functions


Detailed Description

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


Constructor & Destructor Documentation

Tp::Client::PropertiesInterfaceInterface::PropertiesInterfaceInterface ( const QString busName,
const QString objectPath,
QObject parent = 0 
)

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

Parameters:
busNameName of the service the object is on.
objectPathPath to the object on the service.
parentPassed to the parent class constructor.
Tp::Client::PropertiesInterfaceInterface::PropertiesInterfaceInterface ( const QDBusConnection connection,
const QString busName,
const QString objectPath,
QObject parent = 0 
)

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

Parameters:
connectionThe bus via which the object can be reached.
busNameName of the service the object is on.
objectPathPath to the object on the service.
parentPassed to the parent class constructor.
Tp::Client::PropertiesInterfaceInterface::PropertiesInterfaceInterface ( Tp::DBusProxy proxy)

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

Parameters:
proxyThe proxy to use. It will also be the QObject::parent() for this object.
Tp::Client::PropertiesInterfaceInterface::PropertiesInterfaceInterface ( const Tp::AbstractInterface mainInterface) [explicit]

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

Parameters:
mainInterfaceThe proxy to use.
Tp::Client::PropertiesInterfaceInterface::PropertiesInterfaceInterface ( const Tp::AbstractInterface mainInterface,
QObject parent 
)

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

Parameters:
mainInterfaceThe proxy to use.
parentPassed to the parent class constructor.

Member Function Documentation

static QLatin1String Tp::Client::PropertiesInterfaceInterface::staticInterfaceName ( ) [inline, static]

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

Returns:
The D-Bus interface name.
Tp::PendingVariantMap* Tp::Client::PropertiesInterfaceInterface::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.
QDBusPendingReply<Tp::PropertyValueList> Tp::Client::PropertiesInterfaceInterface::GetProperties ( const Tp::UIntList properties,
int  timeout = -1 
) [inline, slot]

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

Returns an array of (identifier, value) pairs containing the current values of the given properties.

Note that timeout is ignored as of now. It will be used once http://bugreports.qt.nokia.com/browse/QTBUG-11775 is fixed.

Parameters:
propertiesAn array of property identifiers
timeoutThe timeout in milliseconds.
Returns:

An array of structs containing:

  • integer identifiers
  • variant boxed values
QDBusPendingReply<Tp::PropertySpecList> Tp::Client::PropertiesInterfaceInterface::ListProperties ( int  timeout = -1) [inline, slot]

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

Returns a dictionary of the properties available on this channel.

Note that timeout is ignored as of now. It will be used once http://bugreports.qt.nokia.com/browse/QTBUG-11775 is fixed.

Parameters:
timeoutThe timeout in milliseconds.
Returns:

An array of structs containing: an integer identifier a string property name a string representing the D-Bus signature of this property a bitwise OR of the flags applicable to this property

QDBusPendingReply Tp::Client::PropertiesInterfaceInterface::SetProperties ( const Tp::PropertyValueList properties,
int  timeout = -1 
) [inline, slot]

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

Takes an array of (identifier, value) pairs containing desired values to set the given properties. In the case of any errors, no properties will be changed. When the changes have been acknowledged by the server, the PropertiesChanged signal will be emitted.

All properties given must have the PROPERTY_FLAG_WRITE flag, or PermissionDenied will be returned. If any variants are of the wrong type, NotAvailable will be returned. If any given property identifiers are invalid, InvalidArgument will be returned.

Note that timeout is ignored as of now. It will be used once http://bugreports.qt.nokia.com/browse/QTBUG-11775 is fixed.

Parameters:
propertiesAn array mapping integer property identifiers to boxed values
timeoutThe timeout in milliseconds.
void Tp::Client::PropertiesInterfaceInterface::PropertiesChanged ( const Tp::PropertyValueList properties) [signal]

Represents the signal PropertiesChanged on the remote object.

Emitted when the value of readable properties has changed.

Parameters:
properties

An array of structs containing:

  • integer identifiers
  • variant boxed values

The array should contain only properties whose values have actually changed.

void Tp::Client::PropertiesInterfaceInterface::PropertyFlagsChanged ( const Tp::PropertyFlagsChangeList properties) [signal]

Represents the signal PropertyFlagsChanged on the remote object.

Emitted when the flags of some room properties have changed.

Parameters:
properties

An array of structs containing:

  • integer identifiers
  • a bitwise OR of the current flags

The array should contain only properties whose flags have actually changed.

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

Reimplemented from Tp::AbstractInterface.


Copyright © 2008-2011 Collabora Ltd. and Nokia Corporation
Telepathy-Qt4 0.8.0