QXmppJingleMessageInitiationElement Class

The QXmppJingleMessageInitiationElement class represents a Jingle Message Initiation element as specified by XEP-0353: Jingle Message Initiation. More...

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

List of all members, including inherited members
QXmppJingleMessageInitiationElement is part of Stanzas.

Public Types

enum class Type { None, Propose, Ringing, Proceed, Reject, …, Finish }

Public Functions

	QXmppJingleMessageInitiationElement()
bool	containsTieBreak() const
std::optional<QXmppJingleRtpDescription>	description() const
`(since QXmpp 1.14)` QList<QXmppJingleRtpDescription>	descriptions() const
QString	id() const
QString	migratedTo() const
std::optional<QXmppJingleReason>	reason() const
void	setContainsTieBreak(bool containsTieBreak)
void	setDescription(std::optional<QXmppJingleRtpDescription> description)
`(since QXmpp 1.14)` void	setDescriptions(const QList<QXmppJingleRtpDescription> &descriptions)
void	setId(const QString &id)
void	setMigratedTo(const QString &migratedTo)
void	setReason(std::optional<QXmppJingleReason> reason)
void	setType(QXmppJingleMessageInitiationElement::Type type)
QXmppJingleMessageInitiationElement::Type	type() const

Static Public Members

bool	isJingleMessageInitiationElement(const QDomElement &element)

Detailed Description

Member Type Documentation

enum class QXmppJingleMessageInitiationElement::Type

Possible types of Jingle Message Initiation elements.

Constant	Value	Description
`QXmppJingleMessageInitiationElement::Type::None`	`0`	No type set.
`QXmppJingleMessageInitiationElement::Type::Propose`	`1`	Proposes a new Jingle session.
`QXmppJingleMessageInitiationElement::Type::Ringing`	`2`	Indicates that the callee is alerted.
`QXmppJingleMessageInitiationElement::Type::Proceed`	`3`	Indicates that the callee accepts the session proposal.
`QXmppJingleMessageInitiationElement::Type::Reject`	`4`	Indicates that the callee rejects the session proposal.
`QXmppJingleMessageInitiationElement::Type::Retract`	`5`	Retracts a previously sent session proposal.
`QXmppJingleMessageInitiationElement::Type::Finish`	`6`	Indicates that the session has ended.

Member Function Documentation

QXmppJingleMessageInitiationElement::QXmppJingleMessageInitiationElement()

Constructs a Jingle Message Initiation element.

bool QXmppJingleMessageInitiationElement::containsTieBreak() const

Returns true if the Jingle Message Initiation element contains a <tie-break/> tag.

See also setContainsTieBreak().

std::optional<QXmppJingleRtpDescription> QXmppJingleMessageInitiationElement::description() const

Returns the Jingle Message Initiation element descriptions.

See also setDescription().

`[since QXmpp 1.14]` QList<QXmppJingleRtpDescription> QXmppJingleMessageInitiationElement::descriptions() const

Returns the Jingle Message Initiation element descriptions.

This function was introduced in QXmpp 1.14.

See also setDescriptions().

QString QXmppJingleMessageInitiationElement::id() const

Returns the Jingle Message Initiation element id.

See also setId().

`[static]` bool QXmppJingleMessageInitiationElement::isJingleMessageInitiationElement(const QDomElement &element)

Returns true if passed QDomElement is a Jingle Message Initiation element

QString QXmppJingleMessageInitiationElement::migratedTo() const

Returns the Jingle Message Initiation element ID migrated to if the Jingle is being migrated to a different device.

See also setMigratedTo().

std::optional<QXmppJingleReason> QXmppJingleMessageInitiationElement::reason() const

Returns the Jingle Message Initiation element reason.

See also setReason().

void QXmppJingleMessageInitiationElement::setContainsTieBreak(bool containsTieBreak)

Sets if the Jingle Message Initiation element contains a <tie-break/> tag.

containsTieBreak.

See also containsTieBreak().

void QXmppJingleMessageInitiationElement::setDescription(std::optional<QXmppJingleRtpDescription> description)

Sets the Jingle Message Initiation element descriptions.

description.

See also description().

`[since QXmpp 1.14]` void QXmppJingleMessageInitiationElement::setDescriptions(const QList<QXmppJingleRtpDescription> &descriptions)

Sets the Jingle Message Initiation element descriptions.

descriptions.

This function was introduced in QXmpp 1.14.

See also descriptions().

void QXmppJingleMessageInitiationElement::setId(const QString &id)

Sets the Jingle Message Initiation element id.

See also id().

void QXmppJingleMessageInitiationElement::setMigratedTo(const QString &migratedTo)

Sets the Jingle Message Initiation element ID migrated to if the Jingle is being migrated to a different device.

migratedTo.

See also migratedTo().

void QXmppJingleMessageInitiationElement::setReason(std::optional<QXmppJingleReason> reason)

Sets the Jingle Message Initiation element reason.

See also reason().

void QXmppJingleMessageInitiationElement::setType(QXmppJingleMessageInitiationElement::Type type)

Sets the Jingle Message Initiation element type.

See also type().

QXmppJingleMessageInitiationElement::Type QXmppJingleMessageInitiationElement::type() const

Returns the Jingle Message Initiation element type

See also setType().

Contents