QXmppPubSubSubscription Class

Header:	`#include <QXmppPubSubSubscription>`
Since:	QXmpp 1.5

List of all members, including inherited members
QXmppPubSubSubscription is part of Stanzas.

Public Functions

	QXmppPubSubSubscription(const QString &jid = {}, const QString &node = {}, const QString &subId = {}, QXmppPubSubSubscription::State state = Invalid, QXmppPubSubSubscription::ConfigurationSupport configurationSupport = Unavailable, const QDateTime &expiry = {})
	QXmppPubSubSubscription(const QXmppPubSubSubscription &)
	QXmppPubSubSubscription(QXmppPubSubSubscription &&)
QXmppPubSubSubscription::ConfigurationSupport	configurationSupport() const
QDateTime	expiry() const
bool	isConfigurationRequired() const
bool	isConfigurationSupported() const
QString	jid() const
QString	node() const
void	setConfigurationSupport(QXmppPubSubSubscription::ConfigurationSupport support)
void	setExpiry(const QDateTime &expiry)
void	setJid(const QString &jid)
void	setNode(const QString &node)
void	setState(QXmppPubSubSubscription::State state)
void	setSubId(const QString &subId)
QXmppPubSubSubscription::State	state() const
QString	subId() const
QXmppPubSubSubscription &	operator=(QXmppPubSubSubscription &&)
QXmppPubSubSubscription &	operator=(const QXmppPubSubSubscription &)

Static Public Members

bool	isSubscription(const QDomElement &element)

Detailed Description

The QXmppPubSubSubscription class represents a PubSub subscription contained in event notifications and IQ requests, as defined in XEP-0060: Publish- Subscribe.

Member Function Documentation

QXmppPubSubSubscription::QXmppPubSubSubscription(const QString &jid = {}, const QString &node = {}, const QString &subId = {}, QXmppPubSubSubscription::State state = Invalid, QXmppPubSubSubscription::ConfigurationSupport configurationSupport = Unavailable, const QDateTime &expiry = {})

Creates a new QXmppPubSubSubscription with jid, node, subId, state, configurationSupport and expiry.

QXmppPubSubSubscription::QXmppPubSubSubscription(const QXmppPubSubSubscription &)

Copy contructor.

QXmppPubSubSubscription::QXmppPubSubSubscription(QXmppPubSubSubscription &&)

Move contructor.

QXmppPubSubSubscription::ConfigurationSupport QXmppPubSubSubscription::configurationSupport() const

Returns the availability of a subscription configuration.

See also setConfigurationSupport().

QDateTime QXmppPubSubSubscription::expiry() const

Returns the expiry date of the subscription.

If this timestamp is valid, the subscription is going to be cancelled at this date.

See also setExpiry().

bool QXmppPubSubSubscription::isConfigurationRequired() const

Returns whether configuration of the subscription required before event notifications are going to be sent to the user.

bool QXmppPubSubSubscription::isConfigurationSupported() const

Returns whether a configuration of the subscription is possible.

`[static]` bool QXmppPubSubSubscription::isSubscription(const QDomElement &element)

Returns true, if the element is a PubSub subscription element.

QString QXmppPubSubSubscription::jid() const

Returns the JID of the user of this subscription.

See also setJid().

QString QXmppPubSubSubscription::node() const

Returns the node name of this subscription.

See also setNode().

void QXmppPubSubSubscription::setConfigurationSupport(QXmppPubSubSubscription::ConfigurationSupport support)

Sets the availability of a subscription configuration.

support.

See also configurationSupport().

void QXmppPubSubSubscription::setExpiry(const QDateTime &expiry)

Sets the expiry date of the subscription.

If this timestamp is valid, the subscription is going to be cancelled at this date.

expiry.

See also expiry().

void QXmppPubSubSubscription::setJid(const QString &jid)

Sets the JID of the user of this subscription.

jid.

See also jid().

void QXmppPubSubSubscription::setNode(const QString &node)

Sets the node name of this subscription.

See also node().

void QXmppPubSubSubscription::setState(QXmppPubSubSubscription::State state)

Sets the state of the subscription.

See also state().

void QXmppPubSubSubscription::setSubId(const QString &subId)

Sets the subscription ID (may be empty).

subId.

See also subId().

QXmppPubSubSubscription::State QXmppPubSubSubscription::state() const

Returns the state of the subscription.

See also setState().

QString QXmppPubSubSubscription::subId() const

Returns the subscription ID (may be empty).

See also setSubId().

QXmppPubSubSubscription &QXmppPubSubSubscription::operator=(QXmppPubSubSubscription &&)

Move-assignment operator.

QXmppPubSubSubscription &QXmppPubSubSubscription::operator=(const QXmppPubSubSubscription &)

Copy assignment operator.

Contents