aboutsummaryrefslogtreecommitdiff
path: root/lib/csapi/directory.h
diff options
context:
space:
mode:
authorKitsune Ral <Kitsune-Ral@users.sf.net>2020-04-17 07:42:13 +0200
committerKitsune Ral <Kitsune-Ral@users.sf.net>2020-04-17 07:49:41 +0200
commit7036ed0dcb137cb5cbb6b426dd338c5e2e4c6424 (patch)
treefa9e37d8874303bf56d5381b0844738bd516a79b /lib/csapi/directory.h
parent906699cc525e9e0be231a58cabffc31ad1f5193c (diff)
downloadlibquotient-7036ed0dcb137cb5cbb6b426dd338c5e2e4c6424.tar.gz
libquotient-7036ed0dcb137cb5cbb6b426dd338c5e2e4c6424.zip
Regenerate API files using new GTAD and refreshed templates
No functional changes.
Diffstat (limited to 'lib/csapi/directory.h')
-rw-r--r--lib/csapi/directory.h50
1 files changed, 24 insertions, 26 deletions
diff --git a/lib/csapi/directory.h b/lib/csapi/directory.h
index 7863aa1a..c13ca20a 100644
--- a/lib/csapi/directory.h
+++ b/lib/csapi/directory.h
@@ -6,17 +6,17 @@
#include "jobs/basejob.h"
-namespace Quotient
-{
+namespace Quotient {
// Operations
-/// Create a new mapping from room alias to room ID.
-
-class SetRoomAliasJob : public BaseJob
-{
+/*! \brief 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.
+ /*! \brief Create a new mapping from room alias to room ID.
+ *
* \param roomAlias
* The room alias to set.
* \param roomId
@@ -25,37 +25,36 @@ public:
explicit SetRoomAliasJob(const QString& roomAlias, const QString& roomId);
};
-/// Get the room ID corresponding to this room alias.
-/*!
+/*! \brief 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
-{
+class GetRoomIdByAliasJob : public BaseJob {
public:
- /*! Get the room ID corresponding to this room alias.
+ /*! \brief 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
+ /*! \brief 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.
+ * 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;
@@ -67,28 +66,27 @@ private:
QScopedPointer<Private> d;
};
-/// Remove a mapping of room alias to room ID.
-/*!
+/*! \brief 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
-{
+class DeleteRoomAliasJob : public BaseJob {
public:
- /*! Remove a mapping of room alias to room ID.
+ /*! \brief 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
+ /*! \brief 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.
+ * 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);
};