aboutsummaryrefslogtreecommitdiff
path: root/lib/csapi/directory.h
diff options
context:
space:
mode:
authorKitsune Ral <Kitsune-Ral@users.sf.net>2019-08-03 17:29:52 +0900
committerGitHub <noreply@github.com>2019-08-03 17:29:52 +0900
commit66e116b7b1e848e80577a0229c8995db0a54932e (patch)
tree763340439a0f4034e9c829d76cb1ffe9766b83c5 /lib/csapi/directory.h
parent5b236dfe895c7766002559570aa29c9033009228 (diff)
parentc05ade838f0fce81f2bbe80a3295618a8a26ff52 (diff)
downloadlibquotient-66e116b7b1e848e80577a0229c8995db0a54932e.tar.gz
libquotient-66e116b7b1e848e80577a0229c8995db0a54932e.zip
Merge pull request #295 from marcdeop/140_impose_coding_standard
140 impose coding standard
Diffstat (limited to 'lib/csapi/directory.h')
-rw-r--r--lib/csapi/directory.h165
1 files changed, 85 insertions, 80 deletions
diff --git a/lib/csapi/directory.h b/lib/csapi/directory.h
index 39e86635..f5331db8 100644
--- a/lib/csapi/directory.h
+++ b/lib/csapi/directory.h
@@ -6,86 +6,91 @@
#include "jobs/basejob.h"
-
namespace QMatrixClient
{
- // Operations
-
- /// Create a new mapping from room alias to room ID.
- class SetRoomAliasJob : public BaseJob
- {
- public:
- /*! Create a new mapping from room alias to room ID.
- * \param roomAlias
- * The room alias to set.
- * \param roomId
- * The room ID to set.
- */
- explicit SetRoomAliasJob(const QString& roomAlias, const QString& roomId);
- };
-
- /// Get the room ID corresponding to this room alias.
- ///
- /// Requests that the server resolve a room alias to a room ID.
- ///
- /// The server will use the federation API to resolve the alias if the
- /// domain part of the alias does not correspond to the server's own
- /// domain.
- class GetRoomIdByAliasJob : public BaseJob
- {
- public:
- /*! Get the room ID corresponding to this room alias.
- * \param roomAlias
- * The room alias.
- */
- explicit GetRoomIdByAliasJob(const QString& roomAlias);
-
- /*! Construct a URL without creating a full-fledged job object
- *
- * This function can be used when a URL for
- * GetRoomIdByAliasJob is necessary but the job
- * itself isn't.
- */
- static QUrl makeRequestUrl(QUrl baseUrl, const QString& roomAlias);
-
- ~GetRoomIdByAliasJob() override;
-
- // Result properties
-
- /// The room ID for this room alias.
- const QString& roomId() const;
- /// A list of servers that are aware of this room alias.
- const QStringList& servers() const;
-
- protected:
- Status parseJson(const QJsonDocument& data) override;
-
- private:
- class Private;
- QScopedPointer<Private> d;
- };
-
- /// Remove a mapping of room alias to room ID.
- ///
- /// Remove a mapping of room alias to room ID.
- ///
- /// Servers may choose to implement additional access control checks here, for instance that room aliases can only be deleted by their creator or a server administrator.
- class DeleteRoomAliasJob : public BaseJob
- {
- public:
- /*! Remove a mapping of room alias to room ID.
- * \param roomAlias
- * The room alias to remove.
- */
- explicit DeleteRoomAliasJob(const QString& roomAlias);
-
- /*! Construct a URL without creating a full-fledged job object
- *
- * This function can be used when a URL for
- * DeleteRoomAliasJob is necessary but the job
- * itself isn't.
- */
- static QUrl makeRequestUrl(QUrl baseUrl, const QString& roomAlias);
-
- };
+
+// Operations
+
+/// Create a new mapping from room alias to room ID.
+
+class SetRoomAliasJob : public BaseJob
+{
+public:
+ /*! Create a new mapping from room alias to room ID.
+ * \param roomAlias
+ * The room alias to set.
+ * \param roomId
+ * The room ID to set.
+ */
+ explicit SetRoomAliasJob(const QString& roomAlias, const QString& roomId);
+};
+
+/// Get the room ID corresponding to this room alias.
+/*!
+ * Requests that the server resolve a room alias to a room ID.
+ *
+ * The server will use the federation API to resolve the alias if the
+ * domain part of the alias does not correspond to the server's own
+ * domain.
+ */
+class GetRoomIdByAliasJob : public BaseJob
+{
+public:
+ /*! Get the room ID corresponding to this room alias.
+ * \param roomAlias
+ * The room alias.
+ */
+ explicit GetRoomIdByAliasJob(const QString& roomAlias);
+
+ /*! Construct a URL without creating a full-fledged job object
+ *
+ * This function can be used when a URL for
+ * GetRoomIdByAliasJob is necessary but the job
+ * itself isn't.
+ */
+ static QUrl makeRequestUrl(QUrl baseUrl, const QString& roomAlias);
+
+ ~GetRoomIdByAliasJob() override;
+
+ // Result properties
+
+ /// The room ID for this room alias.
+ const QString& roomId() const;
+ /// A list of servers that are aware of this room alias.
+ const QStringList& servers() const;
+
+protected:
+ Status parseJson(const QJsonDocument& data) override;
+
+private:
+ class Private;
+ QScopedPointer<Private> d;
+};
+
+/// Remove a mapping of room alias to room ID.
+/*!
+ * Remove a mapping of room alias to room ID.
+ *
+ * Servers may choose to implement additional access control checks here, for
+ * instance that room aliases can only be deleted by their creator or a server
+ * administrator.
+ */
+class DeleteRoomAliasJob : public BaseJob
+{
+public:
+ /*! Remove a mapping of room alias to room ID.
+ * \param roomAlias
+ * The room alias to remove.
+ */
+ explicit DeleteRoomAliasJob(const QString& roomAlias);
+
+ /*! Construct a URL without creating a full-fledged job object
+ *
+ * This function can be used when a URL for
+ * DeleteRoomAliasJob is necessary but the job
+ * itself isn't.
+ */
+ static QUrl makeRequestUrl(QUrl baseUrl, const QString& roomAlias);
+};
+
} // namespace QMatrixClient