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.h89
1 files changed, 44 insertions, 45 deletions
diff --git a/lib/csapi/users.h b/lib/csapi/users.h
index 1e355b8f..7754b82a 100644
--- a/lib/csapi/users.h
+++ b/lib/csapi/users.h
@@ -6,11 +6,10 @@
#include "jobs/basejob.h"
-#include <QtCore/QVector>
#include "converters.h"
+#include <QtCore/QVector>
-namespace QMatrixClient
-{
+namespace QMatrixClient {
// Operations
/// Searches the user directory.
@@ -18,61 +17,61 @@ namespace QMatrixClient
/// 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.
- ///
+ /// 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
+ /// 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
+ // Inner data structures
- /// 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.
- QString displayName;
- /// The avatar url, as an MXC, if one exists.
- QString avatarUrl;
- };
+ /// 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.
+ QString displayName;
+ /// The avatar url, as an MXC, if one exists.
+ QString avatarUrl;
+ };
- // Construction/destruction
+ // Construction/destruction
- /*! 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);
- ~SearchUserDirectoryJob() override;
+ /*! 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);
+ ~SearchUserDirectoryJob() override;
- // Result properties
+ // Result properties
- /// 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;
+ /// 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;
protected:
- Status parseJson(const QJsonDocument& data) override;
+ Status parseJson(const QJsonDocument& data) override;
private:
- class Private;
- QScopedPointer<Private> d;
+ class Private;
+ QScopedPointer<Private> d;
};
} // namespace QMatrixClient