Page MenuHomePhorge
Files F7893347

message_pagination.hpp
No OneTemporary
Actions

Size
4 KB
Referenced Files
None
Subscribers
None

message_pagination.hpp
View Options

/******************************************************************************
* THIS FILE IS GENERATED - ANY EDITS WILL BE OVERWRITTEN
*/
#pragma once
#include "basejob.hpp"
namespace Kazv::Api {
/*! \brief Get a list of events for this room
*
* This API returns a list of message and state events for a room. It uses
* pagination query parameters to paginate history in the room.
*
* *Note*: This endpoint supports lazy-loading of room member events. See
* [Lazy-loading room members](/client-server-api/#lazy-loading-room-members) for more information.
*/
class GetRoomEventsJob : public BaseJob {
public:
class JobResponse : public Response
{
public:
JobResponse(Response r);
bool success() const;
// Result properties
/// A token corresponding to the start of `chunk`. This will be the same as
/// the value given in `from`.
std::string start() const;
/// A token corresponding to the end of `chunk`. This token can be passed
/// back to this endpoint to request further events.
///
/// If no further events are available (either because we have
/// reached the start of the timeline, or because the user does
/// not have permission to see any more events), this property
/// is omitted from the response.
std::optional<std::string> end() const;
/// A list of room events. The order depends on the `dir` parameter.
/// For `dir=b` events will be in reverse-chronological order,
/// for `dir=f` in chronological order. (The exact definition of `chronological`
/// is dependent on the server implementation.)
///
/// Note that an empty `chunk` does not *necessarily* imply that no more events
/// are available. Clients should continue to paginate until no `end` property
/// is returned.
EventList chunk() const;
/// A list of state events relevant to showing the `chunk`. For example, if
/// `lazy_load_members` is enabled in the filter then this may contain
/// the membership events for the senders of events in the `chunk`.
///
/// Unless `include_redundant_members` is `true`, the server
/// may remove membership events which would have already been
/// sent to the client in prior calls to this endpoint, assuming
/// the membership of those members has not changed.
EventList state() const;
};
static constexpr auto needsAuth() {
return true
;
}
// Construction/destruction
/*! \brief Get a list of events for this room
*
* \param roomId
* The room to get events from.
*
* \param dir
* The direction to return events from. If this is set to `f`, events
* will be returned in chronological order starting at `from`. If it
* is set to `b`, events will be returned in *reverse* chronological
* order, again starting at `from`.
*
* \param from
* The token to start returning events from. This token can be obtained
* from a `prev_batch` or `next_batch` token returned by the `/sync` endpoint,
* or from an `end` token returned by a previous request to this endpoint.
*
* This endpoint can also accept a value returned as a `start` token
* by a previous request to this endpoint, though servers are not
* required to support this. Clients should not rely on the behaviour.
*
* If it is not provided, the homeserver shall return a list of messages
* from the first or last (per the value of the `dir` parameter) visible
* event in the room history for the requesting user.
*
* \param to
* The token to stop returning events at. This token can be obtained from
* a `prev_batch` or `next_batch` token returned by the `/sync` endpoint,
* or from an `end` token returned by a previous request to this endpoint.
*
* \param limit
* The maximum number of events to return. Default: 10.
*
* \param filter
* A JSON RoomEventFilter to filter returned events with.
*/
explicit GetRoomEventsJob(std::string serverUrl
, std::string _accessToken
,
std::string roomId , std::string dir , std::optional<std::string> from = std::nullopt, std::optional<std::string> to = std::nullopt, std::optional<int> limit = std::nullopt, std::optional<std::string> filter = std::nullopt
);
static BaseJob::Query buildQuery(
std::optional<std::string> from, std::optional<std::string> to, std::string dir, std::optional<int> limit, std::optional<std::string> filter);
static BaseJob::Body buildBody(std::string roomId, std::string dir, std::optional<std::string> from, std::optional<std::string> to, std::optional<int> limit, std::optional<std::string> filter);
GetRoomEventsJob withData(JsonWrap j) &&;
GetRoomEventsJob withData(JsonWrap j) const &;
};
using GetRoomEventsResponse = GetRoomEventsJob::JobResponse;
}
namespace nlohmann
{
using namespace Kazv;
using namespace Kazv::Api;
}
namespace Kazv::Api
{
} // namespace Kazv::Api

File Metadata

Mime Type
text/x-c++
Expires
Thu, Oct 2, 4:58 AM (12 h, 16 m)
Storage Engine
blob
Storage Format
Raw Data
Storage Handle
473309
Default Alt Text
message_pagination.hpp (4 KB)

Event Timeline