/******************************************************************************
 * THIS FILE IS GENERATED - ANY EDITS WILL BE OVERWRITTEN
 */

#pragma once

#include "jobs/basejob.h"

namespace Quotient {

// Operations

/*! \brief 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:
    /*! \brief 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 Quotient