/******************************************************************************
* THIS FILE IS GENERATED - ANY EDITS WILL BE OVERWRITTEN
*/
#pragma once
#include "jobs/basejob.h"
namespace QMatrixClient
{
// Operations
/// Invite a user to participate in a particular room.
///
/// .. _invite-by-user-id-endpoint:
///
/// *Note that there are two forms of this API, which are documented separately.
/// This version of the API requires that the inviter knows the Matrix
/// identifier of the invitee. The other is documented in the*
/// `third party invites section`_.
///
/// This API invites a user to participate in a particular room.
/// They do not start participating in the room until they actually join the
/// room.
///
/// Only users currently in a particular room can invite other users to
/// join that room.
///
/// If the user was invited to the room, the homeserver will append a
/// ``m.room.member`` event to the room.
///
/// .. _third party invites section: `invite-by-third-party-id-endpoint`_
class InviteUserJob : public BaseJob
{
public:
/*! Invite a user to participate in a particular room.
* \param roomId
* The room identifier (not alias) to which to invite the user.
* \param userId
* The fully qualified user ID of the invitee.
*/
explicit InviteUserJob(const QString& roomId, const QString& userId);
};
} // namespace QMatrixClient
event.h?id=b2f9b212c78bc9dd7c69f6a2d1f94376adb488e3'>treecommitdiff
blob: f3047159b3804a759fccb0146362a00d7cc089d7 (
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
|
// 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 MemberEventContent : public EventContent::Base {
public:
using MembershipType
[[deprecated("Use Quotient::Membership instead")]] = Membership;
explicit MemberEventContent(Membership ms = Membership::Join)
: 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 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)
{}
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)
{}
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 <>
class EventFactory<RoomMemberEvent> {
public:
static event_ptr_tt<RoomMemberEvent> make(const QJsonObject& json,
const QString&)
{
return makeEvent<RoomMemberEvent>(json);
}
};
REGISTER_EVENT_TYPE(RoomMemberEvent)
} // namespace Quotient
|