aboutsummaryrefslogtreecommitdiff
path: root/lib/csapi/message_pagination.h
diff options
context:
space:
mode:
authorKitsune Ral <Kitsune-Ral@users.sf.net>2018-09-29 22:22:49 +0900
committerKitsune Ral <Kitsune-Ral@users.sf.net>2018-09-29 22:22:49 +0900
commitb55334ac0fe89f780776bc4eab90ffe1ca3c57bb (patch)
tree1a45c0ccfec8f5f7ba37eb4385cdc7f61afa0c97 /lib/csapi/message_pagination.h
parentf5c2e47fa1ab84fdaffe03c30ba973d7dea5ac05 (diff)
parent1e6510790dab6b9141ae52993987b406399668cd (diff)
downloadlibquotient-b55334ac0fe89f780776bc4eab90ffe1ca3c57bb.tar.gz
libquotient-b55334ac0fe89f780776bc4eab90ffe1ca3c57bb.zip
Merge branch 'cs-api-0.4.0'
Diffstat (limited to 'lib/csapi/message_pagination.h')
-rw-r--r--lib/csapi/message_pagination.h14
1 files changed, 7 insertions, 7 deletions
diff --git a/lib/csapi/message_pagination.h b/lib/csapi/message_pagination.h
index 890f3ac8..12544f0c 100644
--- a/lib/csapi/message_pagination.h
+++ b/lib/csapi/message_pagination.h
@@ -14,30 +14,30 @@ namespace QMatrixClient
// Operations
/// Get a list of events for this room
- ///
+ ///
/// This API returns a list of message and state events for a room. It uses
/// pagination query parameters to paginate history in the room.
class GetRoomEventsJob : public BaseJob
{
public:
/*! Get a list of events for this room
- * \param roomId
+ * \param roomId
* The room to get events from.
- * \param from
+ * \param from
* The token to start returning events from. This token can be obtained
* from a ``prev_batch`` token returned for each room by the sync API,
* or from a ``start`` or ``end`` token returned by a previous request
* to this endpoint.
- * \param dir
+ * \param dir
* The direction to return events from.
- * \param to
+ * \param to
* The token to stop returning events at. This token can be obtained from
* a ``prev_batch`` token returned for each room by the sync endpoint,
* or from a ``start`` or ``end`` token returned by a previous request to
* this endpoint.
- * \param limit
+ * \param limit
* The maximum number of events to return. Default: 10.
- * \param filter
+ * \param filter
* A JSON RoomEventFilter to filter returned events with.
*/
explicit GetRoomEventsJob(const QString& roomId, const QString& from, const QString& dir, const QString& to = {}, Omittable<int> limit = none, const QString& filter = {});