diff options
Diffstat (limited to 'lib/csapi/redaction.h')
| -rw-r--r-- | lib/csapi/redaction.h | 22 |
1 files changed, 22 insertions, 0 deletions
diff --git a/lib/csapi/redaction.h b/lib/csapi/redaction.h index e74c9ce4..1e01f41b 100644 --- a/lib/csapi/redaction.h +++ b/lib/csapi/redaction.h @@ -11,14 +11,36 @@ 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; protected: |