diff options
author | Kitsune Ral <Kitsune-Ral@users.sf.net> | 2020-04-17 07:42:13 +0200 |
---|---|---|
committer | Kitsune Ral <Kitsune-Ral@users.sf.net> | 2020-04-17 07:49:41 +0200 |
commit | 7036ed0dcb137cb5cbb6b426dd338c5e2e4c6424 (patch) | |
tree | fa9e37d8874303bf56d5381b0844738bd516a79b /lib/csapi/event_context.h | |
parent | 906699cc525e9e0be231a58cabffc31ad1f5193c (diff) | |
download | libquotient-7036ed0dcb137cb5cbb6b426dd338c5e2e4c6424.tar.gz libquotient-7036ed0dcb137cb5cbb6b426dd338c5e2e4c6424.zip |
Regenerate API files using new GTAD and refreshed templates
No functional changes.
Diffstat (limited to 'lib/csapi/event_context.h')
-rw-r--r-- | lib/csapi/event_context.h | 26 |
1 files changed, 14 insertions, 12 deletions
diff --git a/lib/csapi/event_context.h b/lib/csapi/event_context.h index 755fc662..54441617 100644 --- a/lib/csapi/event_context.h +++ b/lib/csapi/event_context.h @@ -9,21 +9,20 @@ #include "events/eventloader.h" #include "jobs/basejob.h" -namespace Quotient -{ +namespace Quotient { // Operations -/// Get events and state around the specified event. -/*! +/*! \brief Get events and state around the specified event. + * * This API returns a number of events that happened just before and * after the specified event. This allows clients to get the context * surrounding an event. */ -class GetEventContextJob : public BaseJob -{ +class GetEventContextJob : public BaseJob { public: - /*! Get events and state around the specified event. + /*! \brief Get events and state around the specified event. + * * \param roomId * The room to get events from. * \param eventId @@ -34,32 +33,35 @@ public: explicit GetEventContextJob(const QString& roomId, const QString& eventId, Omittable<int> limit = none); - /*! Construct a URL without creating a full-fledged job object + /*! \brief Construct a URL without creating a full-fledged job object * - * This function can be used when a URL for - * GetEventContextJob is necessary but the job - * itself isn't. + * This function can be used when a URL for GetEventContextJob + * is necessary but the job itself isn't. */ static QUrl makeRequestUrl(QUrl baseUrl, const QString& roomId, const QString& eventId, Omittable<int> limit = none); - ~GetEventContextJob() override; // Result properties /// A token that can be used to paginate backwards with. const QString& begin() const; + /// A token that can be used to paginate forwards with. const QString& end() const; + /// A list of room events that happened just before the /// requested event, in reverse-chronological order. RoomEvents&& eventsBefore(); + /// Details of the requested event. RoomEventPtr&& event(); + /// A list of room events that happened just after the /// requested event, in chronological order. RoomEvents&& eventsAfter(); + /// The state of the room at the last event returned. StateEvents&& state(); |