aboutsummaryrefslogtreecommitdiff
path: root/lib/csapi/receipts.h
diff options
context:
space:
mode:
Diffstat (limited to 'lib/csapi/receipts.h')
-rw-r--r--lib/csapi/receipts.h10
1 files changed, 8 insertions, 2 deletions
diff --git a/lib/csapi/receipts.h b/lib/csapi/receipts.h
index 7ac093cd..98bc5004 100644
--- a/lib/csapi/receipts.h
+++ b/lib/csapi/receipts.h
@@ -13,7 +13,7 @@ namespace Quotient {
* This API updates the marker for the given receipt type to the event ID
* specified.
*/
-class PostReceiptJob : public BaseJob {
+class QUOTIENT_API PostReceiptJob : public BaseJob {
public:
/*! \brief Send a receipt for the given event ID.
*
@@ -21,7 +21,13 @@ public:
* The room in which to send the event.
*
* \param receiptType
- * The type of receipt to send.
+ * 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.