QXmppJingleMessageInitiation Class

The QXmppJingleMessageInitiation class holds information about the JMI element in the current context. More...

Header:	`#include <QXmppJingleMessageInitiation>`
Since:	QXmpp 1.6

List of all members, including inherited members

Public Functions

QXmppTask<QXmpp::SendResult>	finish(std::optional<QXmppJingleReason> reason, const QString &migratedTo = {})
QXmppTask<QXmpp::SendResult>	proceed()
QXmppTask<QXmpp::SendResult>	reject(std::optional<QXmppJingleReason> reason, bool containsTieBreak = false)
`(since QXmpp 1.14)` const QString &	remoteJid() const
QXmppTask<QXmpp::SendResult>	retract(std::optional<QXmppJingleReason> reason, bool containsTieBreak = false)
QXmppTask<QXmpp::SendResult>	ring()

Signals

void	closed(const QXmppJingleMessageInitiation::Result &result)
void	proceeded(const QString &id, const QString &remoteResource)
void	ringing()

Detailed Description

Member Function Documentation

`[signal]` void QXmppJingleMessageInitiation::closed(const QXmppJingleMessageInitiation::Result &result)

Emitted when a call was ended either through rejection, retraction, finish or an error.

result is the close reason.

QXmppTask<QXmpp::SendResult> QXmppJingleMessageInitiation::finish(std::optional<QXmppJingleReason> reason, const QString &migratedTo = {})

Creates a JMI element of type "finish" and sends a request containing the element. The default reason type/tag will be "success" with text "Success".

reason is the reason object for the finish element. migratedTo is the JMI id the session has been migrated to.

QXmppTask<QXmpp::SendResult> QXmppJingleMessageInitiation::proceed()

Creates a JMI element of type "proceed" and sends a request containing the element.

`[signal]` void QXmppJingleMessageInitiation::proceeded(const QString &id, const QString &remoteResource)

Emitted when a propose request was successfully processed and accepted.

id is the belonging JMI id. remoteResource is the resource of the call partner about to be called.

QXmppTask<QXmpp::SendResult> QXmppJingleMessageInitiation::reject(std::optional<QXmppJingleReason> reason, bool containsTieBreak = false)

Creates a JMI element of type "reject" and sends a request containing the element. The default reason tag/type will be "busy" with text "Busy".

reason is the reason object for the reject element. containsTieBreak specifies whether the reject element contains a tie-break tag or not.

`[since QXmpp 1.14]` const QString &QXmppJingleMessageInitiation::remoteJid() const

Returns the call partner's bare JID.

This function was introduced in QXmpp 1.14.

QXmppTask<QXmpp::SendResult> QXmppJingleMessageInitiation::retract(std::optional<QXmppJingleReason> reason, bool containsTieBreak = false)

Creates a JMI element of type "retract" and sends a request containing the element. The default reason tag/type will be "cancel" with text "Retracted".

reason is the reason object for the retract element. containsTieBreak specifies whether the retract element contains a tie-break tag or not.

QXmppTask<QXmpp::SendResult> QXmppJingleMessageInitiation::ring()

Creates a JMI element of type "ringing" and sends a request containing the element.

`[signal]` void QXmppJingleMessageInitiation::ringing()

Emitted when a propose request was accepted and the device starts ringing.

Contents