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

#include <TelepathyQt4/Connection>

Inherits Tp::AbstractInterface.

List of all members.

Public Slots

• QDBusPendingReply
  < Tp::ContactAttributesMap > GetContactAttributes (const Tp::UIntList &handles, const QStringList &interfaces, bool hold)

Public Member Functions

• ConnectionInterfaceContactsInterface (const QString &busName, const QString &objectPath, QObject *parent=0)
• ConnectionInterfaceContactsInterface (const QDBusConnection &connection, const QString &busName, const QString &objectPath, QObject *parent=0)
• ConnectionInterfaceContactsInterface (Tp::DBusProxy *proxy)
• ConnectionInterfaceContactsInterface (const Tp::Client::ConnectionInterface &mainInterface)
• ConnectionInterfaceContactsInterface (const Tp::Client::ConnectionInterface &mainInterface, QObject *parent)
• TELEPATHY_QT4_DEPRECATED
  QStringList ContactAttributeInterfaces () const
• Tp::PendingVariant * requestPropertyContactAttributeInterfaces () const
• Tp::PendingVariantMap * requestAllProperties () const

Static Public Member Functions

• static const char * staticInterfaceName ()

Protected Member Functions

• virtual void invalidate (Tp::DBusProxy *, const QString &, const QString &)

Properties

• QStringList ContactAttributeInterfaces

---

Detailed Description

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

---

Constructor & Destructor Documentation

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

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

Creates a ConnectionInterfaceContactsInterface 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::ConnectionInterfaceContactsInterface::ConnectionInterfaceContactsInterface

(

Tp::DBusProxy *

proxy

)

Creates a ConnectionInterfaceContactsInterface 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::ConnectionInterfaceContactsInterface::ConnectionInterfaceContactsInterface

(

const Tp::Client::ConnectionInterface &

mainInterface

)

[explicit]

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

Creates a ConnectionInterfaceContactsInterface 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::ConnectionInterfaceContactsInterface::staticInterfaceName

(

)

[inline, static]

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

Returns:

The D-Bus interface name.

TELEPATHY_QT4_DEPRECATED QStringList Tp::Client::ConnectionInterfaceContactsInterface::ContactAttributeInterfaces

(

)

const [inline]

Getter for the remote object property "ContactAttributeInterfaces".

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

Returns:

The value of the property, or a default-constructed value if the property is not readable.

Tp::PendingVariant* Tp::Client::ConnectionInterfaceContactsInterface::requestPropertyContactAttributeInterfaces

(

)

const [inline]

Asynchronous getter for the remote object property "ContactAttributeInterfaces" of type QStringList.

A list of D-Bus interfaces for which GetContactAttributes is expected to work. This cannot change during the lifetime of the Connection.

Returns:

A pending variant which will emit finished when the property has been retrieved.

Tp::PendingVariantMap* Tp::Client::ConnectionInterfaceContactsInterface::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::ContactAttributesMap> Tp::Client::ConnectionInterfaceContactsInterface::GetContactAttributes	(	const Tp::UIntList &	handles,
		const QStringList &	interfaces,
		bool	hold
	)			[inline, slot]

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

Return any number of contact attributes for the given handles.

Parameters:

	handles	An array of handles representing contacts.
	interfaces

A list of strings indicating which D-Bus interfaces the calling process is interested in. All supported attributes from these interfaces, whose values can be obtained without additional network activity, will be in the reply.

Connection managers SHOULD ignore interfaces requested which they do not support (i.e. those not mentioned in the <tp:member-ref>ContactAttributeInterfaces</tp:member-ref> property.)

<tp:rationale>

This simplifies client-side code. Clients which care may distinguish between unsupported interfaces (e.g. this Connection does not support Avatars), and interfaces on which no information is known for these contacts (e.g. we don't know the avatar tokens of any of the contacts, so we omitted them all) by inspecting <tp:member-ref>ContactAttributeInterfaces</tp:member-ref>. </tp:rationale>

Attributes from the interface <tp:dbus-ref>org.freedesktop.Telepathy.Connection</tp:dbus-ref> are always returned, and need not be requested explicitly.

As well as returning cached information immediately, the connection MAY start asynchronous requests to obtain better values for the contact attributes. If better values are later obtained by this process, they will be indicated with the usual signals (such as <tp:dbus-ref namespace="org.freedesktop.Telepathy.Connection.Interface.Aliasing">AliasesChanged</tp:dbus-ref>).

<tp:rationale> For instance, an XMPP connection manager could download vCards in response to a request for <tp:dbus-ref namespace="org.freedesktop.Telepathy.Connection.Interface">Aliasing</tp:dbus-ref> attributes. </tp:rationale>

Parameters:

hold

If true, all handles in the result have been held on behalf of the calling process, as if by a call to Connection.HoldHandles. For further round-trip avoidance.

Returns:

A dictionary mapping the contact handles to contact attributes. If any of the requested handles are in fact invalid, they are simply omitted from this mapping. If contact attributes are not immediately known, the behaviour is defined by the interface; the attribute should either be omitted from the result or replaced with a default value.

Each contact's attributes will always include at least the identifier that would be obtained by inspecting the handle (org.freedesktop.Telepathy.Connection/contact-id).

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

Reimplemented from Tp::AbstractInterface.

---

Property Documentation

QStringList Tp::Client::ConnectionInterfaceContactsInterface::ContactAttributeInterfaces [read]

Represents property "ContactAttributeInterfaces" on the remote object.

A list of D-Bus interfaces for which GetContactAttributes is expected to work. This cannot change during the lifetime of the Connection.