Tp::Client::ChannelInterfaceSubjectInterface Class Reference

#include <TelepathyQt/Channel>

Inherits Tp::AbstractInterface.

Public Slots
QDBusPendingReply	SetSubject (const QString &subject, int timeout=-1)

Public Member Functions
	ChannelInterfaceSubjectInterface (const QString &busName, const QString &objectPath, QObject *parent=0)
	ChannelInterfaceSubjectInterface (const QDBusConnection &connection, const QString &busName, const QString &objectPath, QObject *parent=0)
	ChannelInterfaceSubjectInterface (Tp::DBusProxy *proxy)
	ChannelInterfaceSubjectInterface (const Tp::Client::ChannelInterface &mainInterface)
	ChannelInterfaceSubjectInterface (const Tp::Client::ChannelInterface &mainInterface, QObject *parent)
Tp::PendingVariant *	requestPropertySubject () const
Tp::PendingVariant *	requestPropertyActor () const
Tp::PendingVariant *	requestPropertyActorHandle () const
Tp::PendingVariant *	requestPropertyTimestamp () const
Tp::PendingVariant *	requestPropertyCanSet () 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.Subject2".

Constructor & Destructor Documentation

ChannelInterfaceSubjectInterface() [1/5]

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

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

ChannelInterfaceSubjectInterface() [2/5]

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

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

ChannelInterfaceSubjectInterface() [3/5]

Tp::Client::ChannelInterfaceSubjectInterface::ChannelInterfaceSubjectInterface

(

Tp::DBusProxy *

proxy

)

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

ChannelInterfaceSubjectInterface() [4/5]

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

explicit

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

ChannelInterfaceSubjectInterface() [5/5]

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

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

inlinestatic

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

Returns

The D-Bus interface name.

requestPropertySubject()

Tp::PendingVariant* Tp::Client::ChannelInterfaceSubjectInterface::requestPropertySubject ( ) const

inline

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

The human-readable subject on the channel such as the topic in an IRC channel, or the room name in XMPP MUCs.

This property replaces the subject Telepathy property of Text channels, as Telepathy properties are soon to be deprecated completely.

This property may change during the lifetime of the channel and MUST not be included in a channel request.

Returns

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

requestPropertyActor()

Tp::PendingVariant* Tp::Client::ChannelInterfaceSubjectInterface::requestPropertyActor ( ) const

inline

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

The normalized contact ID representing who last modified the subject, or the empty string if it is not known.

This property replaces the subject-contact Telepathy property of Text channels, as Telepathy properties are soon to be deprecated completely.

Returns

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

requestPropertyActorHandle()

Tp::PendingVariant* Tp::Client::ChannelInterfaceSubjectInterface::requestPropertyActorHandle ( ) const

inline

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

The handle corresponding to Actor , or 0 if the Actor is unknown.

Returns

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

requestPropertyTimestamp()

Tp::PendingVariant* Tp::Client::ChannelInterfaceSubjectInterface::requestPropertyTimestamp ( ) const

inline

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

A unix timestamp indicating when the subject was last modified, or INT_MAX64 if unknown.

This property replaces the subject-timestamp Telepathy property of Text channels, as Telepathy properties are soon to be deprecated completely.

Returns

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

requestPropertyCanSet()

Tp::PendingVariant* Tp::Client::ChannelInterfaceSubjectInterface::requestPropertyCanSet ( ) const

inline

Asynchronous getter for the remote object property CanSet of type bool.

TRUE if the Subject property can be set by the user by calling SetSubject() , otherwise FALSE.

If implementations are unsure of what this value should be it SHOULD still be set to what it believes the value is. As a result, clients should be aware that SetSubject() can still fail even with this property set to TRUE.

In XMPP it is impossible to know whether an occupant can set the subject as XMPP server implementations are wildly inconsistent.

Returns

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

requestAllProperties()

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

SetSubject

QDBusPendingReply Tp::Client::ChannelInterfaceSubjectInterface::SetSubject ( const QString &  subject, int  timeout = -1  )

inlineslot

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

Set the room's subject. Clients SHOULD look at the subject flags before calling this method as the user might not have permission to set the subject.

A successful return of this method indicates a successful change in subject, but clients should still listen for changes to the Subject property for further changes by other users or the server.

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

Parameters

subject	The new subject.
timeout	The timeout in milliseconds.

invalidate()

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

protectedvirtual

Reimplemented from Tp::AbstractInterface.