QXmppJingleIq Class
The QXmppJingleIq class represents an IQ used for initiating media sessions as specified by XEP-0166: Jingle. More...
| Header: | #include <QXmppJingleData.h> |
| Inherits: | QXmppIq |
- List of all members, including inherited members
- Deprecated members
- QXmppJingleIq is part of Stanzas.
Public Types
(since QXmpp 1.5) struct | RtpSessionStateActive |
(since QXmpp 1.5) struct | RtpSessionStateHold |
(since QXmpp 1.5) struct | RtpSessionStateMuting |
(since QXmpp 1.5) struct | RtpSessionStateRinging |
(since QXmpp 1.5) struct | RtpSessionStateUnhold |
| enum | Action { ContentAccept, ContentAdd, ContentModify, ContentReject, ContentRemove, …, TransportReplace } |
(since QXmpp 1.5) enum | Creator { Initiator, Responder } |
| Reason | |
(since QXmpp 1.5) | RtpSessionState |
Public Functions
| QXmppJingleIq() | |
| QXmppJingleIq(const QXmppJingleIq &other) | |
| QXmppJingleIq(QXmppJingleIq &&) | |
| QXmppJingleIq::Action | action() const |
(since QXmpp 1.11) std::optional<QXmppJingleReason> | actionReason() const |
(since QXmpp 0.9.2) void | addContent(const QXmppJingleIq::Content &content) |
(since QXmpp 0.9.2) QList<QXmppJingleIq::Content> | contents() const |
| QString | initiator() const |
(since QXmpp 1.5) QString | mujiGroupChatJid() const |
| QString | responder() const |
(since QXmpp 1.5) std::optional<QXmppJingleIq::RtpSessionState> | rtpSessionState() const |
| void | setAction(QXmppJingleIq::Action action) |
(since QXmpp 1.11) void | setActionReason(const std::optional<QXmppJingleReason> &reason) |
(since QXmpp 0.9.2) void | setContents(const QList<QXmppJingleIq::Content> &contents) |
| void | setInitiator(const QString &initiator) |
(since QXmpp 1.5) void | setMujiGroupChatJid(const QString &mujiGroupChatJid) |
| void | setResponder(const QString &responder) |
(since QXmpp 1.5) void | setRtpSessionState(const std::optional<QXmppJingleIq::RtpSessionState> &rtpSessionState) |
| void | setSid(const QString &sid) |
| QString | sid() const |
| QXmppJingleIq & | operator=(QXmppJingleIq &&) |
| QXmppJingleIq & | operator=(const QXmppJingleIq &other) |
Detailed Description
Member Type Documentation
enum QXmppJingleIq::Action
This enum is used to describe a Jingle action.
| Constant | Value |
|---|---|
QXmppJingleIq::ContentAccept | 0 |
QXmppJingleIq::ContentAdd | 1 |
QXmppJingleIq::ContentModify | 2 |
QXmppJingleIq::ContentReject | 3 |
QXmppJingleIq::ContentRemove | 4 |
QXmppJingleIq::DescriptionInfo | 5 |
QXmppJingleIq::SecurityInfo | 6 |
QXmppJingleIq::SessionAccept | 7 |
QXmppJingleIq::SessionInfo | 8 |
QXmppJingleIq::SessionInitiate | 9 |
QXmppJingleIq::SessionTerminate | 10 |
QXmppJingleIq::TransportAccept | 11 |
QXmppJingleIq::TransportInfo | 12 |
QXmppJingleIq::TransportReject | 13 |
QXmppJingleIq::TransportReplace | 14 |
[since QXmpp 1.5] enum QXmppJingleIq::Creator
Party that originally generated the content type.
| Constant | Value | Description |
|---|---|---|
QXmppJingleIq::Initiator | 0 | The initiator generated the content type. |
QXmppJingleIq::Responder | 1 | The responder generated the content type. |
This enum was introduced in QXmpp 1.5.
[alias] QXmppJingleIq::Reason
Alias to QXmppJingleReason for compatibility.
[alias, since QXmpp 1.5] QXmppJingleIq::RtpSessionState
Contains the state of an RTP session as specified by XEP-0167: Jingle RTP Sessions Informational Messages.
This typedef was introduced in QXmpp 1.5.
Member Function Documentation
QXmppJingleIq::QXmppJingleIq()
Constructs a QXmppJingleIq.
QXmppJingleIq::QXmppJingleIq(const QXmppJingleIq &other)
Copy-constructor.
QXmppJingleIq::QXmppJingleIq(QXmppJingleIq &&)
Move-constructor.
QXmppJingleIq::Action QXmppJingleIq::action() const
Returns the Jingle IQ's action.
See also setAction().
[since QXmpp 1.11] std::optional<QXmppJingleReason> QXmppJingleIq::actionReason() const
Returns the reason for the action (in most cases the error).
This function was introduced in QXmpp 1.11.
See also setActionReason().
[since QXmpp 0.9.2] void QXmppJingleIq::addContent(const QXmppJingleIq::Content &content)
Adds an element to the IQ's content elements.
content.
This function was introduced in QXmpp 0.9.2.
[since QXmpp 0.9.2] QList<QXmppJingleIq::Content> QXmppJingleIq::contents() const
Returns the IQ's content elements.
This function was introduced in QXmpp 0.9.2.
See also setContents().
QString QXmppJingleIq::initiator() const
Returns the session initiator.
See also setInitiator().
[since QXmpp 1.5] QString QXmppJingleIq::mujiGroupChatJid() const
Returns the JID of the XEP-0272: Multiparty Jingle (Muji) group chat.
This function was introduced in QXmpp 1.5.
See also setMujiGroupChatJid().
QString QXmppJingleIq::responder() const
Returns the session responder.
See also setResponder().
[since QXmpp 1.5] std::optional<QXmppJingleIq::RtpSessionState> QXmppJingleIq::rtpSessionState() const
Returns the state of an RTP session as specified by XEP-0167: Jingle RTP Sessions Informational Messages.
This function was introduced in QXmpp 1.5.
See also setRtpSessionState().
void QXmppJingleIq::setAction(QXmppJingleIq::Action action)
Sets the Jingle IQ's action.
See also action().
[since QXmpp 1.11] void QXmppJingleIq::setActionReason(const std::optional<QXmppJingleReason> &reason)
Sets the reason for the action (in most cases the error).
reason.
This function was introduced in QXmpp 1.11.
See also actionReason().
[since QXmpp 0.9.2] void QXmppJingleIq::setContents(const QList<QXmppJingleIq::Content> &contents)
Sets the IQ's content elements.
contents.
This function was introduced in QXmpp 0.9.2.
See also contents().
void QXmppJingleIq::setInitiator(const QString &initiator)
Sets the session initiator.
See also initiator().
[since QXmpp 1.5] void QXmppJingleIq::setMujiGroupChatJid(const QString &mujiGroupChatJid)
Sets the mujiGroupChatJid of the XEP-0272: Multiparty Jingle (Muji) group chat.
This function was introduced in QXmpp 1.5.
See also mujiGroupChatJid().
void QXmppJingleIq::setResponder(const QString &responder)
Sets the session responder.
See also responder().
[since QXmpp 1.5] void QXmppJingleIq::setRtpSessionState(const std::optional<QXmppJingleIq::RtpSessionState> &rtpSessionState)
Sets the rtpSessionState of an RTP session as specified by XEP-0167 (Jingle RTP Sessions) Informational Messages.
The appropriate action is set as well. Thus, it is not needed to set it manually.
This function was introduced in QXmpp 1.5.
See also rtpSessionState().
void QXmppJingleIq::setSid(const QString &sid)
Sets the session ID.
sid.
See also sid().
QString QXmppJingleIq::sid() const
Returns the session ID.
See also setSid().
QXmppJingleIq &QXmppJingleIq::operator=(QXmppJingleIq &&)
Move-assignment operator.
QXmppJingleIq &QXmppJingleIq::operator=(const QXmppJingleIq &other)
Assignment operator.