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

Begins a key verification process. More...

#include <keyverificationevent.h>

Inheritance diagram for Quotient::KeyVerificationStartEvent:
Collaboration diagram for Quotient::KeyVerificationStartEvent:

Public Member Functions

 KeyVerificationStartEvent (const QString &transactionId, const QString &fromDevice)
 
QStringList keyAgreementProtocols () const
 The device ID which is initiating the process. More...
 
QStringList hashes () const
 
QStringList messageAuthenticationCodes () const
 
QString shortAuthenticationString () const
 
- Public Member Functions inherited from Quotient::KeyVerificationEvent
 RoomEvent (const QJsonObject &json)
 
- Public Member Functions inherited from Quotient::RoomEvent
 ~RoomEvent () override
 
QString id () const
 
QDateTime originTimestamp () const
 
QString roomId () const
 
QString senderId () const
 
bool isRedacted () const
 
const event_ptr_tt< RedactionEvent > & redactedBecause () const
 
QString redactionReason () const
 
QString transactionId () const
 
QString stateKey () const
 
void setRoomId (const QString &roomId)
 Fill the pending event object with the room id. More...
 
void setSender (const QString &senderId)
 Fill the pending event object with the sender id. More...
 
void setTransactionId (const QString &txnId)
 Fill the pending event object with the transaction id. More...
 
void addId (const QString &newId)
 Add an event id to locally created events after they are sent. More...
 
void setOriginalEvent (event_ptr_tt< EncryptedEvent > &&originalEvent)
 
const EncryptedEventoriginalEvent () const
 
const QJsonObject encryptedJson () const
 
- Public Member Functions inherited from Quotient::Event
virtual const AbstractEventMetaTypemetaType () const
 
 Event (Event &&) noexcept=default
 
Eventoperator= (Event &&)=delete
 
virtual ~Event ()
 
QString matrixType () const
 Exact Matrix type stored in JSON. More...
 
template<EventClass EventT>
bool is () const
 
template<typename... VisitorTs>
auto switchOnType (VisitorTs &&... visitors) const
 Apply one of the visitors based on the actual event type. More...
 
const QJsonObject & fullJson () const
 
const QJsonObject contentJson () const
 
template<typename T , typename KeyT >
const T contentPart (KeyT &&key) const
 Get a part of the content object, assuming a given type. More...
 
const QJsonObject unsignedJson () const
 
template<typename T , typename KeyT >
const T unsignedPart (KeyT &&key) const
 Get a part of the unsigned object, assuming a given type. More...
 
bool isStateEvent () const
 

Additional Inherited Members

- Static Public Member Functions inherited from Quotient::Event
static QJsonObject basicJson (const QString &matrixType, const QJsonObject &content)
 Make a minimal correct Matrix event JSON. More...
 
- Static Public Attributes inherited from Quotient::Event
static EventMetaType< EventBaseMetaType { "Event" }
 
- Protected Member Functions inherited from Quotient::RoomEvent
 RoomEvent (const QJsonObject &json)
 
void dumpTo (QDebug dbg) const override
 
- Protected Member Functions inherited from Quotient::Event
 Event (const QJsonObject &json)
 
QJsonObject & editJson ()
 

Detailed Description

Begins a key verification process.

Definition at line 80 of file keyverificationevent.h.

Constructor & Destructor Documentation

◆ KeyVerificationStartEvent()

Quotient::KeyVerificationStartEvent::KeyVerificationStartEvent ( const QString &  transactionId,
const QString &  fromDevice 
)
inline

Definition at line 85 of file keyverificationevent.h.

Member Function Documentation

◆ hashes()

QStringList Quotient::KeyVerificationStartEvent::hashes ( ) const
inline

The hash methods the sending device understands.

Note
Only exist if method is m.sas.v1

Definition at line 121 of file keyverificationevent.h.

◆ keyAgreementProtocols()

QStringList Quotient::KeyVerificationStartEvent::keyAgreementProtocols ( ) const
inline

The device ID which is initiating the process.

The verification method to use. Optional method to use to verify the other user's key with. The key agreement protocols the sending device understands.

Note
Only exist if method is m.sas.v1

Definition at line 113 of file keyverificationevent.h.

◆ messageAuthenticationCodes()

QStringList Quotient::KeyVerificationStartEvent::messageAuthenticationCodes ( ) const
inline

The message authentication codes that the sending device understands.

Note
Only exist if method is m.sas.v1

Definition at line 129 of file keyverificationevent.h.

◆ shortAuthenticationString()

QString Quotient::KeyVerificationStartEvent::shortAuthenticationString ( ) const
inline

The SAS methods the sending device (and the sending device's user) understands.

Note
Only exist if method is m.sas.v1

Definition at line 138 of file keyverificationevent.h.


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