aboutsummaryrefslogtreecommitdiff
path: root/lib/events/roommemberevent.h
blob: ceb7826b45807c14e9c01ba87f7e5659b04d7ff2 (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
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
// SPDX-FileCopyrightText: 2015 Felix Rohrbach <kde@fxrh.de>
// SPDX-FileCopyrightText: 2017 Kitsune Ral <Kitsune-Ral@users.sf.net>
// SPDX-FileCopyrightText: 2019 Karol Kosek <krkkx@protonmail.com>
// SPDX-License-Identifier: LGPL-2.1-or-later

#pragma once

#include "eventcontent.h"
#include "stateevent.h"
#include "quotient_common.h"

namespace Quotient {
class QUOTIENT_API MemberEventContent : public EventContent::Base {
public:
    using MembershipType
        [[deprecated("Use Quotient::Membership instead")]] = Membership;

    QUO_IMPLICIT MemberEventContent(Membership ms) : membership(ms) {}
    explicit MemberEventContent(const QJsonObject& json);

    Membership membership;
    /// (Only for invites) Whether the invite is to a direct chat
    bool isDirect = false;
    Omittable<QString> displayName;
    Omittable<QUrl> avatarUrl;
    QString reason;

protected:
    void fillJson(QJsonObject* o) const override;
};

using MembershipType [[deprecated("Use Membership instead")]] = Membership;

class QUOTIENT_API RoomMemberEvent : public StateEvent<MemberEventContent> {
    Q_GADGET
public:
    DEFINE_EVENT_TYPEID("m.room.member", RoomMemberEvent)

    using MembershipType
        [[deprecated("Use Quotient::Membership instead")]] = Membership;

    explicit RoomMemberEvent(const QJsonObject& obj) : StateEvent(typeId(), obj)
    {}
    RoomMemberEvent(const QString& userId, MemberEventContent&& content)
        : StateEvent(typeId(), matrixTypeId(), userId, std::move(content))
    {}

    //! \brief A special constructor to create unknown RoomMemberEvents
    //!
    //! This is needed in order to use RoomMemberEvent as a "base event class"
    //! in cases like GetMembersByRoomJob when RoomMemberEvents (rather than
    //! RoomEvents or StateEvents) are resolved from JSON. For such cases
    //! loadEvent\<> requires an underlying class to have a specialisation of
    //! EventFactory\<> and be constructible with unknownTypeId() instead of
    //! its genuine id. Don't use directly.
    //! \sa EventFactory, loadEvent, GetMembersByRoomJob
    RoomMemberEvent(Type type, const QJsonObject& fullJson)
        : StateEvent(type, fullJson)
    {}

    Membership membership() const { return content().membership; }
    QString userId() const { return stateKey(); }
    bool isDirect() const { return content().isDirect; }
    Omittable<QString> newDisplayName() const { return content().displayName; }
    Omittable<QUrl> newAvatarUrl() const { return content().avatarUrl; }
    [[deprecated("Use newDisplayName() instead")]] QString displayName() const
    {
        return newDisplayName().value_or(QString());
    }
    [[deprecated("Use newAvatarUrl() instead")]] QUrl avatarUrl() const
    {
        return newAvatarUrl().value_or(QUrl());
    }
    QString reason() const { return content().reason; }
    bool changesMembership() const;
    bool isBan() const;
    bool isUnban() const;
    bool isInvite() const;
    bool isRejectedInvite() const;
    bool isJoin() const;
    bool isLeave() const;
    bool isRename() const;
    bool isAvatarUpdate() const;
};

template <>
inline event_ptr_tt<RoomMemberEvent>
doLoadEvent<RoomMemberEvent>(const QJsonObject& json, const QString& matrixType)
{
    if (matrixType == QLatin1String(RoomMemberEvent::matrixTypeId()))
        return makeEvent<RoomMemberEvent>(json);
    return makeEvent<RoomMemberEvent>(unknownEventTypeId(), json);
}
REGISTER_EVENT_TYPE(RoomMemberEvent)
} // namespace Quotient