The ServerAuthenticationChannel class is a base class for all ServerAuthentication types. More...

#include <TelepathyQt/ServerAuthenticationChannel>

Public Member Functions
virtual	~ServerAuthenticationChannel ()

CaptchaAuthenticationPtr	captchaAuthentication () const

bool	hasCaptchaInterface () const

Public Member Functions inherited from Tp::Channel
virtual	~Channel ()

ConnectionPtr	connection () const

QVariantMap	immutableProperties () const

QString	channelType () const

HandleType	targetHandleType () const

uint	targetHandle () const

QString	targetId () const

ContactPtr	targetContact () const

bool	isRequested () const

ContactPtr	initiatorContact () const

PendingOperation *	requestClose ()

PendingOperation *	requestLeave (const QString &message=QString(), ChannelGroupChangeReason reason=ChannelGroupChangeReasonNone)

bool	isConference () const

Contacts	conferenceInitialInviteeContacts () const

QList< ChannelPtr >	conferenceChannels () const

QList< ChannelPtr >	conferenceInitialChannels () const

QHash< uint, ChannelPtr >	conferenceOriginalChannels () const

bool	supportsConferenceMerging () const

PendingOperation *	conferenceMergeChannel (const ChannelPtr &channel)

bool	supportsConferenceSplitting () const

PendingOperation *	conferenceSplitChannel ()

ChannelGroupFlags	groupFlags () const

bool	groupCanAddContacts () const

bool	groupCanAddContactsWithMessage () const

bool	groupCanAcceptContactsWithMessage () const

PendingOperation *	groupAddContacts (const QList< ContactPtr > &contacts, const QString &message=QString())

bool	groupCanRescindContacts () const

bool	groupCanRescindContactsWithMessage () const

bool	groupCanRemoveContacts () const

bool	groupCanRemoveContactsWithMessage () const

bool	groupCanRejectContactsWithMessage () const

bool	groupCanDepartWithMessage () const

PendingOperation *	groupRemoveContacts (const QList< ContactPtr > &contacts, const QString &message=QString(), ChannelGroupChangeReason reason=ChannelGroupChangeReasonNone)

Contacts	groupContacts (bool includeSelfContact=true) const

Contacts	groupLocalPendingContacts (bool includeSelfContact=true) const

Contacts	groupRemotePendingContacts (bool includeSelfContact=true) const

GroupMemberChangeDetails	groupLocalPendingContactChangeInfo (const ContactPtr &contact) const

GroupMemberChangeDetails	groupSelfContactRemoveInfo () const

bool	groupAreHandleOwnersAvailable () const

HandleOwnerMap	groupHandleOwners () const

bool	groupIsSelfContactTracked () const

ContactPtr	groupSelfContact () const

Public Member Functions inherited from Tp::StatefulDBusProxy
	StatefulDBusProxy (const QDBusConnection &dbusConnection, const QString &busName, const QString &objectPath, const Feature &featureCore)

virtual	~StatefulDBusProxy ()

Public Member Functions inherited from Tp::DBusProxy
	DBusProxy (const QDBusConnection &dbusConnection, const QString &busName, const QString &objectPath, const Feature &featureCore)

virtual	~DBusProxy ()

QDBusConnection	dbusConnection () const

QString	busName () const

QString	objectPath () const

bool	isValid () const

QString	invalidationReason () const

QString	invalidationMessage () const

Public Member Functions inherited from Tp::Object
virtual	~Object ()

Public Member Functions inherited from Tp::RefCounted
	RefCounted ()

virtual	~RefCounted ()

Public Member Functions inherited from Tp::ReadyObject
	ReadyObject (RefCounted *object, const Feature &featureCore)

	ReadyObject (DBusProxy *proxy, const Feature &featureCore)

virtual	~ReadyObject ()

virtual bool	isReady (const Features &features=Features()) const

virtual PendingReady *	becomeReady (const Features &requestedFeatures=Features())

virtual Features	requestedFeatures () const

virtual Features	actualFeatures () const

virtual Features	missingFeatures () const

Public Member Functions inherited from Tp::OptionalInterfaceFactory< Channel >
	OptionalInterfaceFactory (Channel *this_)

	~OptionalInterfaceFactory ()

QStringList	interfaces () const

bool	hasInterface (const QString &name) const

Interface *	optionalInterface (InterfaceSupportedChecking check=CheckInterfaceSupported) const

Interface *	interface () const

Static Public Member Functions
static ServerAuthenticationChannelPtr	create (const ConnectionPtr &connection, const QString &objectPath, const QVariantMap &immutableProperties)

Static Public Member Functions inherited from Tp::Channel
static ChannelPtr	create (const ConnectionPtr &connection, const QString &objectPath, const QVariantMap &immutableProperties)

Static Public Member Functions inherited from Tp::StatefulDBusProxy
static QString	uniqueNameFrom (const QDBusConnection &bus, const QString &wellKnownOrUnique)

static QString	uniqueNameFrom (const QDBusConnection &bus, const QString &wellKnownOrUnique, QString &error, QString &message)

Static Public Attributes
static const Feature	FeatureCore

Static Public Attributes inherited from Tp::Channel
static const Feature	FeatureCore

static const Feature	FeatureConferenceInitialInviteeContacts

Protected Member Functions
	ServerAuthenticationChannel (const ConnectionPtr &connection, const QString &objectPath, const QVariantMap &immutableProperties, const Feature &coreFeature=ServerAuthenticationChannel::FeatureCore)

Protected Member Functions inherited from Tp::Channel
	Channel (const ConnectionPtr &connection, const QString &objectPath, const QVariantMap &immutableProperties, const Feature &coreFeature)

