QXmppMixIq Class
| Header: | #include <QXmppMixIq> |
| Since: | QXmpp 1.1 |
| Inherits: | QXmppIq |
- List of all members, including inherited members
- Deprecated members
- QXmppMixIq is part of Stanzas.
Public Types
| enum | Type { None, ClientJoin, ClientLeave, Join, Leave, …, Destroy } |
Public Functions
| QXmppMixIq(const QXmppMixIq &) | |
| QXmppMixIq(QXmppMixIq &&) | |
| QXmppMixIq::Type | actionType() const |
(since QXmpp 1.7) QString | channelId() const |
(since QXmpp 1.7) QString | channelJid() const |
(since QXmpp 1.7) std::optional<QXmppMixInvitation> | invitation() const |
| QString | nick() const |
(since QXmpp 1.7) QString | participantId() const |
| void | setActionType(QXmppMixIq::Type type) |
(since QXmpp 1.7) void | setChannelId(const QString &channelId) |
(since QXmpp 1.7) void | setChannelJid(const QString &channelJid) |
(since QXmpp 1.7) void | setInvitation(const std::optional<QXmppMixInvitation> &invitation) |
| void | setNick(const QString &nick) |
(since QXmpp 1.7) void | setParticipantId(const QString &participantId) |
(since QXmpp 1.7) void | setSubscriptions(QXmppMixConfigItem::Nodes subscriptions) |
(since QXmpp 1.7) QXmppMixConfigItem::Nodes | subscriptions() const |
| QXmppMixIq & | operator=(QXmppMixIq &&) |
| QXmppMixIq & | operator=(const QXmppMixIq &) |
Detailed Description
This class represents an IQ used to do actions on a MIX channel as defined by XEP-0369: Mediated Information eXchange (MIX), XEP-0405: Mediated Information eXchange (MIX): Participant Server Requirements and XEP-0407: Mediated Information eXchange (MIX): Miscellaneous Capabilities.
Member Type Documentation
enum QXmppMixIq::Type
Action type of the MIX IQ stanza.
| Constant | Value | Description |
|---|---|---|
QXmppMixIq::None | 0 | Nothing is done. |
QXmppMixIq::ClientJoin | 1 | The client sends a request to join a MIX channel to the user's server. |
QXmppMixIq::ClientLeave | 2 | The client sends a request to leave a MIX channel to the user's server. |
QXmppMixIq::Join | 3 | The user's server forwards a join request from the client to the MIX channel. |
QXmppMixIq::Leave | 4 | The user's server forwards a leave request from the client to the MIX channel. |
QXmppMixIq::UpdateSubscription | 5 | The client subscribes to MIX nodes or unsubscribes from MIX nodes. Deprecated since QXmpp 1.7. Use QXmppMixManager instead. |
QXmppMixIq::SetNick | 6 | The client changes the user's nickname within the MIX channel. |
QXmppMixIq::Create | 7 | The client creates a MIX channel. |
QXmppMixIq::Destroy | 8 | The client destroys a MIX channel. |
Member Function Documentation
QXmppMixIq::QXmppMixIq(const QXmppMixIq &)
Default copy-constructor
QXmppMixIq::QXmppMixIq(QXmppMixIq &&)
Default move-constructor
QXmppMixIq::Type QXmppMixIq::actionType() const
Returns the MIX channel's action type.
See also setActionType().
[since QXmpp 1.7] QString QXmppMixIq::channelId() const
Returns the channel's ID (the local part of the channel JID).
It can be empty if a JID was set.
This function was introduced in QXmpp 1.7.
See also setChannelId().
[since QXmpp 1.7] QString QXmppMixIq::channelJid() const
Returns the channel's JID.
This function was introduced in QXmpp 1.7.
See also setChannelJid().
[since QXmpp 1.7] std::optional<QXmppMixInvitation> QXmppMixIq::invitation() const
Returns the channel invitation to the channel being joined via Type::ClientJoin or Type::Join.
This function was introduced in QXmpp 1.7.
See also setInvitation().
QString QXmppMixIq::nick() const
Returns the user's nickname in the channel.
See also setNick().
[since QXmpp 1.7] QString QXmppMixIq::participantId() const
Returns the participant ID for a Join/ClientJoin result.
This function was introduced in QXmpp 1.7.
See also setParticipantId().
void QXmppMixIq::setActionType(QXmppMixIq::Type type)
Sets the MIX channel's action type.
See also actionType().
[since QXmpp 1.7] void QXmppMixIq::setChannelId(const QString &channelId)
Sets the channelId (the local part of the channel JID) for creating or destroying a channel.
If you create a new channel, the channel ID can be left empty to let the server generate an ID.
This function was introduced in QXmpp 1.7.
See also channelId().
[since QXmpp 1.7] void QXmppMixIq::setChannelJid(const QString &channelJid)
Sets the channel's JID to channelJid.
This function was introduced in QXmpp 1.7.
See also channelJid().
[since QXmpp 1.7] void QXmppMixIq::setInvitation(const std::optional<QXmppMixInvitation> &invitation)
Sets the channel invitation to the channel being joined via Type::ClientJoin or Type::Join.
This function was introduced in QXmpp 1.7.
See also invitation().
void QXmppMixIq::setNick(const QString &nick)
Sets the user's nick used for the channel.
See also nick().
[since QXmpp 1.7] void QXmppMixIq::setParticipantId(const QString &participantId)
Sets the participantId (ID of the user in the channel) for a Join/ClientJoin result.
This function was introduced in QXmpp 1.7.
See also participantId().
[since QXmpp 1.7] void QXmppMixIq::setSubscriptions(QXmppMixConfigItem::Nodes subscriptions)
Sets the nodes to subscribe to via subscriptions.
This function was introduced in QXmpp 1.7.
See also subscriptions().
[since QXmpp 1.7] QXmppMixConfigItem::Nodes QXmppMixIq::subscriptions() const
Returns the nodes to subscribe to.
This function was introduced in QXmpp 1.7.
See also setSubscriptions().
QXmppMixIq &QXmppMixIq::operator=(QXmppMixIq &&)
Default move-assignment operator
QXmppMixIq &QXmppMixIq::operator=(const QXmppMixIq &)
Default assignment operator