Telepathy::Client::ConnectionInterfaceCapabilitiesInterface Class Reference
[Connection proxies]

#include <TelepathyQt4/Client/Connection>

Inheritance diagram for Telepathy::Client::ConnectionInterfaceCapabilitiesInterface:

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

Collaboration graph
[legend]

List of all members.

Public Slots

QDBusPendingReply
< Telepathy::CapabilityPairList
AdvertiseCapabilities (const Telepathy::CapabilityPairList &add, const QStringList &remove)
QDBusPendingReply
< Telepathy::ContactCapabilityList
GetCapabilities (const Telepathy::UIntList &handles)

Signals

void CapabilitiesChanged (const Telepathy::CapabilityChangeList &caps)

Public Member Functions

 ConnectionInterfaceCapabilitiesInterface (const QString &serviceName, const QString &objectPath, QObject *parent=0)
 ConnectionInterfaceCapabilitiesInterface (const QDBusConnection &connection, const QString &serviceName, const QString &objectPath, QObject *parent=0)
 ConnectionInterfaceCapabilitiesInterface (Telepathy::Client::DBusProxy *proxy)
 ConnectionInterfaceCapabilitiesInterface (const Telepathy::Client::ConnectionInterface &mainInterface)
 ConnectionInterfaceCapabilitiesInterface (const Telepathy::Client::ConnectionInterface &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.Connection.Interface.Capabilities."

Constructor & Destructor Documentation

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

Creates a ConnectionInterfaceCapabilitiesInterface 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::ConnectionInterfaceCapabilitiesInterface::ConnectionInterfaceCapabilitiesInterface ( const QDBusConnection &  connection,
const QString &  serviceName,
const QString &  objectPath,
QObject *  parent = 0 
)

Creates a ConnectionInterfaceCapabilitiesInterface 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::ConnectionInterfaceCapabilitiesInterface::ConnectionInterfaceCapabilitiesInterface ( Telepathy::Client::DBusProxy proxy  ) 

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

Creates a ConnectionInterfaceCapabilitiesInterface 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::ConnectionInterfaceCapabilitiesInterface::ConnectionInterfaceCapabilitiesInterface ( const Telepathy::Client::ConnectionInterface mainInterface,
QObject *  parent 
)

Creates a ConnectionInterfaceCapabilitiesInterface 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::CapabilityPairList> Telepathy::Client::ConnectionInterfaceCapabilitiesInterface::AdvertiseCapabilities ( const Telepathy::CapabilityPairList add,
const QStringList &  remove 
) [inline, slot]

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

Used by user interfaces to indicate which channel types they are able to handle on this connection. Because these may be provided by different client processes, this method accepts channel types to add and remove from the set already advertised on this connection. The type of advertised capabilities (create versus invite) is protocol-dependent and hence cannot be set by the this method. In the case of a client adding an already advertised channel type but with new channel type specific flags, the connection manager should simply add the new flags to the set of advertised capabilities.

Upon a successful invocation of this method, the <tp:member-ref>CapabilitiesChanged</tp:member-ref> signal will be emitted for the user's own handle ( <tp:dbus-ref namespace="org.freedesktop.Telepathy">Connection.GetSelfHandle</tp:dbus-ref>) by the connection manager to indicate the changes that have been made. This signal should also be monitored to ensure that the set is kept accurate - for example, a client may remove capabilities or type specific capability flags when it exits which are still provided by another client.

Parameters:
add An array of structures containing:
  • a string channel type
  • a bitwise OR of type specific capability flags
remove An array of D-Bus interface names of channel types to remove
Returns:
An array of structures describing the current capabilities containing: a string channel type a bitwise OR of type specific capability flags

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

void Telepathy::Client::ConnectionInterfaceCapabilitiesInterface::CapabilitiesChanged ( const Telepathy::CapabilityChangeList caps  )  [signal]

Represents the signal "CapabilitiesChanged" on the remote object.

Announce that there has been a change of capabilities on the given handle.

If the handle is zero, the capabilities refer to the connection itself, in some poorly defined way. This usage is deprecated and clients should ignore it.

Parameters:
caps An array of structures containing:
  • an integer handle representing the contact
  • a string channel type
  • a bitwise OR of the contact's old generic capability flags
  • a bitwise OR of the contact's new generic capability flags
  • a bitwise OR of the contact's old type specific capability flags
  • a bitwise OR of the contact's new type specific capability flags

QDBusPendingReply<Telepathy::ContactCapabilityList> Telepathy::Client::ConnectionInterfaceCapabilitiesInterface::GetCapabilities ( const Telepathy::UIntList handles  )  [inline, slot]

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

Returns an array of capabilities for the given contact handles.

Parameters:
handles 
An array of contact handles for this connection.

This may include zero, which originally meant a query for capabilities available on the connection itself. This usage is deprecated; clients SHOULD NOT do this, and connection managers SHOULD proceed as though zero had not been present in this list.

Returns:
An array of structures containing:
  • an integer handle representing the contact
  • a string channel type
  • a bitwise OR of generic capability flags for the type
  • a bitwise OR of type specific capability flags for the type

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

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

static const char* Telepathy::Client::ConnectionInterfaceCapabilitiesInterface::staticInterfaceName (  )  [inline, static]

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

Returns:
The D-Bus interface name.


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