QXmppJingleReason Class
| Header: | #include <QXmppJingleData.h> |
Public Types
(since QXmpp 1.5) enum | RtpErrorCondition { NoErrorCondition, InvalidCrypto, CryptoRequired } |
| enum | Type { AlternativeSession, Busy, Cancel, ConnectivityError, Decline, …, None } |
Public Functions
| QXmppJingleReason() | |
(since QXmpp 1.11) | QXmppJingleReason(QXmppJingleReason::Type type, const QString &text, std::optional<QXmppJingleReason::RtpErrorCondition> rtpError) |
(since QXmpp 1.5) QXmppJingleReason::RtpErrorCondition | rtpErrorCondition() const |
(since QXmpp 1.5) void | setRtpErrorCondition(QXmppJingleReason::RtpErrorCondition rtpErrorCondition) |
| void | setText(const QString &text) |
| void | setType(QXmppJingleReason::Type type) |
| QString | text() const |
| QXmppJingleReason::Type | type() const |
Detailed Description
The QXmppJingleReason class represents the "reason" element of a QXmppJingle element.
Member Type Documentation
[since QXmpp 1.5] enum QXmppJingleReason::RtpErrorCondition
Condition of an RTP-specific error
| Constant | Value | Description |
|---|---|---|
QXmppJingleReason::NoErrorCondition | 0 | There is no error condition. |
QXmppJingleReason::InvalidCrypto | 1 | The encryption offer is rejected. |
QXmppJingleReason::CryptoRequired | 2 | Encryption is required but not offered. |
This enum was introduced in QXmpp 1.5.
enum QXmppJingleReason::Type
This enum is used to describe a reason's type.
| Constant | Value | Description |
|---|---|---|
QXmppJingleReason::AlternativeSession | 1 | The party prefers to use an existing session with the peer rather than initiate a new session; the Jingle session ID of the alternative session SHOULD be provided as the XML character data of the <sid/> child. |
QXmppJingleReason::Busy | 2 | The party is busy and cannot accept a session. |
QXmppJingleReason::Cancel | 3 | The initiator wishes to formally cancel the session initiation request. |
QXmppJingleReason::ConnectivityError | 4 | The action is related to connectivity problems. |
QXmppJingleReason::Decline | 5 | The party wishes to formally decline the session. |
QXmppJingleReason::Expired | 6 | The session length has exceeded a pre-defined time limit (e.g., a meeting hosted at a conference service). |
QXmppJingleReason::FailedApplication | 7 | The party has been unable to initialize processing related to the application type. |
QXmppJingleReason::FailedTransport | 8 | The party has been unable to establish connectivity for the transport method. |
QXmppJingleReason::GeneralError | 9 | The action is related to a non-specific application error. |
QXmppJingleReason::Gone | 10 | The entity is going offline or is no longer available. |
QXmppJingleReason::IncompatibleParameters | 11 | The party supports the offered application type but does not support the offered or negotiated parameters. |
QXmppJingleReason::MediaError | 12 | The action is related to media processing problems. |
QXmppJingleReason::SecurityError | 13 | The action is related to a violation of local security policies. |
QXmppJingleReason::Success | 14 | The action is generated during the normal course of state management and does not reflect any error. |
QXmppJingleReason::Timeout | 15 | A request has not been answered so the sender is timing out the request. |
QXmppJingleReason::UnsupportedApplications | 16 | The party supports none of the offered application types. |
QXmppJingleReason::UnsupportedTransports | 17 | The party supports none of the offered transport methods. |
QXmppJingleReason::None | 0 |
Member Function Documentation
QXmppJingleReason::QXmppJingleReason()
Constructs an empty QXmppJingleReason.
[since QXmpp 1.11] QXmppJingleReason::QXmppJingleReason(QXmppJingleReason::Type type, const QString &text, std::optional<QXmppJingleReason::RtpErrorCondition> rtpError)
Constructs a QXmppJingleReason with specific type, error text and RTP error condition.
This function was introduced in QXmpp 1.11.
[since QXmpp 1.5] QXmppJingleReason::RtpErrorCondition QXmppJingleReason::rtpErrorCondition() const
Returns the RTP error condition as specified by XEP-0167: Jingle RTP Sessions.
This function was introduced in QXmpp 1.5.
See also setRtpErrorCondition().
[since QXmpp 1.5] void QXmppJingleReason::setRtpErrorCondition(QXmppJingleReason::RtpErrorCondition rtpErrorCondition)
Sets the rtpErrorCondition as specified by XEP-0167: Jingle RTP Sessions.
This function was introduced in QXmpp 1.5.
See also rtpErrorCondition().
void QXmppJingleReason::setText(const QString &text)
Sets the reason's textual description.
text.
See also text().
void QXmppJingleReason::setType(QXmppJingleReason::Type type)
Sets the reason's type.
See also type().
QString QXmppJingleReason::text() const
Returns the reason's textual description.
See also setText().
QXmppJingleReason::Type QXmppJingleReason::type() const
Gets the reason's type.
See also setType().