QXmppOmemoEnvelope Class

The QXmppOmemoEnvelope class represents an OMEMO envelope as defined by XEP-0384: OMEMO Encryption. More...

Header: #include <QXmppOmemoEnvelope>

Public Functions

QByteArray data() const
bool isUsedForKeyExchange() const
uint32_t recipientDeviceId() const
void setData(const QByteArray &data)
void setRecipientDeviceId(uint32_t id)
void setUsedForKeyExchange(bool isUsed)

Static Public Members

bool isOmemoEnvelope(const QDomElement &element)

Detailed Description

Member Function Documentation

QByteArray QXmppOmemoEnvelope::data() const

Returns the BLOB containing the binary data for the underlying double ratchet library.

It should be treated like an obscure BLOB being passed as is to the ratchet library for further processing.

See also setData().

[static] bool QXmppOmemoEnvelope::isOmemoEnvelope(const QDomElement &element)

Determines whether the given DOM element is an OMEMO envelope.

Returns true if element is an OMEMO envelope, otherwise false.

bool QXmppOmemoEnvelope::isUsedForKeyExchange() const

Returns true if a pre-key was used to prepare this envelope, otherwise false.

The default is false.

uint32_t QXmppOmemoEnvelope::recipientDeviceId() const

Returns the ID of the recipient's device.

The ID is 0 if it is unset.

See also setRecipientDeviceId().

void QXmppOmemoEnvelope::setData(const QByteArray &data)

Sets the BLOB containing the binary data from the underlying double ratchet library.

It should be treated like an obscure BLOB produced by the ratchet library.

See also data().

void QXmppOmemoEnvelope::setRecipientDeviceId(uint32_t id)

Sets the id of the recipient's device.

The ID must be at least 1 and at most std::numeric_limits<int32_t>::max().

See also recipientDeviceId().

void QXmppOmemoEnvelope::setUsedForKeyExchange(bool isUsed)

Sets via isUsed whether a pre-key was used to prepare this envelope.

See also isUsedForKeyExchange().