Page MenuHomePhorge
Files F2698339

event_context.hpp
No OneTemporary
Actions

Size
2 KB
Referenced Files
None
Subscribers
None

event_context.hpp
View Options

/******************************************************************************
* THIS FILE IS GENERATED - ANY EDITS WILL BE OVERWRITTEN
*/
#pragma once
#include "basejob.hpp"
namespace Kazv {
/*! \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.
*
* *Note*: This endpoint supports lazy-loading of room member events. See
* `Lazy-loading room members <#lazy-loading-room-members>`_ for more information.
*/
class GetEventContextJob : public BaseJob {
public:
// Construction/destruction
/*! \brief Get events and state around the specified event.
*
* \param roomId
* The room to get events from.
*
* \param eventId
* The event to get context around.
*
* \param limit
* The maximum number of events to return. Default: 10.
*
* \param filter
* A JSON ``RoomEventFilter`` to filter the returned events with. The
* filter is only applied to ``events_before``, ``events_after``, and
* ``state``. It is not applied to the ``event`` itself. The filter may
* be applied before or/and after the ``limit`` parameter - whichever the
* homeserver prefers.
*
* See `Filtering <#filtering>`_ for more information.
*/
explicit GetEventContextJob(std::string serverUrl
, std::string _accessToken
,
std::string roomId , std::string eventId , std::optional<int> limit = std::nullopt, std::string filter = {});
// Result properties
/// A token that can be used to paginate backwards with.
static std::string start(Response r);
/// A token that can be used to paginate forwards with.
static std::string end(Response r);
/// A list of room events that happened just before the
/// requested event, in reverse-chronological order.
static EventList eventsBefore(Response r);
/// Details of the requested event.
static JsonWrap event(Response r);
/// A list of room events that happened just after the
/// requested event, in chronological order.
static EventList eventsAfter(Response r);
/// The state of the room at the last event returned.
static EventList state(Response r);
static BaseJob::Query buildQuery(
std::optional<int> limit, std::string filter);
static BaseJob::Body buildBody(std::string roomId, std::string eventId, std::optional<int> limit, std::string filter);
static bool success(Response r);
};
}
namespace nlohmann
{
using namespace Kazv;
}
namespace Kazv
{
} // namespace Kazv

File Metadata

Mime Type
text/x-c++
Expires
Fri, Jul 18, 8:27 AM (14 h, 48 m)
Storage Engine
blob
Storage Format
Raw Data
Storage Handle
259599
Default Alt Text
event_context.hpp (2 KB)

Event Timeline