libQuotient
A Qt library for building matrix clients
Quotient::EventTemplate< EventT, StateEvent, ContentT > Class Template Reference

#include <stateevent.h>

Inheritance diagram for Quotient::EventTemplate< EventT, StateEvent, ContentT >:
Collaboration diagram for Quotient::EventTemplate< EventT, StateEvent, ContentT >:

Classes

struct  Prev
 

Public Types

using content_type = ContentT
 

Public Member Functions

 EventTemplate (const QJsonObject &fullJson)
 
template<typename... ContentParamTs>
 EventTemplate (const QString &stateKey, ContentParamTs &&... contentParams)
 
const ContentT & content () const
 
template<typename VisitorT >
void editContent (VisitorT &&visitor)
 
const std::optional< ContentT > & prevContent () const
 
QString prevSenderId () const
 
- Public Member Functions inherited from Quotient::StateEvent
 StateEvent (event_type_t type, const QString &stateKey={}, const QJsonObject &contentJson={})
 
QString replacedState () const
 
virtual bool repeatsState () const
 
- Public Member Functions inherited from Quotient::RoomEvent
 ~RoomEvent () override
 
QString displayId () const
 A convenience function to get a display string for an event ID. More...
 
QString id () const
 The event_id JSON value for the event. More...
 
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. More...
 
bool isStateEvent () 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::StateEvent
static bool isValid (const QJsonObject &fullJson)
 
static QJsonObject basicJson (const QString &matrixTypeId, const QString &stateKey={}, const QJsonObject &contentJson={})
 Make a minimal correct Matrix state event JSON. More...
 
- 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::StateEvent
static constexpr auto needsStateKey = false
 Static setting of whether a given even type uses state keys. More...
 
- Static Public Attributes inherited from Quotient::Event
static EventMetaType< EventBaseMetaType { "Event" }
 
- Protected Member Functions inherited from Quotient::StateEvent
 StateEvent (const QJsonObject &json)
 
void dumpTo (QDebug dbg) const override
 
- Protected Member Functions inherited from Quotient::RoomEvent
 RoomEvent (const QJsonObject &json)
 
- Protected Member Functions inherited from Quotient::Event
 Event (const QJsonObject &json)
 
QJsonObject & editJson ()
 

Detailed Description

template<typename EventT, typename ContentT>
class Quotient::EventTemplate< EventT, StateEvent, ContentT >

Definition at line 61 of file stateevent.h.

Member Typedef Documentation

◆ content_type

template<typename EventT , typename ContentT >
using Quotient::EventTemplate< EventT, StateEvent, ContentT >::content_type = ContentT

Definition at line 64 of file stateevent.h.

Constructor & Destructor Documentation

◆ EventTemplate() [1/2]

template<typename EventT , typename ContentT >
Quotient::EventTemplate< EventT, StateEvent, ContentT >::EventTemplate ( const QJsonObject &  fullJson)
inlineexplicit

Definition at line 77 of file stateevent.h.

◆ EventTemplate() [2/2]

template<typename EventT , typename ContentT >
template<typename... ContentParamTs>
Quotient::EventTemplate< EventT, StateEvent, ContentT >::EventTemplate ( const QString &  stateKey,
ContentParamTs &&...  contentParams 
)
inlineexplicit

Definition at line 83 of file stateevent.h.

Member Function Documentation

◆ content()

template<typename EventT , typename ContentT >
const ContentT& Quotient::EventTemplate< EventT, StateEvent, ContentT >::content ( ) const
inline

Definition at line 91 of file stateevent.h.

◆ editContent()

template<typename EventT , typename ContentT >
template<typename VisitorT >
void Quotient::EventTemplate< EventT, StateEvent, ContentT >::editContent ( VisitorT &&  visitor)
inline

Definition at line 94 of file stateevent.h.

◆ prevContent()

template<typename EventT , typename ContentT >
const std::optional<ContentT>& Quotient::EventTemplate< EventT, StateEvent, ContentT >::prevContent ( ) const
inline

Definition at line 99 of file stateevent.h.

◆ prevSenderId()

template<typename EventT , typename ContentT >
QString Quotient::EventTemplate< EventT, StateEvent, ContentT >::prevSenderId ( ) const
inline

Definition at line 100 of file stateevent.h.


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