aboutsummaryrefslogtreecommitdiff
path: root/lib/csapi/admin.h
diff options
context:
space:
mode:
Diffstat (limited to 'lib/csapi/admin.h')
-rw-r--r--lib/csapi/admin.h55
1 files changed, 28 insertions, 27 deletions
diff --git a/lib/csapi/admin.h b/lib/csapi/admin.h
index 472ccf72..75ae1eb0 100644
--- a/lib/csapi/admin.h
+++ b/lib/csapi/admin.h
@@ -11,29 +11,28 @@
#include <QtCore/QHash>
#include <QtCore/QVector>
-namespace Quotient
-{
+namespace Quotient {
// Operations
-/// Gets information about a particular user.
-/*!
+/*! \brief Gets information about a particular user.
+ *
* Gets information about a particular user.
*
* This API may be restricted to only be called by the user being looked
* up, or by a server admin. Server-local administrator privileges are not
* specified in this document.
*/
-class GetWhoIsJob : public BaseJob
-{
+class GetWhoIsJob : public BaseJob {
public:
// Inner data structures
- /// Gets information about a particular user.This API may be restricted to
- /// only be called by the user being lookedup, or by a server admin.
- /// Server-local administrator privileges are notspecified in this document.
- struct ConnectionInfo
- {
+ /// Gets information about a particular user.
+ ///
+ /// This API may be restricted to only be called by the user being looked
+ /// up, or by a server admin. Server-local administrator privileges are not
+ /// specified in this document.
+ struct ConnectionInfo {
/// Most recently seen IP address of the session.
QString ip;
/// Unix timestamp that the session was last active.
@@ -42,20 +41,22 @@ public:
QString userAgent;
};
- /// Gets information about a particular user.This API may be restricted to
- /// only be called by the user being lookedup, or by a server admin.
- /// Server-local administrator privileges are notspecified in this document.
- struct SessionInfo
- {
+ /// Gets information about a particular user.
+ ///
+ /// This API may be restricted to only be called by the user being looked
+ /// up, or by a server admin. Server-local administrator privileges are not
+ /// specified in this document.
+ struct SessionInfo {
/// Information particular connections in the session.
QVector<ConnectionInfo> connections;
};
- /// Gets information about a particular user.This API may be restricted to
- /// only be called by the user being lookedup, or by a server admin.
- /// Server-local administrator privileges are notspecified in this document.
- struct DeviceInfo
- {
+ /// Gets information about a particular user.
+ ///
+ /// This API may be restricted to only be called by the user being looked
+ /// up, or by a server admin. Server-local administrator privileges are not
+ /// specified in this document.
+ struct DeviceInfo {
/// A user's sessions (i.e. what they did with an access token from one
/// login).
QVector<SessionInfo> sessions;
@@ -63,26 +64,26 @@ public:
// Construction/destruction
- /*! Gets information about a particular user.
+ /*! \brief Gets information about a particular user.
+ *
* \param userId
* The user to look up.
*/
explicit GetWhoIsJob(const QString& userId);
- /*! Construct a URL without creating a full-fledged job object
+ /*! \brief Construct a URL without creating a full-fledged job object
*
- * This function can be used when a URL for
- * GetWhoIsJob is necessary but the job
- * itself isn't.
+ * This function can be used when a URL for GetWhoIsJob
+ * is necessary but the job itself isn't.
*/
static QUrl makeRequestUrl(QUrl baseUrl, const QString& userId);
-
~GetWhoIsJob() override;
// Result properties
/// The Matrix user ID of the user.
const QString& userId() const;
+
/// Each key is an identitfier for one of the user's devices.
const QHash<QString, DeviceInfo>& devices() const;