aboutsummaryrefslogtreecommitdiff
path: root/lib/csapi/redaction.h
diff options
context:
space:
mode:
Diffstat (limited to 'lib/csapi/redaction.h')
-rw-r--r--lib/csapi/redaction.h51
1 files changed, 25 insertions, 26 deletions
diff --git a/lib/csapi/redaction.h b/lib/csapi/redaction.h
index d02abfd0..ab235b31 100644
--- a/lib/csapi/redaction.h
+++ b/lib/csapi/redaction.h
@@ -6,48 +6,47 @@
#include "jobs/basejob.h"
-
-namespace QMatrixClient
-{
+namespace QMatrixClient {
// Operations
/// Strips all non-integrity-critical information out of an event.
///
/// Strips all information out of an event which isn't critical to the
/// integrity of the server-side representation of the room.
- ///
+ ///
/// This cannot be undone.
- ///
+ ///
/// Users may redact their own events, and any user with a power level
/// greater than or equal to the `redact` power level of the room may
/// redact events there.
class RedactEventJob : public BaseJob
{
public:
- /*! Strips all non-integrity-critical information out of an event.
- * \param roomId
- * The room from which to redact the event.
- * \param eventId
- * The ID of the event to redact
- * \param txnId
- * The transaction ID for this event. Clients should generate a
- * unique ID; it will be used by the server to ensure idempotency of requests.
- * \param reason
- * The reason for the event being redacted.
- */
- explicit RedactEventJob(const QString& roomId, const QString& eventId, const QString& txnId, const QString& reason = {});
- ~RedactEventJob() override;
-
- // Result properties
-
- /// A unique identifier for the event.
- const QString& eventId() const;
+ /*! Strips all non-integrity-critical information out of an event.
+ * \param roomId
+ * The room from which to redact the event.
+ * \param eventId
+ * The ID of the event to redact
+ * \param txnId
+ * The transaction ID for this event. Clients should generate a
+ * unique ID; it will be used by the server to ensure idempotency of
+ * requests. \param reason The reason for the event being redacted.
+ */
+ explicit RedactEventJob(const QString& roomId, const QString& eventId,
+ const QString& txnId,
+ const QString& reason = {});
+ ~RedactEventJob() override;
+
+ // Result properties
+
+ /// A unique identifier for the event.
+ const QString& eventId() const;
protected:
- Status parseJson(const QJsonDocument& data) override;
+ Status parseJson(const QJsonDocument& data) override;
private:
- class Private;
- QScopedPointer<Private> d;
+ class Private;
+ QScopedPointer<Private> d;
};
} // namespace QMatrixClient