aboutsummaryrefslogtreecommitdiff
path: root/lib/csapi/receipts.h
blob: 98bc50042f204f4fc6a878e3b4cf5eaf709fe905 (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
/******************************************************************************
 * THIS FILE IS GENERATED - ANY EDITS WILL BE OVERWRITTEN
 */

#pragma once

#include "jobs/basejob.h"

namespace Quotient {

/*! \brief Send a receipt for the given event ID.
 *
 * This API updates the marker for the given receipt type to the event ID
 * specified.
 */
class QUOTIENT_API PostReceiptJob : public BaseJob {
public:
    /*! \brief Send a receipt for the given event ID.
     *
     * \param roomId
     *   The room in which to send the event.
     *
     * \param receiptType
     *   The type of receipt to send. This can also be `m.fully_read` as an
     *   alternative to
     * [`/read_makers`](/client-server-api/#post_matrixclientv3roomsroomidread_markers).
     *
     *   Note that `m.fully_read` does not appear under `m.receipt`: this
     * endpoint effectively calls `/read_markers` internally when presented with
     * a receipt type of `m.fully_read`.
     *
     * \param eventId
     *   The event ID to acknowledge up to.
     *
     * \param receipt
     *   Extra receipt information to attach to `content` if any. The
     *   server will automatically set the `ts` field.
     */
    explicit PostReceiptJob(const QString& roomId, const QString& receiptType,
                            const QString& eventId,
                            const QJsonObject& receipt = {});
};

} // namespace Quotient