aboutsummaryrefslogtreecommitdiff
path: root/lib/events/roommemberevent.h
blob: 39aa280c9ceed0497e94a847e412d780a6c0ed56 (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
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
/******************************************************************************
 * Copyright (C) 2015 Felix Rohrbach <kde@fxrh.de>
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 */

#pragma once

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

namespace QMatrixClient
{
    class MemberEventContent: public EventContent::Base
    {
        public:
            enum MembershipType : size_t { Invite = 0, Join, Knock, Leave, Ban,
                                           Undefined };

            explicit MemberEventContent(MembershipType mt = Join)
                : membership(mt)
            { }
            explicit MemberEventContent(const QJsonObject& json);

            MembershipType membership;
            bool isDirect = false;
            QString displayName;
            QUrl avatarUrl;

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

    using MembershipType = MemberEventContent::MembershipType;

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

            using MembershipType = MemberEventContent::MembershipType;

            explicit RoomMemberEvent(const QJsonObject& obj)
                : StateEvent(typeId(), obj)
            { }
            [[deprecated("Use RoomMemberEvent(userId, contentArgs) instead")]]
            RoomMemberEvent(MemberEventContent&& c)
                : StateEvent(typeId(), matrixTypeId(), QString(), c)
            { }
            template <typename... ArgTs>
            RoomMemberEvent(const QString& userId, ArgTs&&... contentArgs)
                : StateEvent(typeId(), matrixTypeId(), userId,
                             std::forward<ArgTs>(contentArgs)...)
            { }

            /// 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 be
             * constructible with unknownTypeId() instead of its genuine id.
             * Don't use it directly.
             * \sa GetMembersByRoomJob, loadEvent, unknownTypeId
             */
            RoomMemberEvent(Type type, const QJsonObject& fullJson)
                : StateEvent(type, fullJson)
            { }

            MembershipType membership() const  { return content().membership; }
            QString userId() const
                { return fullJson()[StateKeyKeyL].toString(); }
            bool isDirect() const { return content().isDirect; }
            QString displayName() const { return content().displayName; }
            QUrl avatarUrl() const      { return content().avatarUrl; }
            bool isInvite() const;
            bool isJoin() const;
            bool isLeave() const;
            bool isRename() const;
            bool isAvatarUpdate() const;

        private:
            REGISTER_ENUM(MembershipType)
    };

    template <>
    class EventFactory<RoomMemberEvent>
    {
        public:
            static event_ptr_tt<RoomMemberEvent> make(const QJsonObject& json,
                                                      const QString&)
            {
                return makeEvent<RoomMemberEvent>(json);
            }
    };

    REGISTER_EVENT_TYPE(RoomMemberEvent)
    DEFINE_EVENTTYPE_ALIAS(RoomMember, RoomMemberEvent)
}  // namespace QMatrixClient