libkazv
|
Get events and state around the specified event. More...
#include <event_context.hpp>
Classes | |
class | JobResponse |
Public Member Functions | |
GetEventContextJob (std::string serverUrl, std::string _accessToken, std::string roomId, std::string eventId, std::optional< int > limit=std::nullopt, std::optional< std::string > filter=std::nullopt) | |
Get events and state around the specified event. More... | |
GetEventContextJob | withData (JsonWrap j) && |
GetEventContextJob | withData (JsonWrap j) const & |
![]() | |
BaseJob (std::string serverUrl, std::string requestUrl, Method method, std::string jobId, std::string token={}, ReturnType returnType=ReturnType::Json, Body body=EmptyBody{}, Query query={}, Header header={}, std::optional< FileDesc > responseFile=std::nullopt) | |
~BaseJob () | |
bool | shouldReturnJson () const |
std::string | url () const |
Body | requestBody () const |
Header | requestHeader () const |
ReturnType | returnType () const |
Query | requestQuery () const |
returns the non-encoded query as an array of pairs More... | |
Method | requestMethod () const |
Response | genResponse (Response r) const |
BaseJob | withData (JsonWrap j) && |
BaseJob | withData (JsonWrap j) const & |
BaseJob | withQueue (std::string id, JobQueuePolicy policy=AlwaysContinue) && |
BaseJob | withQueue (std::string id, JobQueuePolicy policy=AlwaysContinue) const & |
json | dataJson (const std::string &key) const |
std::string | dataStr (const std::string &key) const |
std::string | jobId () const |
std::optional< std::string > | queueId () const |
JobQueuePolicy | queuePolicy () const |
std::optional< FileDesc > | responseFile () const |
Static Public Member Functions | |
static constexpr auto | needsAuth () |
static BaseJob::Query | buildQuery (std::optional< int > limit, std::optional< std::string > filter) |
static BaseJob::Body | buildBody (std::string roomId, std::string eventId, std::optional< int > limit, std::optional< std::string > filter) |
![]() | |
static bool | contentTypeMatches (immer::array< std::string > expected, std::string actual) |
Additional Inherited Members | |
![]() | |
enum | ReturnType { Json, File } |
using | Method = std::variant< Get, Post, Put, Delete > |
using | Body = ::Kazv::Body |
using | BytesBody = ::Kazv::BytesBody |
using | JsonBody = ::Kazv::JsonBody |
using | EmptyBody = ::Kazv::EmptyBody |
using | Header = ::Kazv::Header |
using | Response = ::Kazv::Response |
![]() | |
static Get | GET {} |
static Post | POST {} |
static Put | PUT {} |
static Delete | DELETE {} |
![]() | |
void | attachData (JsonWrap data) |
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 for more information.
|
explicit |
Get events and state around the specified event.
roomId | The room to get events from. |
eventId | The event to get context around. |
limit | The maximum number of events to return. Default: 10. |
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 for more information.
|
static |
|
static |
|
inlinestaticconstexpr |
GetEventContextJob Kazv::Api::GetEventContextJob::withData | ( | JsonWrap | j | ) | && |
GetEventContextJob Kazv::Api::GetEventContextJob::withData | ( | JsonWrap | j | ) | const & |