Client::ChannelInterface *	baseInterface () const

bool	groupSelfHandleIsLocalPending () const

Protected Member Functions inherited from Tp::DBusProxy
void	setBusName (const QString &busName)

void	invalidate (const QString &reason, const QString &message)

void	invalidate (const QDBusError &error)

Protected Member Functions inherited from Tp::Object
	Object ()

void	notify (const char *propertyName)

Protected Member Functions inherited from Tp::ReadyObject
ReadinessHelper *	readinessHelper () const

Protected Member Functions inherited from Tp::OptionalInterfaceFactory< Channel >
void	setInterfaces (const QStringList &interfaces)

Additional Inherited Members
Public Types inherited from Tp::OptionalInterfaceFactory< Channel >
enum	InterfaceSupportedChecking

Signals inherited from Tp::Channel
void	groupFlagsChanged (Tp::ChannelGroupFlags flags, Tp::ChannelGroupFlags added, Tp::ChannelGroupFlags removed)

void	groupCanAddContactsChanged (bool canAddContacts)

void	groupCanRemoveContactsChanged (bool canRemoveContacts)

void	groupCanRescindContactsChanged (bool canRescindContacts)

void	groupMembersChanged (const Tp::Contacts &groupMembersAdded, const Tp::Contacts &groupLocalPendingMembersAdded, const Tp::Contacts &groupRemotePendingMembersAdded, const Tp::Contacts &groupMembersRemoved, const Tp::Channel::GroupMemberChangeDetails &details)

void	groupHandleOwnersChanged (const Tp::HandleOwnerMap &owners, const Tp::UIntList &added, const Tp::UIntList &removed)

void	groupSelfContactChanged ()

void	conferenceChannelMerged (const Tp::ChannelPtr &channel)

void	conferenceChannelRemoved (const Tp::ChannelPtr &channel, const Tp::Channel::GroupMemberChangeDetails &details)

Signals inherited from Tp::DBusProxy
void	invalidated (Tp::DBusProxy *proxy, const QString &errorName, const QString &errorMessage)

Signals inherited from Tp::Object
void	propertyChanged (const QString &propertyName)

Protected Slots inherited from Tp::Channel
PendingOperation *	groupAddSelfHandle ()

Detailed Description

The ServerAuthenticationChannel class is a base class for all ServerAuthentication types.

A ServerAuthentication is a mechanism for a connection to perform an authentication operation. Such an authentication can happen in several ways (at the moment, only Captcha is supported) - this channel will expose a high-level object representing the requested method, allowing a handler to carry on the authentication procedure.

Note that when an authentication procedure succeeds, you can expect this channel to be closed automatically. Please refer to the methods' implementation docs for more details about this.

See Asynchronous Object Model, Shared Pointer Usage

Constructor & Destructor Documentation

◆ ~ServerAuthenticationChannel()

Tp::ServerAuthenticationChannel::~ServerAuthenticationChannel ( )

virtual

Class destructor.

◆ ServerAuthenticationChannel()

Tp::ServerAuthenticationChannel::ServerAuthenticationChannel	(	const ConnectionPtr &	connection,
		const QString &	objectPath,
		const QVariantMap &	immutableProperties,
		const Feature &	coreFeature = `ServerAuthenticationChannel::FeatureCore`
	)

protected

Construct a new ServerAuthenticationChannel object.

Parameters

connection	Connection owning this channel, and specifying the service.
objectPath	The channel object path.
immutableProperties	The channel immutable properties.
coreFeature	The core feature of the channel type, if any. The corresponding introspectable should depend on ServerAuthenticationChannel::FeatureCore.

Member Function Documentation

◆ create()

ServerAuthenticationChannelPtr Tp::ServerAuthenticationChannel::create	(	const ConnectionPtr &	connection,
		const QString &	objectPath,
		const QVariantMap &	immutableProperties
	)

static

Create a new ServerAuthenticationChannel channel.

Parameters

connection	Connection owning this channel, and specifying the service.
objectPath	The channel object path.
immutableProperties	The channel immutable properties.

Returns: A ServerAuthenticationChannelPtr object pointing to the newly created ServerAuthenticationChannel object.

◆ captchaAuthentication()

CaptchaAuthenticationPtr Tp::ServerAuthenticationChannel::captchaAuthentication ( ) const

Return the CaptchaAuthentication object for this channel, if the channel implements the CaptchaAuthentication interface and is a ServerAuthentication Channel.

Note that this method will return a meaningful value only if hasCaptchaInterface() returns true.

This method requires ServerAuthenticationChannel::FeatureCore to be ready.

Returns: A shared pointer to the object representing the CaptchaAuthentication interface, or a null shared pointer if the feature is not ready yet or the channel does not implement Captcha interface.

See also: hasCaptchaInterface

◆ hasCaptchaInterface()

bool Tp::ServerAuthenticationChannel::hasCaptchaInterface ( ) const

Return whether this ServerAuthenticationChannel implements Captcha as its authentication mechanism. Should this be true, captchaAuthentication() can be safely accessed.

This method requires ServerAuthenticationChannel::FeatureCore to be ready.

Returns: true if this channel implements the Captcha interface, false otherwise.

See also: captchaAuthentication

Member Data Documentation

◆ FeatureCore

const Feature Tp::ServerAuthenticationChannel::FeatureCore

static

Feature representing the core that needs to become ready to make the ServerAuthenticationChannel object usable.

Note that this feature must be enabled in order to use most ServerAuthenticationChannel methods. See specific methods documentation for more details.

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Additional Inherited Members