aboutsummaryrefslogtreecommitdiff
path: root/lib/csapi/wellknown.h
diff options
context:
space:
mode:
Diffstat (limited to 'lib/csapi/wellknown.h')
-rw-r--r--lib/csapi/wellknown.h56
1 files changed, 56 insertions, 0 deletions
diff --git a/lib/csapi/wellknown.h b/lib/csapi/wellknown.h
new file mode 100644
index 00000000..df4c8c6e
--- /dev/null
+++ b/lib/csapi/wellknown.h
@@ -0,0 +1,56 @@
+/******************************************************************************
+ * THIS FILE IS GENERATED - ANY EDITS WILL BE OVERWRITTEN
+ */
+
+#pragma once
+
+#include "jobs/basejob.h"
+
+#include "converters.h"
+#include "csapi/definitions/wellknown/identity_server.h"
+#include "csapi/definitions/wellknown/homeserver.h"
+
+namespace QMatrixClient
+{
+ // Operations
+
+ /// Gets Matrix server discovery information about the domain.
+ ///
+ /// Gets discovery information about the domain. The file may include
+ /// additional keys, which MUST follow the Java package naming convention,
+ /// e.g. ``com.example.myapp.property``. This ensures property names are
+ /// suitably namespaced for each application and reduces the risk of
+ /// clashes.
+ ///
+ /// Note that this endpoint is not necessarily handled by the homeserver,
+ /// but by another webserver, to be used for discovering the homeserver URL.
+ class GetWellknownJob : public BaseJob
+ {
+ public:
+ explicit GetWellknownJob();
+
+ /*! Construct a URL without creating a full-fledged job object
+ *
+ * This function can be used when a URL for
+ * GetWellknownJob is necessary but the job
+ * itself isn't.
+ */
+ static QUrl makeRequestUrl(QUrl baseUrl);
+
+ ~GetWellknownJob() override;
+
+ // Result properties
+
+ /// Information about the homeserver to connect to.
+ const HomeserverInformation& homeserver() const;
+ /// Optional. Information about the identity server to connect to.
+ const Omittable<IdentityServerInformation>& identityServer() const;
+
+ protected:
+ Status parseJson(const QJsonDocument& data) override;
+
+ private:
+ class Private;
+ QScopedPointer<Private> d;
+ };
+} // namespace QMatrixClient