aboutsummaryrefslogtreecommitdiff
path: root/lib/csapi/capabilities.h
diff options
context:
space:
mode:
Diffstat (limited to 'lib/csapi/capabilities.h')
-rw-r--r--lib/csapi/capabilities.h137
1 files changed, 71 insertions, 66 deletions
diff --git a/lib/csapi/capabilities.h b/lib/csapi/capabilities.h
index 06a8bf0d..f6e7ad06 100644
--- a/lib/csapi/capabilities.h
+++ b/lib/csapi/capabilities.h
@@ -4,79 +4,84 @@
#pragma once
+#include "converters.h"
+
#include "jobs/basejob.h"
-#include <QtCore/QJsonObject>
-#include "converters.h"
#include <QtCore/QHash>
+#include <QtCore/QJsonObject>
namespace QMatrixClient
{
- // Operations
- /// Gets information about the server's capabilities.
- ///
- /// Gets information about the server's supported feature set
- /// and other relevant capabilities.
- class GetCapabilitiesJob : public BaseJob
+// Operations
+
+/// Gets information about the server's capabilities.
+/*!
+ * Gets information about the server's supported feature set
+ * and other relevant capabilities.
+ */
+class GetCapabilitiesJob : public BaseJob
+{
+public:
+ // Inner data structures
+
+ /// Capability to indicate if the user can change their password.
+ struct ChangePasswordCapability
+ {
+ /// True if the user can change their password, false otherwise.
+ bool enabled;
+ };
+
+ /// The room versions the server supports.
+ struct RoomVersionsCapability
{
- public:
- // Inner data structures
-
- /// Capability to indicate if the user can change their password.
- struct ChangePasswordCapability
- {
- /// True if the user can change their password, false otherwise.
- bool enabled;
- };
-
- /// The room versions the server supports.
- struct RoomVersionsCapability
- {
- /// The default room version the server is using for new rooms.
- QString defaultVersion;
- /// A detailed description of the room versions the server supports.
- QHash<QString, QString> available;
- };
-
- /// The custom capabilities the server supports, using the
- /// Java package naming convention.
- struct Capabilities
- {
- /// Capability to indicate if the user can change their password.
- Omittable<ChangePasswordCapability> changePassword;
- /// The room versions the server supports.
- Omittable<RoomVersionsCapability> roomVersions;
- /// The custom capabilities the server supports, using the
- /// Java package naming convention.
- QHash<QString, QJsonObject> additionalProperties;
- };
-
- // Construction/destruction
-
- explicit GetCapabilitiesJob();
-
- /*! Construct a URL without creating a full-fledged job object
- *
- * This function can be used when a URL for
- * GetCapabilitiesJob is necessary but the job
- * itself isn't.
- */
- static QUrl makeRequestUrl(QUrl baseUrl);
-
- ~GetCapabilitiesJob() override;
-
- // Result properties
-
- /// The custom capabilities the server supports, using the
- /// Java package naming convention.
- const Capabilities& capabilities() const;
-
- protected:
- Status parseJson(const QJsonDocument& data) override;
-
- private:
- class Private;
- QScopedPointer<Private> d;
+ /// The default room version the server is using for new rooms.
+ QString defaultVersion;
+ /// A detailed description of the room versions the server supports.
+ QHash<QString, QString> available;
};
+
+ /// The custom capabilities the server supports, using theJava package
+ /// naming convention.
+ struct Capabilities
+ {
+ /// Capability to indicate if the user can change their password.
+ Omittable<ChangePasswordCapability> changePassword;
+ /// The room versions the server supports.
+ Omittable<RoomVersionsCapability> roomVersions;
+
+ /// The custom capabilities the server supports, using theJava package
+ /// naming convention.
+ QHash<QString, QJsonObject> additionalProperties;
+ };
+
+ // Construction/destruction
+
+ explicit GetCapabilitiesJob();
+
+ /*! Construct a URL without creating a full-fledged job object
+ *
+ * This function can be used when a URL for
+ * GetCapabilitiesJob is necessary but the job
+ * itself isn't.
+ */
+ static QUrl makeRequestUrl(QUrl baseUrl);
+
+ ~GetCapabilitiesJob() override;
+
+ // Result properties
+
+ /// The custom capabilities the server supports, using the
+ /// Java package naming convention.
+ const Capabilities& capabilities() const;
+
+protected:
+ Status parseJson(const QJsonDocument& data) override;
+
+private:
+ class Private;
+ QScopedPointer<Private> d;
+};
+
} // namespace QMatrixClient