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

#pragma once

#include "jobs/basejob.h"

#include <QtCore/QJsonObject>

namespace Quotient {

// Operations

/*! \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 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.
     * \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