aboutsummaryrefslogtreecommitdiff
path: root/lib/csapi/banning.h
diff options
context:
space:
mode:
authorMarc Deop <marc@marcdeop.com>2019-03-02 12:26:57 +0100
committerMarc Deop <marc@marcdeop.com>2019-03-02 12:26:57 +0100
commitaacc4bcb4a487871daae6717f77605aaba444341 (patch)
tree4f50b6874821667ccb6b91c017e5d041e3846112 /lib/csapi/banning.h
parentc971b924cd62822ed6fb1a0291c483ae73a3ecda (diff)
downloadlibquotient-aacc4bcb4a487871daae6717f77605aaba444341.tar.gz
libquotient-aacc4bcb4a487871daae6717f77605aaba444341.zip
style: apply .clang-format to all .cpp and .h files
Diffstat (limited to 'lib/csapi/banning.h')
-rw-r--r--lib/csapi/banning.h58
1 files changed, 31 insertions, 27 deletions
diff --git a/lib/csapi/banning.h b/lib/csapi/banning.h
index 237bd2a0..e1886f0e 100644
--- a/lib/csapi/banning.h
+++ b/lib/csapi/banning.h
@@ -6,47 +6,51 @@
#include "jobs/basejob.h"
-
-namespace QMatrixClient
-{
+namespace QMatrixClient {
// 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.
+ /// 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 = {});
+ /*! 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.
+ /// 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.
+ * \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