Tp::Client::ChannelInterfaceChatStateInterface Class Reference

#include <TelepathyQt/Channel>

Inherits Tp::AbstractInterface.

Public Slots
QDBusPendingReply	SetChatState (uint state, int timeout=-1)

Signals
void	ChatStateChanged (uint contact, uint state)
Signals inherited from Tp::AbstractInterface
void	propertiesChanged (const QVariantMap &changedProperties, const QStringList &invalidatedProperties)

Public Member Functions
	ChannelInterfaceChatStateInterface (const QString &busName, const QString &objectPath, QObject *parent=0)
	ChannelInterfaceChatStateInterface (const QDBusConnection &connection, const QString &busName, const QString &objectPath, QObject *parent=0)
	ChannelInterfaceChatStateInterface (Tp::DBusProxy *proxy)
	ChannelInterfaceChatStateInterface (const Tp::Client::ChannelInterface &mainInterface)
	ChannelInterfaceChatStateInterface (const Tp::Client::ChannelInterface &mainInterface, QObject *parent)
Tp::PendingVariant *	requestPropertyChatStates () 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

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.ChatState".

Constructor & Destructor Documentation

ChannelInterfaceChatStateInterface() [1/5]

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

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

ChannelInterfaceChatStateInterface() [2/5]

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

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

ChannelInterfaceChatStateInterface() [3/5]

Tp::Client::ChannelInterfaceChatStateInterface::ChannelInterfaceChatStateInterface

(

Tp::DBusProxy *

proxy

)

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

ChannelInterfaceChatStateInterface() [4/5]

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

explicit

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

ChannelInterfaceChatStateInterface() [5/5]

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

Creates a ChannelInterfaceChatStateInterface 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::ChannelInterfaceChatStateInterface::staticInterfaceName ( )

inlinestatic

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

Returns

The D-Bus interface name.

requestPropertyChatStates()

Tp::PendingVariant* Tp::Client::ChannelInterfaceChatStateInterface::requestPropertyChatStates ( ) const

inline

Asynchronous getter for the remote object property ChatStates of type Tp::ChatStateMap.

A map containing the chat states of all contacts in this channel whose chat state is not Inactive.

Contacts in this channel, but who are not listed in this map, may be assumed to be in the Inactive state.

In implementations that do not have this property, its value may be assumed to be empty until a ChatStateChanged() signal indicates otherwise.

This property was not present in older versions of telepathy-spec, because chat states in XMPP are not state-recoverable (if you miss the change notification signal, there's no way to know the state). However, this property still allows clients to recover state changes that were seen by the CM before the client started to deal with the channel.

In CMs that follow older spec versions, assuming Inactive will mean that initial chat states will always be assumed to be Inactive, which is the best we can do. XEP 0085 specifies Inactive as the "neutral" state to be assumed unless told otherwise.

Returns

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

requestAllProperties()

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

SetChatState

QDBusPendingReply Tp::Client::ChannelInterfaceChatStateInterface::SetChatState ( uint  state, int  timeout = -1  )

inlineslot

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

Set the local state and notify other members of the channel that it has changed.

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

Parameters

state	The new state.
timeout	The timeout in milliseconds.

ChatStateChanged

void Tp::Client::ChannelInterfaceChatStateInterface::ChatStateChanged ( uint  contact, uint  state  )

signal

Represents the signal ChatStateChanged on the remote object.

Emitted when the state of a member of the channel has changed. This includes local state.

Parameters

contact	An integer handle for the contact.
state	The new state of this contact.

invalidate()

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

protectedvirtual

Reimplemented from Tp::AbstractInterface.