The ReadinessHelper class is a helper class used by the introspection process. More...

#include <TelepathyQt/ReadinessHelper>

Inherits QObject.

Classes
class	Introspectable
	The ReadinessHelper::Introspectable class represents a introspectable used by ReadinessHelper. More...

Public Types
typedef void(*	IntrospectFunc) (void *data)

typedef QMap< Feature, Introspectable >	Introspectables

Signals
void	statusReady (uint status)

Public Member Functions
	ReadinessHelper (RefCounted object, uint currentStatus=0, const Introspectables &introspectables=Introspectables(), QObject parent=0)

	ReadinessHelper (DBusProxy proxy, uint currentStatus=0, const Introspectables &introspectables=Introspectables(), QObject parent=0)

	~ReadinessHelper ()

void	addIntrospectables (const Introspectables &introspectables)

uint	currentStatus () const

void	setCurrentStatus (uint currentStatus)

void	forceCurrentStatus (uint currentStatus)

QStringList	interfaces () const

void	setInterfaces (const QStringList &interfaces)

Features	requestedFeatures () const

Features	actualFeatures () const

Features	missingFeatures () const

bool	isReady (const Feature &feature, QString errorName=0, QString errorMessage=0) const

bool	isReady (const Features &features, QString errorName=0, QString errorMessage=0) const

PendingReady *	becomeReady (const Features &requestedFeatures)

void	setIntrospectCompleted (const Feature &feature, bool success, const QString &errorName=QString(), const QString &errorMessage=QString())

void	setIntrospectCompleted (const Feature &feature, bool success, const QDBusError &error)

Detailed Description

The ReadinessHelper class is a helper class used by the introspection process.

Member Typedef Documentation

◆ IntrospectFunc

typedef void(* Tp::ReadinessHelper::IntrospectFunc) (void *data)

◆ Introspectables

typedef QMap<Feature, Introspectable> Tp::ReadinessHelper::Introspectables

Constructor & Destructor Documentation

◆ ReadinessHelper() [1/2]

Tp::ReadinessHelper::ReadinessHelper	(	RefCounted *	object,
		uint	currentStatus = `0`,
		const Introspectables &	introspectables = `Introspectables()`,
		QObject *	parent = `0`
	)

◆ ReadinessHelper() [2/2]

Tp::ReadinessHelper::ReadinessHelper	(	DBusProxy *	proxy,
		uint	currentStatus = `0`,
		const Introspectables &	introspectables = `Introspectables()`,
		QObject *	parent = `0`
	)

◆ ~ReadinessHelper()

Tp::ReadinessHelper::~ReadinessHelper ( )

Member Function Documentation

◆ addIntrospectables()

void Tp::ReadinessHelper::addIntrospectables ( const Introspectables & introspectables )

◆ currentStatus()

uint Tp::ReadinessHelper::currentStatus ( ) const

◆ setCurrentStatus()

void Tp::ReadinessHelper::setCurrentStatus ( uint currentStatus )

◆ forceCurrentStatus()

void Tp::ReadinessHelper::forceCurrentStatus ( uint currentStatus )

Force the current internal status to currentStatus.

Note that this method will not start a new introspection or restart the current one in case one is running.

This is useful for example when the status is unknown initially but it will become known in the first introspection run and there is no need to re-run the introspection.

Parameters

currentStatus The status to set.

◆ interfaces()

QStringList Tp::ReadinessHelper::interfaces ( ) const

◆ setInterfaces()

void Tp::ReadinessHelper::setInterfaces ( const QStringList & interfaces )

◆ requestedFeatures()

Features Tp::ReadinessHelper::requestedFeatures ( ) const

◆ actualFeatures()

Features Tp::ReadinessHelper::actualFeatures ( ) const

◆ missingFeatures()

Features Tp::ReadinessHelper::missingFeatures ( ) const

◆ isReady() [1/2]

bool Tp::ReadinessHelper::isReady	(	const Feature &	feature,
		QString *	errorName = `0`,
		QString *	errorMessage = `0`
	)		const

◆ isReady() [2/2]

bool Tp::ReadinessHelper::isReady	(	const Features &	features,
		QString *	errorName = `0`,
		QString *	errorMessage = `0`
	)		const

◆ becomeReady()

PendingReady * Tp::ReadinessHelper::becomeReady ( const Features & requestedFeatures )

◆ setIntrospectCompleted() [1/2]

void Tp::ReadinessHelper::setIntrospectCompleted	(	const Feature &	feature,
		bool	success,
		const QString &	errorName = `QString()`,
		const QString &	errorMessage = `QString()`
	)

◆ setIntrospectCompleted() [2/2]

void Tp::ReadinessHelper::setIntrospectCompleted	(	const Feature &	feature,
		bool	success,
		const QDBusError &	error
	)

◆ statusReady

void Tp::ReadinessHelper::statusReady ( uint status )

signal

Classes

Public Types

Signals

Public Member Functions