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.
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	displayId () const
	A convenience function to get a display string for an event ID.
QString	id () const
	The event_id JSON value for the event.
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
	The transaction_id JSON value for the event.
bool	isStateEvent () const
QString	stateKey () const
void	setRoomId (const QString &roomId)
	Fill the pending event object with the room id.
void	setSender (const QString &senderId)
	Fill the pending event object with the sender id.
void	setTransactionId (const QString &txnId)
	Fill the pending event object with the transaction id.
void	addId (const QString &newId)
	Add an event id to locally created events after they are sent.
void	setOriginalEvent (event_ptr_tt< EncryptedEvent > &&originalEvent)
const EncryptedEvent *	originalEvent () const
const QJsonObject	encryptedJson () const
Public Member Functions inherited from Quotient::Event
virtual const AbstractEventMetaType &	metaType () const
	Event (Event &&) noexcept=default
Event &	operator= (Event &&)=delete
virtual	~Event ()
QString	matrixType () const
	Exact Matrix type stored in JSON.
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.
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.
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.
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.
Static Public Attributes inherited from Quotient::Event
static EventMetaType< Event >	BaseMetaType { "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 83 of file keyverificationevent.h.

Constructor & Destructor Documentation

KeyVerificationStartEvent()

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

inline

Definition at line 88 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 124 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 116 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 132 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 141 of file keyverificationevent.h.

---

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

• Quotient/events/keyverificationevent.h