Telepathy::Client::PropertiesInterfaceInterface Class Reference
[Telepathy Properties proxy]

#include <TelepathyQt4/Client/Properties>

Inheritance diagram for Telepathy::Client::PropertiesInterfaceInterface:

Inheritance graph
[legend]
Collaboration diagram for Telepathy::Client::PropertiesInterfaceInterface:

Collaboration graph
[legend]

List of all members.

Public Slots

QDBusPendingReply
< Telepathy::PropertyValueList
GetProperties (const Telepathy::UIntList &properties)
QDBusPendingReply
< Telepathy::PropertySpecList
ListProperties ()
QDBusPendingReply SetProperties (const Telepathy::PropertyValueList &properties)

Signals

void PropertiesChanged (const Telepathy::PropertyValueList &properties)
void PropertyFlagsChanged (const Telepathy::PropertyFlagsChangeList &properties)

Public Member Functions

 PropertiesInterfaceInterface (const QString &serviceName, const QString &objectPath, QObject *parent=0)
 PropertiesInterfaceInterface (const QDBusConnection &connection, const QString &serviceName, const QString &objectPath, QObject *parent=0)
 PropertiesInterfaceInterface (Telepathy::Client::DBusProxy *proxy)
 PropertiesInterfaceInterface (const Telepathy::Client::AbstractInterface &mainInterface)
 PropertiesInterfaceInterface (const Telepathy::Client::AbstractInterface &mainInterface, QObject *parent)

Static Public Member Functions

static const char * staticInterfaceName ()

Protected Member Functions

virtual void invalidate (Telepathy::Client::DBusProxy *, const QString &, const QString &)


Detailed Description

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

Constructor & Destructor Documentation

Telepathy::Client::PropertiesInterfaceInterface::PropertiesInterfaceInterface ( const QString &  serviceName,
const QString &  objectPath,
QObject *  parent = 0 
)

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

Parameters:
serviceName Name of the service the object is on.
objectPath Path to the object on the service.
parent Passed to the parent class constructor.

Telepathy::Client::PropertiesInterfaceInterface::PropertiesInterfaceInterface ( const QDBusConnection &  connection,
const QString &  serviceName,
const QString &  objectPath,
QObject *  parent = 0 
)

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

Parameters:
connection The bus via which the object can be reached.
serviceName Name of the service the object is on.
objectPath Path to the object on the service.
parent Passed to the parent class constructor.

Telepathy::Client::PropertiesInterfaceInterface::PropertiesInterfaceInterface ( Telepathy::Client::DBusProxy proxy  ) 

Creates a PropertiesInterfaceInterface 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.

Telepathy::Client::PropertiesInterfaceInterface::PropertiesInterfaceInterface ( const Telepathy::Client::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:
mainInterface The proxy to use.

Telepathy::Client::PropertiesInterfaceInterface::PropertiesInterfaceInterface ( const Telepathy::Client::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:
mainInterface The proxy to use.
parent Passed to the parent class constructor.


Member Function Documentation

QDBusPendingReply<Telepathy::PropertyValueList> Telepathy::Client::PropertiesInterfaceInterface::GetProperties ( const Telepathy::UIntList properties  )  [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.

Parameters:
properties An array of property identifiers
Returns:

An array of structs containing:

  • integer identifiers
  • variant boxed values

References Telepathy::Client::AbstractInterface::invalidationMessage(), and Telepathy::Client::AbstractInterface::invalidationReason().

virtual void Telepathy::Client::PropertiesInterfaceInterface::invalidate ( Telepathy::Client::DBusProxy ,
const QString &  ,
const QString &   
) [protected, virtual]

QDBusPendingReply<Telepathy::PropertySpecList> Telepathy::Client::PropertiesInterfaceInterface::ListProperties (  )  [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.

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

References Telepathy::Client::AbstractInterface::invalidationMessage(), and Telepathy::Client::AbstractInterface::invalidationReason().

void Telepathy::Client::PropertiesInterfaceInterface::PropertiesChanged ( const Telepathy::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 Telepathy::Client::PropertiesInterfaceInterface::PropertyFlagsChanged ( const Telepathy::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.

QDBusPendingReply Telepathy::Client::PropertiesInterfaceInterface::SetProperties ( const Telepathy::PropertyValueList properties  )  [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.

Parameters:
properties A dictionary mapping integer identifiers to boxed values

References Telepathy::Client::AbstractInterface::invalidationMessage(), and Telepathy::Client::AbstractInterface::invalidationReason().

static const char* Telepathy::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.


Generated on Thu Mar 5 18:52:03 2009 for TelepathyQt4-0.1.1 by  doxygen 1.5.8