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

#include <stickerevent.h>

Inheritance diagram for Quotient::StickerEvent:
Collaboration diagram for Quotient::StickerEvent:

Public Member Functions

 StickerEvent (const QJsonObject &obj)
 
const EventContent::ImageContentimage () const
 A textual representation or associated description of the sticker image. More...
 
QUrl url () const
 The URL to the sticker image. This must be a valid mxc:// URI. More...
 
- 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::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

Sticker messages are specialised image messages that are displayed without controls (e.g. no "download" link, or light-box view on click, as would be displayed for for m.image events).

Definition at line 14 of file stickerevent.h.

Constructor & Destructor Documentation

◆ StickerEvent()

Quotient::StickerEvent::StickerEvent ( const QJsonObject &  obj)
inlineexplicit

Definition at line 19 of file stickerevent.h.

Member Function Documentation

◆ image()

const EventContent::ImageContent& Quotient::StickerEvent::image ( ) const
inline

A textual representation or associated description of the sticker image.

This could be the alt text of the original image, or a message to accompany and further describe the sticker.

Metadata about the image referred to in url including a thumbnail representation.

Definition at line 34 of file stickerevent.h.

◆ url()

QUrl Quotient::StickerEvent::url ( ) const
inline

The URL to the sticker image. This must be a valid mxc:// URI.

Definition at line 40 of file stickerevent.h.


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