peeking_events.h

Go to the documentation of this file.

// THIS FILE IS GENERATED - ANY EDITS WILL BE OVERWRITTEN
 
#pragma once
 
#include <Quotient/events/roomevent.h>
#include <Quotient/jobs/basejob.h>
 
namespace Quotient {
 
//! \brief Listen on the event stream of a particular room.
//!
//! 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 QUOTIENT_API PeekEventsJob : public BaseJob {
public:
    //! \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 = {}, std::optional<int> timeout = std::nullopt,
                           const QString& roomId = {});
 
    //! \brief 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(const HomeserverData& hsData, const QString& from = {},
                               std::optional<int> timeout = std::nullopt,
                               const QString& roomId = {});
 
    // 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"_L1); }
 
    //! 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"_L1); }
 
    //! An array of events.
    RoomEvents chunk() { return takeFromJson<RoomEvents>("chunk"_L1); }
 
    struct Response {
        //! A token which correlates to the first value in `chunk`. This
        //! is usually the same token supplied to `from=`.
        QString begin{};
 
        //! A token which correlates to the last value in `chunk`. This
        //! token should be used in the next request to `/events`.
        QString end{};
 
        //! An array of events.
        RoomEvents chunk{};
    };
};
 
template <std::derived_from<PeekEventsJob> JobT>
constexpr inline auto doCollectResponse<JobT> =
    [](JobT* j) -> PeekEventsJob::Response { return { j->begin(), j->end(), j->chunk() }; };
 
} // namespace Quotient