aboutsummaryrefslogtreecommitdiff
path: root/lib/csapi/banning.h
diff options
context:
space:
mode:
authorKitsune Ral <Kitsune-Ral@users.sf.net>2019-06-24 07:21:13 +0900
committerKitsune Ral <Kitsune-Ral@users.sf.net>2019-06-24 07:21:13 +0900
commit63ae79c3e2820efc2ba60d33e2caf2d7b9b3c408 (patch)
tree2552f5049a6ef7ba0034483b25ca4ab33d1fcb13 /lib/csapi/banning.h
parente083d327e6f6581210f8d077d8bbe1151e81e82c (diff)
parent93f0c8fe89f448d1d58caa757573f17102369471 (diff)
downloadlibquotient-63ae79c3e2820efc2ba60d33e2caf2d7b9b3c408.tar.gz
libquotient-63ae79c3e2820efc2ba60d33e2caf2d7b9b3c408.zip
Merge branch 'master' into clang-format
# Conflicts: # CMakeLists.txt # lib/avatar.cpp # lib/connection.cpp # lib/connection.h # lib/connectiondata.cpp # lib/csapi/account-data.cpp # lib/csapi/account-data.h # lib/csapi/capabilities.cpp # lib/csapi/capabilities.h # lib/csapi/content-repo.cpp # lib/csapi/create_room.cpp # lib/csapi/filter.cpp # lib/csapi/joining.cpp # lib/csapi/keys.cpp # lib/csapi/list_joined_rooms.cpp # lib/csapi/notifications.cpp # lib/csapi/openid.cpp # lib/csapi/presence.cpp # lib/csapi/pushrules.cpp # lib/csapi/registration.cpp # lib/csapi/room_upgrades.cpp # lib/csapi/room_upgrades.h # lib/csapi/search.cpp # lib/csapi/users.cpp # lib/csapi/versions.cpp # lib/csapi/whoami.cpp # lib/csapi/{{base}}.cpp.mustache # lib/events/accountdataevents.h # lib/events/eventcontent.h # lib/events/roommemberevent.cpp # lib/events/stateevent.cpp # lib/jobs/basejob.cpp # lib/jobs/basejob.h # lib/networkaccessmanager.cpp # lib/networksettings.cpp # lib/room.cpp # lib/room.h # lib/settings.cpp # lib/settings.h # lib/syncdata.cpp # lib/user.cpp # lib/user.h # lib/util.cpp
Diffstat (limited to 'lib/csapi/banning.h')
-rw-r--r--lib/csapi/banning.h95
1 files changed, 50 insertions, 45 deletions
diff --git a/lib/csapi/banning.h b/lib/csapi/banning.h
index e1886f0e..0aa5785b 100644
--- a/lib/csapi/banning.h
+++ b/lib/csapi/banning.h
@@ -6,51 +6,56 @@
#include "jobs/basejob.h"
-namespace QMatrixClient {
- // Operations
+namespace QMatrixClient
+{
- /// Ban a user in the room.
- ///
- /// Ban a user in the room. If the user is currently in the room, also kick
- /// them.
- ///
- /// When a user is banned from a room, they may not join it or be invited to
- /// it until they are unbanned.
- ///
- /// The caller must have the required power level in order to perform this
- /// operation.
- class BanJob : public BaseJob
- {
- public:
- /*! Ban a user in the room.
- * \param roomId
- * The room identifier (not alias) from which the user should be
- * banned. \param userId The fully qualified user ID of the user being
- * banned. \param reason The reason the user has been banned. This will
- * be supplied as the ``reason`` on the target's updated
- * `m.room.member`_ event.
- */
- explicit BanJob(const QString& roomId, const QString& userId,
- const QString& reason = {});
- };
+// Operations
+
+/// Ban a user in the room.
+/*!
+ * Ban a user in the room. If the user is currently in the room, also kick them.
+ *
+ * When a user is banned from a room, they may not join it or be invited to it
+ * until they are unbanned.
+ *
+ * The caller must have the required power level in order to perform this
+ * operation.
+ */
+class BanJob : public BaseJob
+{
+public:
+ /*! Ban a user in the room.
+ * \param roomId
+ * The room identifier (not alias) from which the user should be banned.
+ * \param userId
+ * The fully qualified user ID of the user being banned.
+ * \param reason
+ * The reason the user has been banned. This will be supplied as the
+ * ``reason`` on the target's updated `m.room.member`_ event.
+ */
+ explicit BanJob(const QString& roomId, const QString& userId,
+ const QString& reason = {});
+};
+
+/// Unban a user from the room.
+/*!
+ * Unban a user from the room. This allows them to be invited to the room,
+ * and join if they would otherwise be allowed to join according to its join
+ * rules.
+ *
+ * The caller must have the required power level in order to perform this
+ * operation.
+ */
+class UnbanJob : public BaseJob
+{
+public:
+ /*! Unban a user from the room.
+ * \param roomId
+ * The room identifier (not alias) from which the user should be unbanned.
+ * \param userId
+ * The fully qualified user ID of the user being unbanned.
+ */
+ explicit UnbanJob(const QString& roomId, const QString& userId);
+};
- /// Unban a user from the room.
- ///
- /// Unban a user from the room. This allows them to be invited to the room,
- /// and join if they would otherwise be allowed to join according to its
- /// join rules.
- ///
- /// The caller must have the required power level in order to perform this
- /// operation.
- class UnbanJob : public BaseJob
- {
- public:
- /*! Unban a user from the room.
- * \param roomId
- * The room identifier (not alias) from which the user should be
- * unbanned. \param userId The fully qualified user ID of the user being
- * unbanned.
- */
- explicit UnbanJob(const QString& roomId, const QString& userId);
- };
} // namespace QMatrixClient