aboutsummaryrefslogtreecommitdiff
path: root/lib/csapi/leaving.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/leaving.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/leaving.h')
-rw-r--r--lib/csapi/leaving.h64
1 files changed, 30 insertions, 34 deletions
diff --git a/lib/csapi/leaving.h b/lib/csapi/leaving.h
index 3a340034..374d27d4 100644
--- a/lib/csapi/leaving.h
+++ b/lib/csapi/leaving.h
@@ -6,70 +6,66 @@
#include "jobs/basejob.h"
-
-namespace QMatrixClient
-{
+namespace QMatrixClient {
// Operations
/// Stop the requesting user participating in a particular room.
///
/// This API stops a user participating in a particular room.
- ///
+ ///
/// If the user was already in the room, they will no longer be able to see
/// new events in the room. If the room requires an invite to join, they
/// will need to be re-invited before they can re-join.
- ///
+ ///
/// If the user was invited to the room, but had not joined, this call
/// serves to reject the invite.
- ///
+ ///
/// The user will still be allowed to retrieve history from the room which
/// they were previously allowed to see.
class LeaveRoomJob : public BaseJob
{
public:
- /*! Stop the requesting user participating in a particular room.
- * \param roomId
- * The room identifier to leave.
- */
- explicit LeaveRoomJob(const QString& roomId);
-
- /*! Construct a URL without creating a full-fledged job object
- *
- * This function can be used when a URL for
- * LeaveRoomJob is necessary but the job
- * itself isn't.
- */
- static QUrl makeRequestUrl(QUrl baseUrl, const QString& roomId);
+ /*! Stop the requesting user participating in a particular room.
+ * \param roomId
+ * The room identifier to leave.
+ */
+ explicit LeaveRoomJob(const QString& roomId);
+ /*! Construct a URL without creating a full-fledged job object
+ *
+ * This function can be used when a URL for
+ * LeaveRoomJob is necessary but the job
+ * itself isn't.
+ */
+ static QUrl makeRequestUrl(QUrl baseUrl, const QString& roomId);
};
/// Stop the requesting user remembering about a particular room.
///
/// This API stops a user remembering about a particular room.
- ///
+ ///
/// In general, history is a first class citizen in Matrix. After this API
/// is called, however, a user will no longer be able to retrieve history
/// for this room. If all users on a homeserver forget a room, the room is
/// eligible for deletion from that homeserver.
- ///
+ ///
/// If the user is currently joined to the room, they must leave the room
/// before calling this API.
class ForgetRoomJob : public BaseJob
{
public:
- /*! Stop the requesting user remembering about a particular room.
- * \param roomId
- * The room identifier to forget.
- */
- explicit ForgetRoomJob(const QString& roomId);
-
- /*! Construct a URL without creating a full-fledged job object
- *
- * This function can be used when a URL for
- * ForgetRoomJob is necessary but the job
- * itself isn't.
- */
- static QUrl makeRequestUrl(QUrl baseUrl, const QString& roomId);
+ /*! Stop the requesting user remembering about a particular room.
+ * \param roomId
+ * The room identifier to forget.
+ */
+ explicit ForgetRoomJob(const QString& roomId);
+ /*! Construct a URL without creating a full-fledged job object
+ *
+ * This function can be used when a URL for
+ * ForgetRoomJob is necessary but the job
+ * itself isn't.
+ */
+ static QUrl makeRequestUrl(QUrl baseUrl, const QString& roomId);
};
} // namespace QMatrixClient