aboutsummaryrefslogtreecommitdiff
path: root/lib/csapi/admin.h
diff options
context:
space:
mode:
authorBlack Hat <bhat@encom.eu.org>2019-09-26 22:22:36 -0700
committerBlack Hat <bhat@encom.eu.org>2019-09-26 22:22:36 -0700
commit363cf452bcdbaf6ff1cf94a83ca66cbb31122346 (patch)
treec64c8fda885e4e1785130e8ee3e7c47fd18cbf67 /lib/csapi/admin.h
parent412e2cf19449e73aa7da729e9c5de6502687aade (diff)
parent944653463fe4134c82d85e2d01e2bc0fa43fd727 (diff)
downloadlibquotient-363cf452bcdbaf6ff1cf94a83ca66cbb31122346.tar.gz
libquotient-363cf452bcdbaf6ff1cf94a83ca66cbb31122346.zip
Merge branch 'master' of https://github.com/quotient-im/libQuotient into
bhat-libqtolm-update
Diffstat (limited to 'lib/csapi/admin.h')
-rw-r--r--lib/csapi/admin.h169
1 files changed, 84 insertions, 85 deletions
diff --git a/lib/csapi/admin.h b/lib/csapi/admin.h
index d35f3ee3..472ccf72 100644
--- a/lib/csapi/admin.h
+++ b/lib/csapi/admin.h
@@ -4,95 +4,94 @@
#pragma once
+#include "converters.h"
+
#include "jobs/basejob.h"
-#include <QtCore/QVector>
#include <QtCore/QHash>
-#include "converters.h"
+#include <QtCore/QVector>
-namespace QMatrixClient
+namespace Quotient
{
- // Operations
-
- /// 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
+
+// Operations
+
+/// 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
+{
+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
+ {
+ /// Most recently seen IP address of the session.
+ QString ip;
+ /// Unix timestamp that the session was last active.
+ Omittable<qint64> lastSeen;
+ /// User agent string last seen in the session.
+ 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
{
- public:
- // Inner data structures
-
- /// 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.
- Omittable<qint64> lastSeen;
- /// User agent string last seen in the session.
- QString userAgent;
- };
-
- /// 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 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;
- };
-
- // Construction/destruction
-
- /*! 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
- *
- * 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;
-
- protected:
- Status parseJson(const QJsonDocument& data) override;
-
- private:
- class Private;
- QScopedPointer<Private> d;
+ /// Information particular connections in the session.
+ QVector<ConnectionInfo> connections;
};
-} // namespace QMatrixClient
+
+ /// 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
+ {
+ /// A user's sessions (i.e. what they did with an access token from one
+ /// login).
+ QVector<SessionInfo> sessions;
+ };
+
+ // Construction/destruction
+
+ /*! 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
+ *
+ * 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;
+
+protected:
+ Status parseJson(const QJsonDocument& data) override;
+
+private:
+ class Private;
+ QScopedPointer<Private> d;
+};
+
+} // namespace Quotient