QXmpp
Version: 1.10.4
|
Public Types | |
enum | State : uint8_t { Invalid, None, Pending, Subscribed, Unconfigured } |
enum | ConfigurationSupport : uint8_t { Unavailable, Available, Required } |
Static Public Member Functions | |
static QString | stateToString (State) |
static State | stateFromString (const QString &) |
static bool | isSubscription (const QDomElement &) |
The QXmppPubSubSubscription class represents a PubSub subscription contained in event notifications and IQ requests, as defined in XEP-0060: Publish- Subscribe.
enum QXmppPubSubSubscription::ConfigurationSupport : uint8_t |
The SubscribeOptionsSupport enum describes whether the availability of a subscription configuration. This is also known as <subscribe-options/>.
enum QXmppPubSubSubscription::State : uint8_t |
The State enum describes the state of a subscription.
QXmppPubSubSubscription::QXmppPubSubSubscription | ( | const QString & | jid = {} , |
const QString & | node = {} , |
||
const QString & | subId = {} , |
||
State | state = Invalid , |
||
ConfigurationSupport | configurationSupport = Unavailable , |
||
const QDateTime & | expiry = {} |
||
) |
Creates a new QXmppPubSubSubscription.
jid | |
node | |
subId | |
state | |
configurationSupport | |
expiry |
QXmppPubSubSubscription::ConfigurationSupport QXmppPubSubSubscription::configurationSupport | ( | ) | const |
Returns the availability of a subscription configuration.
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.
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 |
Returns true, if the element is a PubSub subscription element.
QString QXmppPubSubSubscription::jid | ( | ) | const |
Returns the JID of the user of this subscription.
QString QXmppPubSubSubscription::node | ( | ) | const |
Returns the node name of this subscription.
void QXmppPubSubSubscription::setConfigurationSupport | ( | ConfigurationSupport | support | ) |
Sets the availability of a subscription configuration.
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.
void QXmppPubSubSubscription::setJid | ( | const QString & | jid | ) |
Sets the JID of the user of this subscription.
void QXmppPubSubSubscription::setNode | ( | const QString & | node | ) |
Sets the node name of this subscription.
void QXmppPubSubSubscription::setState | ( | State | state | ) |
Sets the state of the subscription.
void QXmppPubSubSubscription::setSubId | ( | const QString & | subId | ) |
Sets the subscription ID (may be empty).
QXmppPubSubSubscription::State QXmppPubSubSubscription::state | ( | ) | const |
Returns the state of the subscription.
|
static |
Converts a string with a subscription state to the enum value.
|
static |
Converts a subscription state to string.
QString QXmppPubSubSubscription::subId | ( | ) | const |
Returns the subscription ID (may be empty).