The QXmppDiscoveryManager class makes it possible to discover information about other entities as defined by XEP-0030: Service Discovery. More...

#include <QXmppDiscoveryManager.h>

Inheritance diagram for QXmppDiscoveryManager:

[legend]

Collaboration diagram for QXmppDiscoveryManager:

[legend]

Public Types
using	InfoResult = std::variant< QXmppDiscoveryIq, QXmppError >

using	ItemsResult = std::variant< QList< QXmppDiscoveryIq::Item >, QXmppError >

Signals
void	infoReceived (const QXmppDiscoveryIq &)
	This signal is emitted when an information response is received.

void	itemsReceived (const QXmppDiscoveryIq &)
	This signal is emitted when an items response is received.

Signals inherited from QXmppLoggable
void	setGauge (const QString &gauge, double value)
	Sets the given gauge to value.

void	logMessage (QXmppLogger::MessageType type, const QString &msg)
	This signal is emitted to send logging messages.

void	updateCounter (const QString &counter, qint64 amount=1)
	Updates the given counter by amount.

Public Member Functions
QXmppDiscoveryIq	capabilities ()

QString	requestInfo (const QString &jid, const QString &node=QString())

QString	requestItems (const QString &jid, const QString &node=QString())

QXmppTask< InfoResult >	requestDiscoInfo (const QString &jid, const QString &node={})

QXmppTask< ItemsResult >	requestDiscoItems (const QString &jid, const QString &node={})

QString	clientCapabilitiesNode () const

void	setClientCapabilitiesNode (const QString &)

QString	clientCategory () const

void	setClientCategory (const QString &)

void	setClientName (const QString &)

QString	clientName () const

QString	clientType () const

void	setClientType (const QString &)

QXmppDataForm	clientInfoForm () const

void	setClientInfoForm (const QXmppDataForm &form)

Public Member Functions inherited from QXmppClientExtension
	QXmppClientExtension ()

virtual QStringList	discoveryFeatures () const

virtual QList< QXmppDiscoveryIq::Identity >	discoveryIdentities () const

virtual bool	handleStanza (const QDomElement &stanza)
	You need to implement this method to process incoming XMPP stanzas.

virtual bool	handleStanza (const QDomElement &stanza, const std::optional< QXmppE2eeMetadata > &e2eeMetadata)
	You need to implement this method to process incoming XMPP stanzas.

Public Member Functions inherited from QXmppLoggable
	QXmppLoggable (QObject *parent=nullptr)

Additional Inherited Members
Protected Member Functions inherited from QXmppClientExtension
QXmppClient *	client ()

virtual void	setClient (QXmppClient *client)

void	injectIq (const QDomElement &element, const std::optional< QXmppE2eeMetadata > &e2eeMetadata)

bool	injectMessage (QXmppMessage &&message)

Protected Member Functions inherited from QXmppLoggable
void	debug (const QString &message)

void	info (const QString &message)

void	warning (const QString &message)

void	logReceived (const QString &message)

void	logSent (const QString &message)

Detailed Description

The QXmppDiscoveryManager class makes it possible to discover information about other entities as defined by XEP-0030: Service Discovery.

Member Typedef Documentation

◆ InfoResult

QXmppDiscoveryManager::InfoResult

Contains the discovery information result in the form of an QXmppDiscoveryIq or (in case the request did not succeed) a QXmppStanza::Error.

Since: QXmpp 1.5

◆ ItemsResult

QXmppDiscoveryManager::ItemsResult

Contains a list of service discovery items or (in case the request did not succeed) a QXmppStanza::Error.

Since: QXmpp 1.5

Member Function Documentation

◆ capabilities()

QXmppDiscoveryIq QXmppDiscoveryManager::capabilities ( )

Returns the client's full capabilities.

◆ clientCapabilitiesNode()

QString QXmppDiscoveryManager::clientCapabilitiesNode ( ) const

