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
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
|
/******************************************************************************
* THIS FILE IS GENERATED - ANY EDITS WILL BE OVERWRITTEN
*/
#pragma once
#include "converters.h"
#include "events/eventloader.h"
#include "events/roommemberevent.h"
#include "jobs/basejob.h"
#include <QtCore/QHash>
namespace Quotient {
// Operations
/*! \brief Get a single event by event ID.
*
* Get a single event based on ``roomId/eventId``. You must have permission to
* retrieve this event e.g. by being a member in the room for this event.
*/
class GetOneRoomEventJob : public BaseJob {
public:
/*! \brief Get a single event by event ID.
*
* \param roomId
* The ID of the room the event is in.
* \param eventId
* The event ID to get.
*/
explicit GetOneRoomEventJob(const QString& roomId, const QString& eventId);
/*! \brief Construct a URL without creating a full-fledged job object
*
* This function can be used when a URL for GetOneRoomEventJob
* is necessary but the job itself isn't.
*/
static QUrl makeRequestUrl(QUrl baseUrl, const QString& roomId,
const QString& eventId);
~GetOneRoomEventJob() override;
// Result properties
/// The full event.
EventPtr&& data();
protected:
Status parseJson(const QJsonDocument& data) override;
private:
class Private;
QScopedPointer<Private> d;
};
/*! \brief Get the state identified by the type and key.
*
* Looks up the contents of a state event in a room. If the user is
* joined to the room then the state is taken from the current
* state of the room. If the user has left the room then the state is
* taken from the state of the room when they left.
*/
class GetRoomStateWithKeyJob : public BaseJob {
public:
/*! \brief Get the state identified by the type and key.
*
* \param roomId
* The room to look up the state in.
* \param eventType
* The type of state to look up.
* \param stateKey
* The key of the state to look up.
*/
explicit GetRoomStateWithKeyJob(const QString& roomId,
const QString& eventType,
const QString& stateKey);
/*! \brief Construct a URL without creating a full-fledged job object
*
* This function can be used when a URL for GetRoomStateWithKeyJob
* is necessary but the job itself isn't.
*/
static QUrl makeRequestUrl(QUrl baseUrl, const QString& roomId,
const QString& eventType,
const QString& stateKey);
};
/*! \brief Get the state identified by the type, with the empty state key.
*
* Looks up the contents of a state event in a room. If the user is
* joined to the room then the state is taken from the current
* state of the room. If the user has left the room then the state is
* taken from the state of the room when they left.
*
* This looks up the state event with the empty state key.
*/
class GetRoomStateByTypeJob : public BaseJob {
public:
/*! \brief Get the state identified by the type, with the empty state key.
*
* \param roomId
* The room to look up the state in.
* \param eventType
* The type of state to look up.
*/
explicit GetRoomStateByTypeJob(const QString& roomId,
const QString& eventType);
/*! \brief Construct a URL without creating a full-fledged job object
*
* This function can be used when a URL for GetRoomStateByTypeJob
* is necessary but the job itself isn't.
*/
static QUrl makeRequestUrl(QUrl baseUrl, const QString& roomId,
const QString& eventType);
};
/*! \brief Get all state events in the current state of a room.
*
* Get the state events for the current state of a room.
*/
class GetRoomStateJob : public BaseJob {
public:
/*! \brief Get all state events in the current state of a room.
*
* \param roomId
* The room to look up the state for.
*/
explicit GetRoomStateJob(const QString& roomId);
/*! \brief Construct a URL without creating a full-fledged job object
*
* This function can be used when a URL for GetRoomStateJob
* is necessary but the job itself isn't.
*/
static QUrl makeRequestUrl(QUrl baseUrl, const QString& roomId);
~GetRoomStateJob() override;
// Result properties
/// If the user is a member of the room this will be the
/// current state of the room as a list of events. If the user
/// has left the room then this will be the state of the room
/// when they left as a list of events.
StateEvents&& data();
protected:
Status parseJson(const QJsonDocument& data) override;
private:
class Private;
QScopedPointer<Private> d;
};
/*! \brief Get the m.room.member events for the room.
*
* Get the list of members for this room.
*/
class GetMembersByRoomJob : public BaseJob {
public:
/*! \brief Get the m.room.member events for the room.
*
* \param roomId
* The room to get the member events for.
* \param at
* The token defining the timeline position as-of which to return
* the list of members. This token can be obtained from a batch token
* returned for each room by the sync API, or from
* a ``start``/``end`` token returned by a ``/messages`` request.
* \param membership
* Only return users with the specified membership
* \param notMembership
* Only return users with membership state other than specified
*/
explicit GetMembersByRoomJob(const QString& roomId, const QString& at = {},
const QString& membership = {},
const QString& notMembership = {});
/*! \brief Construct a URL without creating a full-fledged job object
*
* This function can be used when a URL for GetMembersByRoomJob
* is necessary but the job itself isn't.
*/
static QUrl makeRequestUrl(QUrl baseUrl, const QString& roomId,
const QString& at = {},
const QString& membership = {},
const QString& notMembership = {});
~GetMembersByRoomJob() override;
// Result properties
/// Get the list of members for this room.
EventsArray<RoomMemberEvent>&& chunk();
protected:
Status parseJson(const QJsonDocument& data) override;
private:
class Private;
QScopedPointer<Private> d;
};
/*! \brief Gets the list of currently joined users and their profile data.
*
* This API returns a map of MXIDs to member info objects for members of the
* room. The current user must be in the room for it to work, unless it is an
* Application Service in which case any of the AS's users must be in the room.
* This API is primarily for Application Services and should be faster to
* respond than ``/members`` as it can be implemented more efficiently on the
* server.
*/
class GetJoinedMembersByRoomJob : public BaseJob {
public:
// Inner data structures
/// This API returns a map of MXIDs to member info objects for members of
/// the room. The current user must be in the room for it to work, unless it
/// is an Application Service in which case any of the AS's users must be in
/// the room. This API is primarily for Application Services and should be
/// faster to respond than ``/members`` as it can be implemented more
/// efficiently on the server.
struct RoomMember {
/// The display name of the user this object is representing.
QString displayName;
/// The mxc avatar url of the user this object is representing.
QString avatarUrl;
};
// Construction/destruction
/*! \brief Gets the list of currently joined users and their profile data.
*
* \param roomId
* The room to get the members of.
*/
explicit GetJoinedMembersByRoomJob(const QString& roomId);
/*! \brief Construct a URL without creating a full-fledged job object
*
* This function can be used when a URL for GetJoinedMembersByRoomJob
* is necessary but the job itself isn't.
*/
static QUrl makeRequestUrl(QUrl baseUrl, const QString& roomId);
~GetJoinedMembersByRoomJob() override;
// Result properties
/// A map from user ID to a RoomMember object.
const QHash<QString, RoomMember>& joined() const;
protected:
Status parseJson(const QJsonDocument& data) override;
private:
class Private;
QScopedPointer<Private> d;
};
} // namespace Quotient
|
