aboutsummaryrefslogtreecommitdiff
path: root/lib/events/stickerevent.h
blob: 0957dca31222c627512a9f5e6175dd2b1daad83a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
// SDPX-FileCopyrightText: 2020 Carl Schwan <carlschwan@kde.org>
// SPDX-License-Identifier: LGPL-2.1-or-later

#pragma once

#include "roomevent.h"
#include "eventcontent.h"

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
/// displayed for for m.image events).
class QUOTIENT_API StickerEvent : public RoomEvent
{
public:
    DEFINE_EVENT_TYPEID("m.sticker", StickerEvent)

    explicit StickerEvent(const QJsonObject &obj);

    /// \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
    /// accompany and further describe the sticker.
    QString body() const;

    /// \brief Metadata about the image referred to in url including a
    /// thumbnail representation.
    const EventContent::ImageContent &image() const;

    /// \brief The URL to the sticker image. This must be a valid mxc:// URI.
    QUrl url() const;
private:
    EventContent::ImageContent m_imageContent;
};
REGISTER_EVENT_TYPE(StickerEvent)
} // namespace Quotient