diff options
Diffstat (limited to 'lib/csapi/receipts.h')
| -rw-r--r-- | lib/csapi/receipts.h | 53 |
1 files changed, 28 insertions, 25 deletions
diff --git a/lib/csapi/receipts.h b/lib/csapi/receipts.h index 4e40188a..bb037c08 100644 --- a/lib/csapi/receipts.h +++ b/lib/csapi/receipts.h @@ -8,30 +8,33 @@ #include <QtCore/QJsonObject> -namespace QMatrixClient { - // Operations +namespace QMatrixClient +{ + +// Operations + +/// 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: + /*! 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 = {}); +}; - /// 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: - /*! 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 QMatrixClient |