Returns the capabilities node of the local XMPP client.

By default this is "https://github.com/qxmpp-project/qxmpp".

◆ clientCategory()

QString QXmppDiscoveryManager::clientCategory ( ) const

Returns the category of the local XMPP client.

By default this is "client".

◆ clientInfoForm()

QXmppDataForm QXmppDiscoveryManager::clientInfoForm ( ) const

Returns the client's extended information form, as defined by XEP-0128: Service Discovery Extensions.

◆ clientName()

QString QXmppDiscoveryManager::clientName ( ) const

Returns the name of the local XMPP client.

By default this is "Based on QXmpp x.y.z".

◆ clientType()

QString QXmppDiscoveryManager::clientType ( ) const

Returns the type of the local XMPP client.

With Qt builds for Android, Blackberry, iOS or Windows Phone this is set to "phone", otherwise it defaults to "pc".

◆ requestDiscoInfo()

QXmppTask< QXmppDiscoveryManager::InfoResult > QXmppDiscoveryManager::requestDiscoInfo	(	const QString &	jid,
		const QString &	node = `{}`
	)

Requests information from the specified XMPP entity.

Parameters

jid	The target entity's JID.
node	The target node (optional).

Warning: THIS API IS NOT FINALIZED YET!

Since: QXmpp 1.5

◆ requestDiscoItems()

QXmppTask< QXmppDiscoveryManager::ItemsResult > QXmppDiscoveryManager::requestDiscoItems	(	const QString &	jid,
		const QString &	node = `{}`
	)

Requests items from the specified XMPP entity.

Parameters

jid	The target entity's JID.
node	The target node (optional).

Warning: THIS API IS NOT FINALIZED YET!

Since: QXmpp 1.5

◆ requestInfo()

QString QXmppDiscoveryManager::requestInfo	(	const QString &	jid,
		const QString &	node = `QString()`
	)

Requests information from the specified XMPP entity.

Parameters

jid	The target entity's JID.
node	The target node (optional).

◆ requestItems()

QString QXmppDiscoveryManager::requestItems	(	const QString &	jid,
		const QString &	node = `QString()`
	)

Requests items from the specified XMPP entity.

Parameters

jid	The target entity's JID.
node	The target node (optional).

◆ setClientCapabilitiesNode()

void QXmppDiscoveryManager::setClientCapabilitiesNode ( const QString & node )

Sets the capabilities node of the local XMPP client.

Parameters

node

◆ setClientCategory()

void QXmppDiscoveryManager::setClientCategory ( const QString & category )

Sets the category of the local XMPP client.

You can find a list of valid categories at: http://xmpp.org/registrar/disco-categories.html

Parameters

◆ setClientInfoForm()

void QXmppDiscoveryManager::setClientInfoForm ( const QXmppDataForm & form )

Sets the client's extended information form, as defined by XEP-0128: Service Discovery Extensions.

◆ setClientName()

void QXmppDiscoveryManager::setClientName ( const QString & name )

Sets the name of the local XMPP client.

Parameters

name

◆ setClientType()

void QXmppDiscoveryManager::setClientType ( const QString & type )

Sets the type of the local XMPP client.

You can find a list of valid types at: http://xmpp.org/registrar/disco-categories.html

Parameters

type

The documentation for this class was generated from the following files:

QXmppDiscoveryManager.h
QXmppDiscoveryManager.cpp

Public Types

Signals

Public Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ InfoResult

◆ ItemsResult

Member Function Documentation

◆ capabilities()

◆ clientCapabilitiesNode()

◆ clientCategory()

◆ clientInfoForm()

◆ clientName()

◆ clientType()

◆ requestDiscoInfo()

◆ requestDiscoItems()

◆ requestInfo()

◆ requestItems()

◆ setClientCapabilitiesNode()

◆ setClientCategory()

◆ setClientInfoForm()

◆ setClientName()

◆ setClientType()