aboutsummaryrefslogtreecommitdiff
path: root/lib/csapi/users.h
diff options
context:
space:
mode:
Diffstat (limited to 'lib/csapi/users.h')
-rw-r--r--lib/csapi/users.h36
1 files changed, 18 insertions, 18 deletions
diff --git a/lib/csapi/users.h b/lib/csapi/users.h
index d9a16a9d..de4eb529 100644
--- a/lib/csapi/users.h
+++ b/lib/csapi/users.h
@@ -10,13 +10,12 @@
#include <QtCore/QVector>
-namespace Quotient
-{
+namespace Quotient {
// Operations
-/// Searches the user directory.
-/*!
+/*! \brief Searches the user directory.
+ *
* Performs a search for users on the homeserver. 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
@@ -28,22 +27,21 @@ namespace Quotient
* names preferably using a collation determined based upon the
* ``Accept-Language`` header provided in the request, if present.
*/
-class SearchUserDirectoryJob : public BaseJob
-{
+class SearchUserDirectoryJob : public BaseJob {
public:
// Inner data structures
- /// Performs a search for users on the homeserver. The homeserver
- /// maydetermine which subset of users are searched, however the
- /// homeserverMUST at a minimum consider the users the requesting user
- /// shares aroom with and those who reside in public rooms (known to the
- /// homeserver).The search MUST consider local users to the homeserver, and
- /// SHOULDquery remote users as part of the search.The search is performed
- /// case-insensitively on user IDs and displaynames preferably using a
- /// collation determined based upon the ``Accept-Language`` header provided
- /// in the request, if present.
- struct User
- {
+ /// Performs a search for users on the homeserver. 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.
@@ -54,7 +52,8 @@ public:
// Construction/destruction
- /*! Searches the user directory.
+ /*! \brief Searches the user directory.
+ *
* \param searchTerm
* The term to search for
* \param limit
@@ -69,6 +68,7 @@ public:
/// Ordered by rank and then whether or not profile info is available.
const QVector<User>& results() const;
+
/// Indicates if the result list has been truncated by the limit.
bool limited() const;