libQuotient
A Qt library for building matrix clients
Quotient::QOlmOutboundGroupSession Class Reference

#include <qolmoutboundsession.h>

Public Member Functions

 QOlmOutboundGroupSession ()
 
QByteArray pickle (const PicklingKey &key) const
 Serialises a QOlmOutboundGroupSession to encrypted Base64. More...
 
QByteArray encrypt (const QByteArray &plaintext) const
 Encrypts a plaintext message using the session. More...
 
uint32_t sessionMessageIndex () const
 
QByteArray sessionId () const
 Get a base64-encoded identifier for this session. More...
 
QByteArray sessionKey () const
 
int messageCount () const
 
void setMessageCount (int messageCount)
 
QDateTime creationTime () const
 
void setCreationTime (const QDateTime &creationTime)
 
OlmErrorCode lastErrorCode () const
 
const char * lastError () const
 

Static Public Member Functions

static QOlmExpected< QOlmOutboundGroupSessionunpickle (QByteArray &&pickled, const PicklingKey &key)
 

Detailed Description

An out-bound group session is responsible for encrypting outgoing communication in a Megolm session.

Definition at line 15 of file qolmoutboundsession.h.

Constructor & Destructor Documentation

◆ QOlmOutboundGroupSession()

Quotient::QOlmOutboundGroupSession::QOlmOutboundGroupSession ( )

Member Function Documentation

◆ creationTime()

QDateTime Quotient::QOlmOutboundGroupSession::creationTime ( ) const

◆ encrypt()

QByteArray Quotient::QOlmOutboundGroupSession::encrypt ( const QByteArray &  plaintext) const

Encrypts a plaintext message using the session.

◆ lastError()

const char* Quotient::QOlmOutboundGroupSession::lastError ( ) const

◆ lastErrorCode()

OlmErrorCode Quotient::QOlmOutboundGroupSession::lastErrorCode ( ) const

◆ messageCount()

int Quotient::QOlmOutboundGroupSession::messageCount ( ) const

◆ pickle()

QByteArray Quotient::QOlmOutboundGroupSession::pickle ( const PicklingKey key) const

Serialises a QOlmOutboundGroupSession to encrypted Base64.

◆ sessionId()

QByteArray Quotient::QOlmOutboundGroupSession::sessionId ( ) const

Get a base64-encoded identifier for this session.

◆ sessionKey()

QByteArray Quotient::QOlmOutboundGroupSession::sessionKey ( ) const

Get the base64-encoded current ratchet key for this session.

Each message is sent with a different ratchet key. This function returns the ratchet key that will be used for the next message.

◆ sessionMessageIndex()

uint32_t Quotient::QOlmOutboundGroupSession::sessionMessageIndex ( ) const

Get the current message index for this session.

Each message is sent with an increasing index; this returns the index for the next message.

◆ setCreationTime()

void Quotient::QOlmOutboundGroupSession::setCreationTime ( const QDateTime &  creationTime)

◆ setMessageCount()

void Quotient::QOlmOutboundGroupSession::setMessageCount ( int  messageCount)

◆ unpickle()

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

Deserialises from encrypted Base64 that was previously obtained by pickling a QOlmOutboundGroupSession.


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