aboutsummaryrefslogtreecommitdiff
path: root/lib/csapi/peeking_events.h
diff options
context:
space:
mode:
Diffstat (limited to 'lib/csapi/peeking_events.h')
-rw-r--r--lib/csapi/peeking_events.h73
1 files changed, 38 insertions, 35 deletions
diff --git a/lib/csapi/peeking_events.h b/lib/csapi/peeking_events.h
index 5a6e513c..00552af0 100644
--- a/lib/csapi/peeking_events.h
+++ b/lib/csapi/peeking_events.h
@@ -6,11 +6,10 @@
#include "jobs/basejob.h"
-#include "events/eventloader.h"
#include "converters.h"
+#include "events/eventloader.h"
-namespace QMatrixClient
-{
+namespace QMatrixClient {
// Operations
/// Listen on the event stream.
@@ -18,53 +17,57 @@ namespace QMatrixClient
/// 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.
- ///
+ ///
/// 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
/// API will also be deprecated at some point, but its replacement is not
/// yet known.
class PeekEventsJob : public BaseJob
{
public:
- /*! Listen on the event stream.
- * \param from
- * The token to stream from. This token is either from a previous
- * request to this API or from the initial sync API.
- * \param timeout
- * The maximum time in milliseconds to wait for an event.
- * \param roomId
- * The room ID for which events should be returned.
- */
- explicit PeekEventsJob(const QString& from = {}, Omittable<int> timeout = none, const QString& roomId = {});
+ /*! Listen on the event stream.
+ * \param from
+ * The token to stream from. This token is either from a previous
+ * request to this API or from the initial sync API.
+ * \param timeout
+ * The maximum time in milliseconds to wait for an event.
+ * \param roomId
+ * The room ID for which events should be returned.
+ */
+ explicit PeekEventsJob(const QString& from = {},
+ Omittable<int> timeout = none,
+ const QString& roomId = {});
- /*! Construct a URL without creating a full-fledged job object
- *
- * This function can be used when a URL for
- * PeekEventsJob is necessary but the job
- * itself isn't.
- */
- static QUrl makeRequestUrl(QUrl baseUrl, const QString& from = {}, Omittable<int> timeout = none, const QString& roomId = {});
+ /*! Construct a URL without creating a full-fledged job object
+ *
+ * This function can be used when a URL for
+ * PeekEventsJob is necessary but the job
+ * itself isn't.
+ */
+ static QUrl makeRequestUrl(QUrl baseUrl, const QString& from = {},
+ Omittable<int> timeout = none,
+ const QString& roomId = {});
- ~PeekEventsJob() override;
+ ~PeekEventsJob() override;
- // Result properties
+ // Result properties
- /// A token which correlates to the first value in ``chunk``. This
- /// is usually the same token supplied to ``from=``.
- const QString& begin() const;
- /// A token which correlates to the last value in ``chunk``. This
- /// token should be used in the next request to ``/events``.
- const QString& end() const;
- /// An array of events.
- RoomEvents&& chunk();
+ /// A token which correlates to the first value in ``chunk``. This
+ /// is usually the same token supplied to ``from=``.
+ const QString& begin() const;
+ /// A token which correlates to the last value in ``chunk``. This
+ /// token should be used in the next request to ``/events``.
+ const QString& end() const;
+ /// An array of events.
+ RoomEvents&& chunk();
protected:
- Status parseJson(const QJsonDocument& data) override;
+ Status parseJson(const QJsonDocument& data) override;
private:
- class Private;
- QScopedPointer<Private> d;
+ class Private;
+ QScopedPointer<Private> d;
};
} // namespace QMatrixClient