diff options
Diffstat (limited to 'lib/csapi/peeking_events.h')
| -rw-r--r-- | lib/csapi/peeking_events.h | 29 |
1 files changed, 19 insertions, 10 deletions
diff --git a/lib/csapi/peeking_events.h b/lib/csapi/peeking_events.h index cecd9f2d..1eee880f 100644 --- a/lib/csapi/peeking_events.h +++ b/lib/csapi/peeking_events.h @@ -13,12 +13,12 @@ namespace Quotient { * * This will listen for new events related to a particular room and return * them to the caller. This will block until an event is received, or until - * the ``timeout`` is reached. + * the `timeout` is reached. * - * This API is the same as the normal ``/events`` endpoint, but can be + * This API is the same as the normal `/events` endpoint, but can be * called by users who have not joined the room. * - * Note that the normal ``/events`` endpoint has been deprecated. This + * Note that the normal `/events` endpoint has been deprecated. This * API will also be deprecated at some point, but its replacement is not * yet known. */ @@ -51,16 +51,25 @@ public: // Result properties - /// A token which correlates to the first value in ``chunk``. This - /// is usually the same token supplied to ``from=``. - QString begin() const { return loadFromJson<QString>("start"_ls); } + /// A token which correlates to the first value in `chunk`. This + /// is usually the same token supplied to `from=`. + QString begin() const + { + return loadFromJson<QString>("start"_ls); + } - /// A token which correlates to the last value in ``chunk``. This - /// token should be used in the next request to ``/events``. - QString end() const { return loadFromJson<QString>("end"_ls); } + /// A token which correlates to the last value in `chunk`. This + /// token should be used in the next request to `/events`. + QString end() const + { + return loadFromJson<QString>("end"_ls); + } /// An array of events. - RoomEvents chunk() { return takeFromJson<RoomEvents>("chunk"_ls); } + RoomEvents chunk() + { + return takeFromJson<RoomEvents>("chunk"_ls); + } }; } // namespace Quotient |