1/******************************************************************************
2 * THIS FILE IS GENERATED - ANY EDITS WILL BE OVERWRITTEN
3 */
4
5#pragma once
6
7#include <Quotient/jobs/basejob.h>
8
9namespace Quotient {
10
11/*! \brief Send a receipt for the given event ID.
12 *
13 * This API updates the marker for the given receipt type to the event ID
14 * specified.
15 */
16class QUOTIENT_API PostReceiptJob : public BaseJob {
17public:
18 /*! \brief Send a receipt for the given event ID.
19 *
20 * \param roomId
21 * The room in which to send the event.
22 *
23 * \param receiptType
24 * The type of receipt to send. This can also be `m.fully_read` as an
25 * alternative to
26 * [`/read_markers`](/client-server-api/#post_matrixclientv3roomsroomidread_markers).
27 *
28 * Note that `m.fully_read` does not appear under `m.receipt`: this
29 * endpoint effectively calls `/read_markers` internally when presented with
30 * a receipt type of `m.fully_read`.
31 *
32 * \param eventId
33 * The event ID to acknowledge up to.
34 *
35 * \param threadId
36 * The root thread event's ID (or `main`) for which
37 * thread this receipt is intended to be under. If
38 * not specified, the read receipt is *unthreaded*
39 * (default).
40 */
41 explicit PostReceiptJob(const QString& roomId, const QString& receiptType,
42 const QString& eventId,
43 const QString& threadId = {});
44};
45
46} // namespace Quotient
47