Quotient::QOlmInboundGroupSession Class Reference

#include <qolminboundsession.h>

Public Member Functions
QByteArray	pickle (const PicklingKey &key) const
	Serialises an OlmInboundGroupSession to encrypted Base64.
QOlmExpected< std::pair< QByteArray, uint32_t > >	decrypt (const QByteArray &message)
	Decrypts ciphertext received for this group session.
QOlmExpected< QByteArray >	exportSession (uint32_t messageIndex)
uint32_t	firstKnownIndex () const
	Get the first message index we know how to decrypt.
QByteArray	sessionId () const
	Get a base64-encoded identifier for this session.
bool	isVerified () const
QByteArray	olmSessionId () const
void	setOlmSessionId (const QByteArray &newOlmSessionId)
QString	senderId () const
	The sender of this session.
void	setSenderId (const QString &senderId)
OlmErrorCode	lastErrorCode () const
const char *	lastError () const

Static Public Member Functions
static QOlmExpected< QOlmInboundGroupSession >	create (const QByteArray &key)
	Creates a new instance of OlmInboundGroupSession.
static QOlmExpected< QOlmInboundGroupSession >	importSession (const QByteArray &key)
	Import an inbound group session, from a previous export.
static QOlmExpected< QOlmInboundGroupSession >	unpickle (QByteArray &&pickled, const PicklingKey &key)

Detailed Description

An in-bound group session is responsible for decrypting incoming communication in a Megolm session.

Definition at line 15 of file qolminboundsession.h.

Member Function Documentation

create()

static QOlmExpected< QOlmInboundGroupSession > Quotient::QOlmInboundGroupSession::create ( const QByteArray &  key )

static

Creates a new instance of OlmInboundGroupSession.

decrypt()

QOlmExpected< std::pair< QByteArray, uint32_t > > Quotient::QOlmInboundGroupSession::decrypt

(

const QByteArray &

message

)

Decrypts ciphertext received for this group session.

exportSession()

QOlmExpected< QByteArray > Quotient::QOlmInboundGroupSession::exportSession

(

uint32_t

messageIndex

)

Export the base64-encoded ratchet key for this session, at the given index, in a format which can be used by import.

firstKnownIndex()

uint32_t Quotient::QOlmInboundGroupSession::firstKnownIndex

(

)

const

Get the first message index we know how to decrypt.

importSession()

static QOlmExpected< QOlmInboundGroupSession > Quotient::QOlmInboundGroupSession::importSession ( const QByteArray &  key )

static

Import an inbound group session, from a previous export.

isVerified()

bool Quotient::QOlmInboundGroupSession::isVerified

(

)

const

lastError()

const char * Quotient::QOlmInboundGroupSession::lastError

(

)

const

lastErrorCode()

OlmErrorCode Quotient::QOlmInboundGroupSession::lastErrorCode

(

)

const

olmSessionId()

QByteArray Quotient::QOlmInboundGroupSession::olmSessionId

(

)

const

The olm session that this session was received from. Required to get the device this session is from.

pickle()

QByteArray Quotient::QOlmInboundGroupSession::pickle

(

const PicklingKey &

key

)

const

Serialises an OlmInboundGroupSession to encrypted Base64.

senderId()

QString Quotient::QOlmInboundGroupSession::senderId

(

)

const

The sender of this session.

sessionId()

QByteArray Quotient::QOlmInboundGroupSession::sessionId

(

)

const

Get a base64-encoded identifier for this session.

setOlmSessionId()

void Quotient::QOlmInboundGroupSession::setOlmSessionId

(

const QByteArray &

newOlmSessionId

)

setSenderId()

void Quotient::QOlmInboundGroupSession::setSenderId

(

const QString &

senderId

)

unpickle()

static QOlmExpected< QOlmInboundGroupSession > Quotient::QOlmInboundGroupSession::unpickle ( QByteArray &&  pickled, const PicklingKey &  key  )

static

Deserialises from encrypted Base64 that was previously obtained by pickling an OlmInboundGroupSession.

---

The documentation for this class was generated from the following file:

• Quotient/e2ee/qolminboundsession.h