aboutsummaryrefslogtreecommitdiff
path: root/lib/csapi/redaction.h
blob: ab235b31b5148dfabfe6885112cf6bd3ff5202f9 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
/******************************************************************************
 * THIS FILE IS GENERATED - ANY EDITS WILL BE OVERWRITTEN
 */

#pragma once

#include "jobs/basejob.h"

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:
        Status parseJson(const QJsonDocument& data) override;

        private:
        class Private;
        QScopedPointer<Private> d;
    };
} // namespace QMatrixClient