Tp::Client::ChannelInterfaceRoomInterface Class Reference

#include <TelepathyQt/Channel>

Inherits Tp::AbstractInterface.

Public Member Functions
	ChannelInterfaceRoomInterface (const QString &busName, const QString &objectPath, QObject *parent=0)
	ChannelInterfaceRoomInterface (const QDBusConnection &connection, const QString &busName, const QString &objectPath, QObject *parent=0)
	ChannelInterfaceRoomInterface (Tp::DBusProxy *proxy)
	ChannelInterfaceRoomInterface (const Tp::Client::ChannelInterface &mainInterface)
	ChannelInterfaceRoomInterface (const Tp::Client::ChannelInterface &mainInterface, QObject *parent)
Tp::PendingVariant *	requestPropertyRoomName () const
Tp::PendingVariant *	requestPropertyServer () const
Tp::PendingVariant *	requestPropertyCreator () const
Tp::PendingVariant *	requestPropertyCreatorHandle () const
Tp::PendingVariant *	requestPropertyCreationTimestamp () const
Tp::PendingVariantMap *	requestAllProperties () const
Public Member Functions inherited from Tp::AbstractInterface
virtual	~AbstractInterface ()
bool	isValid () const
QString	invalidationReason () const
QString	invalidationMessage () const
void	setMonitorProperties (bool monitorProperties)
bool	isMonitoringProperties () const

Static Public Member Functions
static QLatin1String	staticInterfaceName ()

Protected Member Functions
virtual void	invalidate (Tp::DBusProxy *, const QString &, const QString &)
Protected Member Functions inherited from Tp::AbstractInterface
	AbstractInterface (DBusProxy *proxy, const QLatin1String &interface)
	AbstractInterface (const QString &busName, const QString &path, const QLatin1String &interface, const QDBusConnection &connection, QObject *parent)
PendingVariant *	internalRequestProperty (const QString &name) const
PendingOperation *	internalSetProperty (const QString &name, const QVariant &newValue)
PendingVariantMap *	internalRequestAllProperties () const

Additional Inherited Members
Signals inherited from Tp::AbstractInterface
void	propertiesChanged (const QVariantMap &changedProperties, const QStringList &invalidatedProperties)
Protected Slots inherited from Tp::AbstractInterface

Detailed Description

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

Constructor & Destructor Documentation

ChannelInterfaceRoomInterface() [1/5]

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

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

ChannelInterfaceRoomInterface() [2/5]

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

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

ChannelInterfaceRoomInterface() [3/5]

Tp::Client::ChannelInterfaceRoomInterface::ChannelInterfaceRoomInterface

(

Tp::DBusProxy *

proxy

)

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

ChannelInterfaceRoomInterface() [4/5]

Tp::Client::ChannelInterfaceRoomInterface::ChannelInterfaceRoomInterface ( const Tp::Client::ChannelInterface &  mainInterface )

explicit

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

ChannelInterfaceRoomInterface() [5/5]

Tp::Client::ChannelInterfaceRoomInterface::ChannelInterfaceRoomInterface	(	const Tp::Client::ChannelInterface &	mainInterface,
		QObject *	parent
	)

Creates a ChannelInterfaceRoomInterface 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

staticInterfaceName()

static QLatin1String Tp::Client::ChannelInterfaceRoomInterface::staticInterfaceName ( )

inlinestatic

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

Returns

The D-Bus interface name.

requestPropertyRoomName()

Tp::PendingVariant* Tp::Client::ChannelInterfaceRoomInterface::requestPropertyRoomName ( ) const

inline

Asynchronous getter for the remote object property RoomName of type QString.

The human-readable identifier of a chat room. Note that if non-empty, this property (and perhaps also Server ) should be sufficient in a channel request to join the room. XMPP MUCs have a room name concept which is more like a topic, except more persistent. This D-Bus property is not this XMPP room name, but the bit before the @ in the room jid; see ChannelInterfaceRoomConfigInterface::Title for that concept.

This property cannot change during the lifetime of the channel. It should appear in the Allowed_Properties of a Requestable_Channel_Class for the connection if rooms on this connection have human-readable names, and can be joined by name.

Returns

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

requestPropertyServer()

Tp::PendingVariant* Tp::Client::ChannelInterfaceRoomInterface::requestPropertyServer ( ) const

inline

Asynchronous getter for the remote object property Server of type QString.

For protocols with a concept of chatrooms on multiple servers with different DNS names (like XMPP), the DNS name of the server hosting this channel (for example, "conference.jabber.org" or "groupchat.google.com"). For other protocols, the empty string.

This property cannot change during the lifetime of the channel. It should appear in the Allowed_Properties of a Requestable_Channel_Class for the connection if and only if non-empty values are supported.

Returns

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

requestPropertyCreator()

Tp::PendingVariant* Tp::Client::ChannelInterfaceRoomInterface::requestPropertyCreator ( ) const

inline

Asynchronous getter for the remote object property Creator of type QString.

The normalized contact ID representing who created the room; or the empty string if unknown.

Returns

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

requestPropertyCreatorHandle()

Tp::PendingVariant* Tp::Client::ChannelInterfaceRoomInterface::requestPropertyCreatorHandle ( ) const

inline

Asynchronous getter for the remote object property CreatorHandle of type uint.

The handle corresponding to Creator ; or 0 if Creator is unknown.

Returns

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

requestPropertyCreationTimestamp()

Tp::PendingVariant* Tp::Client::ChannelInterfaceRoomInterface::requestPropertyCreationTimestamp ( ) const

inline

Asynchronous getter for the remote object property CreationTimestamp of type qlonglong.

A unix timestamp indicating when the room was created; or INT_MAX64 if unknown.

Returns

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

requestAllProperties()

Tp::PendingVariantMap* Tp::Client::ChannelInterfaceRoomInterface::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.

invalidate()

void Tp::Client::ChannelInterfaceRoomInterface::invalidate ( Tp::DBusProxy *  proxy, const QString &  error, const QString &  message  )

protectedvirtual

Reimplemented from Tp::AbstractInterface.