QXmppUserTuneManager Class

Header: #include <QXmppUserTuneManager>
Since: QXmpp 1.5
Inherits: QXmppClientExtension and QXmppPubSubEventHandler

Public Types

Public Functions

QXmppTask<QXmppUserTuneManager::PublishResult> publish(const QXmppTuneItem &item)
QXmppTask<QXmppUserTuneManager::GetResult> request(const QString &jid)

Signals

void itemReceived(const QString &jid, const QXmppTuneItem &item)

Detailed Description

The QXmppUserTuneManager implements XEP-0118: User Tune. You'll receive tune updates from all presence subscriptions. You can publish tune information on the user's account (publish()) and request tune information from specific accounts (request()).

The manager needs to be added to the client first and also requires the QXmppPubSubManager.

 QXmppClient client;
 auto *pubSubManager = client.addNewExtension<QXmppPubSubManager>();
 auto *tuneManager = client.addNewExtension<QXmppUserTuneManager>();

Member Type Documentation

[alias] QXmppUserTuneManager::GetResult

Contains the User Tune information or an error.

[alias] QXmppUserTuneManager::Item

Used pubsub item type.

[alias] QXmppUserTuneManager::PublishResult

Contains the ID of the published item on success or a stanza error.

Member Function Documentation

[signal] void QXmppUserTuneManager::itemReceived(const QString &jid, const QXmppTuneItem &item)

Emitted whenever a XEP-0118: User Tune items event arrives.

jid is the JID of the contact. item contains the received tune data.

QXmppTask<QXmppUserTuneManager::PublishResult> QXmppUserTuneManager::publish(const QXmppTuneItem &item)

Publishes the User Tune item on the user's account.

QXmppTask<QXmppUserTuneManager::GetResult> QXmppUserTuneManager::request(const QString &jid)

Request User Tune information from the account with JID jid.