blob: 00552af029c5a9823c66ae0e70dfdf0ba9810f4a (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
|
/******************************************************************************
* THIS FILE IS GENERATED - ANY EDITS WILL BE OVERWRITTEN
*/
#pragma once
#include "jobs/basejob.h"
#include "converters.h"
#include "events/eventloader.h"
namespace QMatrixClient {
// Operations
/// Listen on the event stream.
///
/// 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 = {});
/*! 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;
// 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();
protected:
Status parseJson(const QJsonDocument& data) override;
private:
class Private;
QScopedPointer<Private> d;
};
} // namespace QMatrixClient
|
