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
|
/******************************************************************************
* THIS FILE IS GENERATED - ANY EDITS WILL BE OVERWRITTEN
*/
#pragma once
#include "jobs/basejob.h"
namespace Quotient {
/*! \brief Searches the user directory.
*
* Performs a search for users. The homeserver may
* determine which subset of users are searched, however the homeserver
* MUST at a minimum consider the users the requesting user shares a
* room with and those who reside in public rooms (known to the homeserver).
* The search MUST consider local users to the homeserver, and SHOULD
* query remote users as part of the search.
*
* The search is performed case-insensitively on user IDs and display
* names preferably using a collation determined based upon the
* `Accept-Language` header provided in the request, if present.
*/
class SearchUserDirectoryJob : public BaseJob {
public:
// Inner data structures
/// Performs a search for users. The homeserver may
/// determine which subset of users are searched, however the homeserver
/// MUST at a minimum consider the users the requesting user shares a
/// room with and those who reside in public rooms (known to the
/// homeserver). The search MUST consider local users to the homeserver, and
/// SHOULD query remote users as part of the search.
///
/// The search is performed case-insensitively on user IDs and display
/// names preferably using a collation determined based upon the
/// `Accept-Language` header provided in the request, if present.
struct User {
/// The user's matrix user ID.
QString userId;
/// The display name of the user, if one exists.
QString displayName;
/// The avatar url, as an MXC, if one exists.
QString avatarUrl;
};
// Construction/destruction
/*! \brief Searches the user directory.
*
* \param searchTerm
* The term to search for
*
* \param limit
* The maximum number of results to return. Defaults to 10.
*/
explicit SearchUserDirectoryJob(const QString& searchTerm,
Omittable<int> limit = none);
// Result properties
/// Ordered by rank and then whether or not profile info is available.
QVector<User> results() const
{
return loadFromJson<QVector<User>>("results"_ls);
}
/// Indicates if the result list has been truncated by the limit.
bool limited() const
{
return loadFromJson<bool>("limited"_ls);
}
};
template <>
struct JsonObjectConverter<SearchUserDirectoryJob::User> {
static void fillFrom(const QJsonObject& jo,
SearchUserDirectoryJob::User& result)
{
fromJson(jo.value("user_id"_ls), result.userId);
fromJson(jo.value("display_name"_ls), result.displayName);
fromJson(jo.value("avatar_url"_ls), result.avatarUrl);
}
};
} // namespace Quotient
|
