ESCA111/neochat
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Document stickerevent

Browse Source
This commit is contained in:
James Graham
2023-05-02 20:18:07 +01:00
parent 10794628ed
commit 0fc962b147
1 changed files with 23 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

34
src/stickerevent.h
View File

@@ -8,9 +8,17 @@
namespace Quotient namespace Quotient
{ {
/// 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 * @class StickerEvent
/// displayed for for m.image events). *
* Class to define a sticker event.
*
* 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).
*
* @sa Quotient::RoomEvent
*/
class StickerEvent : public RoomEvent class StickerEvent : public RoomEvent
{ {
public: public:
@@ -22,18 +30,22 @@ public:
explicit StickerEvent(const QJsonObject &obj); explicit StickerEvent(const QJsonObject &obj);
/// \brief A textual representation or associated description of the /**
/// sticker image. * @brief A textual representation or associated description of the sticker image.
/// *
/// This could be the alt text of the original image, or a message to * This could be the alt text of the original image, or a message to accompany
/// accompany and further describe the sticker. * and further describe the sticker.
*/
QString body() const; QString body() const;
/// \brief Metadata about the image referred to in url including a /**
/// thumbnail representation. * @brief Metadata about the image referred to in url including a thumbnail representation.
*/
const EventContent::ImageContent &image() const; const EventContent::ImageContent &image() const;
/// \brief The URL to the sticker image. This must be a valid mxc:// URI. /**
* @brief The URL to the sticker image. This must be a valid mxc:// URI.
*/
QUrl url() const; QUrl url() const;
private: private: