Tp::Client::ChannelInterfacePasswordInterface Class Reference

#include <TelepathyQt/Channel>

Inherits Tp::AbstractInterface.

Public Slots
QDBusPendingReply< uint >	GetPasswordFlags (int timeout=-1)
QDBusPendingReply< bool >	ProvidePassword (const QString &password, int timeout=-1)

Signals
void	PasswordFlagsChanged (uint added, uint removed)
Signals inherited from Tp::AbstractInterface
void	propertiesChanged (const QVariantMap &changedProperties, const QStringList &invalidatedProperties)

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

Constructor & Destructor Documentation

ChannelInterfacePasswordInterface() [1/5]

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

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

ChannelInterfacePasswordInterface() [2/5]

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

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

ChannelInterfacePasswordInterface() [3/5]

Tp::Client::ChannelInterfacePasswordInterface::ChannelInterfacePasswordInterface

(

Tp::DBusProxy *

proxy

)

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

ChannelInterfacePasswordInterface() [4/5]

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

explicit

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

ChannelInterfacePasswordInterface() [5/5]

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

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

inlinestatic

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

Returns

The D-Bus interface name.

requestAllProperties()

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

GetPasswordFlags

QDBusPendingReply<uint> Tp::Client::ChannelInterfacePasswordInterface::GetPasswordFlags ( int  timeout = -1 )

inlineslot

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

Returns the bitwise-OR of the flags relevant to the password on this channel. The user interface can use this to present information about which operations are currently valid.

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

Parameters

timeout

The timeout in milliseconds.

Returns

An integer with the logical OR of all the flags set (values of 
ChannelPasswordFlags)

ProvidePassword

QDBusPendingReply<bool> Tp::Client::ChannelInterfacePasswordInterface::ProvidePassword ( const QString &  password, int  timeout = -1  )

inlineslot

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

Provide the password so that the channel can be joined. Must be called with the correct password in order for channel joining to proceed if the 'provide' password flag is set.

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

Parameters

password	The password
timeout	The timeout in milliseconds.

Returns

A boolean indicating whether or not the password was correct

PasswordFlagsChanged

void Tp::Client::ChannelInterfacePasswordInterface::PasswordFlagsChanged ( uint  added, uint  removed  )

signal

Represents the signal PasswordFlagsChanged on the remote object.

Emitted when the flags as returned by GetPasswordFlags are changed. The user interface should be updated as appropriate.

Parameters

added	A bitwise OR of the flags which have been set
removed	A bitwise OR of the flags which have been cleared

invalidate()

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

protectedvirtual

Reimplemented from Tp::AbstractInterface.