Page MenuHomePhorge
Files F1037575

relations.hpp
No OneTemporary
Actions

Size
12 KB
Referenced Files
None
Subscribers
None

relations.hpp
View Options

/******************************************************************************
* THIS FILE IS GENERATED - ANY EDITS WILL BE OVERWRITTEN
*/
#pragma once
#include "basejob.hpp"
namespace Kazv::Api {
/*! \brief Get the child events for a given parent event.
*
* Retrieve all of the child events for a given parent event.
*
* Note that when paginating the `from` token should be "after" the `to` token in
* terms of topological ordering, because it is only possible to paginate "backwards"
* through events, starting at `from`.
*
* For example, passing a `from` token from page 2 of the results, and a `to` token
* from page 1, would return the empty set. The caller can use a `from` token from
* page 1 and a `to` token from page 2 to paginate over the same range, however.
*/
class GetRelatingEventsJob : public BaseJob {
public:
class JobResponse : public Response
{
public:
JobResponse(Response r);
bool success() const;
// Result properties
/// The child events of the requested event, ordered topologically most-recent first.
EventList chunk() const;
/// An opaque string representing a pagination token. The absence of this token
/// means there are no more results to fetch and the client should stop paginating.
std::optional<std::string> nextBatch() const;
/// An opaque string representing a pagination token. The absence of this token
/// means this is the start of the result set, i.e. this is the first batch/page.
std::optional<std::string> prevBatch() const;
};
static constexpr auto needsAuth() {
return true
;
}
// Construction/destruction
/*! \brief Get the child events for a given parent event.
*
* \param roomId
* The ID of the room containing the parent event.
*
* \param eventId
* The ID of the parent event whose child events are to be returned.
*
* \param from
* The pagination token to start returning results from. If not supplied, results
* start at the most recent topological event known to the server.
*
* Can be a `next_batch` token from a previous call, or a returned
* `start` token from [`/messages`](/client-server-api/#get_matrixclientv3roomsroomidmessages),
* or a `next_batch` token from [`/sync`](/client-server-api/#get_matrixclientv3sync).
*
* \param to
* The pagination token to stop returning results at. If not supplied, results
* continue up to `limit` or until there are no more events.
*
* Like `from`, this can be a previous token from a prior call to this endpoint
* or from `/messages` or `/sync`.
*
* \param limit
* The maximum number of results to return in a single `chunk`. The server can
* and should apply a maximum value to this parameter to avoid large responses.
*
* Similarly, the server should apply a default value when not supplied.
*/
explicit GetRelatingEventsJob(std::string serverUrl
, std::string _accessToken
,
std::string roomId , std::string eventId , std::optional<std::string> from = std::nullopt, std::optional<std::string> to = std::nullopt, std::optional<int> limit = std::nullopt
);
static BaseJob::Query buildQuery(
std::optional<std::string> from, std::optional<std::string> to, std::optional<int> limit);
static BaseJob::Body buildBody(std::string roomId, std::string eventId, std::optional<std::string> from, std::optional<std::string> to, std::optional<int> limit);
GetRelatingEventsJob withData(JsonWrap j) &&;
GetRelatingEventsJob withData(JsonWrap j) const &;
};
using GetRelatingEventsResponse = GetRelatingEventsJob::JobResponse;
}
namespace nlohmann
{
using namespace Kazv;
using namespace Kazv::Api;
}
namespace Kazv::Api
{
/*! \brief Get the child events for a given parent event, with a given `relType`.
*
* Retrieve all of the child events for a given parent event which relate to the parent
* using the given `relType`.
*
* Note that when paginating the `from` token should be "after" the `to` token in
* terms of topological ordering, because it is only possible to paginate "backwards"
* through events, starting at `from`.
*
* For example, passing a `from` token from page 2 of the results, and a `to` token
* from page 1, would return the empty set. The caller can use a `from` token from
* page 1 and a `to` token from page 2 to paginate over the same range, however.
*/
class GetRelatingEventsWithRelTypeJob : public BaseJob {
public:
class JobResponse : public Response
{
public:
JobResponse(Response r);
bool success() const;
// Result properties
/// The child events of the requested event, ordered topologically
/// most-recent first. The events returned will match the `relType`
/// supplied in the URL.
EventList chunk() const;
/// An opaque string representing a pagination token. The absence of this token
/// means there are no more results to fetch and the client should stop paginating.
std::optional<std::string> nextBatch() const;
/// An opaque string representing a pagination token. The absence of this token
/// means this is the start of the result set, i.e. this is the first batch/page.
std::optional<std::string> prevBatch() const;
};
static constexpr auto needsAuth() {
return true
;
}
// Construction/destruction
/*! \brief Get the child events for a given parent event, with a given `relType`.
*
* \param roomId
* The ID of the room containing the parent event.
*
* \param eventId
* The ID of the parent event whose child events are to be returned.
*
* \param relType
* The [relationship type](/client-server-api/#relationship-types) to search for.
*
* \param from
* The pagination token to start returning results from. If not supplied, results
* start at the most recent topological event known to the server.
*
* Can be a `next_batch` token from a previous call, or a returned
* `start` token from [`/messages`](/client-server-api/#get_matrixclientv3roomsroomidmessages),
* or a `next_batch` token from [`/sync`](/client-server-api/#get_matrixclientv3sync).
*
* \param to
* The pagination token to stop returning results at. If not supplied, results
* continue up to `limit` or until there are no more events.
*
* Like `from`, this can be a previous token from a prior call to this endpoint
* or from `/messages` or `/sync`.
*
* \param limit
* The maximum number of results to return in a single `chunk`. The server can
* and should apply a maximum value to this parameter to avoid large responses.
*
* Similarly, the server should apply a default value when not supplied.
*/
explicit GetRelatingEventsWithRelTypeJob(std::string serverUrl
, std::string _accessToken
,
std::string roomId , std::string eventId , std::string relType , std::optional<std::string> from = std::nullopt, std::optional<std::string> to = std::nullopt, std::optional<int> limit = std::nullopt
);
static BaseJob::Query buildQuery(
std::optional<std::string> from, std::optional<std::string> to, std::optional<int> limit);
static BaseJob::Body buildBody(std::string roomId, std::string eventId, std::string relType, std::optional<std::string> from, std::optional<std::string> to, std::optional<int> limit);
GetRelatingEventsWithRelTypeJob withData(JsonWrap j) &&;
GetRelatingEventsWithRelTypeJob withData(JsonWrap j) const &;
};
using GetRelatingEventsWithRelTypeResponse = GetRelatingEventsWithRelTypeJob::JobResponse;
}
namespace nlohmann
{
using namespace Kazv;
using namespace Kazv::Api;
}
namespace Kazv::Api
{
/*! \brief Get the child events for a given parent event, with a given `relType` and `eventType`.
*
* Retrieve all of the child events for a given parent event which relate to the parent
* using the given `relType` and have the given `eventType`.
*
* Note that when paginating the `from` token should be "after" the `to` token in
* terms of topological ordering, because it is only possible to paginate "backwards"
* through events, starting at `from`.
*
* For example, passing a `from` token from page 2 of the results, and a `to` token
* from page 1, would return the empty set. The caller can use a `from` token from
* page 1 and a `to` token from page 2 to paginate over the same range, however.
*/
class GetRelatingEventsWithRelTypeAndEventTypeJob : public BaseJob {
public:
class JobResponse : public Response
{
public:
JobResponse(Response r);
bool success() const;
// Result properties
/// The child events of the requested event, ordered topologically most-recent
/// first. The events returned will match the `relType` and `eventType` supplied
/// in the URL.
EventList chunk() const;
/// An opaque string representing a pagination token. The absence of this token
/// means there are no more results to fetch and the client should stop paginating.
std::optional<std::string> nextBatch() const;
/// An opaque string representing a pagination token. The absence of this token
/// means this is the start of the result set, i.e. this is the first batch/page.
std::optional<std::string> prevBatch() const;
};
static constexpr auto needsAuth() {
return true
;
}
// Construction/destruction
/*! \brief Get the child events for a given parent event, with a given `relType` and `eventType`.
*
* \param roomId
* The ID of the room containing the parent event.
*
* \param eventId
* The ID of the parent event whose child events are to be returned.
*
* \param relType
* The [relationship type](/client-server-api/#relationship-types) to search for.
*
* \param eventType
* The event type of child events to search for.
*
* Note that in encrypted rooms this will typically always be `m.room.encrypted`
* regardless of the event type contained within the encrypted payload.
*
* \param from
* The pagination token to start returning results from. If not supplied, results
* start at the most recent topological event known to the server.
*
* Can be a `next_batch` token from a previous call, or a returned
* `start` token from [`/messages`](/client-server-api/#get_matrixclientv3roomsroomidmessages),
* or a `next_batch` token from [`/sync`](/client-server-api/#get_matrixclientv3sync).
*
* \param to
* The pagination token to stop returning results at. If not supplied, results
* continue up to `limit` or until there are no more events.
*
* Like `from`, this can be a previous token from a prior call to this endpoint
* or from `/messages` or `/sync`.
*
* \param limit
* The maximum number of results to return in a single `chunk`. The server can
* and should apply a maximum value to this parameter to avoid large responses.
*
* Similarly, the server should apply a default value when not supplied.
*/
explicit GetRelatingEventsWithRelTypeAndEventTypeJob(std::string serverUrl
, std::string _accessToken
,
std::string roomId , std::string eventId , std::string relType , std::string eventType , std::optional<std::string> from = std::nullopt, std::optional<std::string> to = std::nullopt, std::optional<int> limit = std::nullopt
);
static BaseJob::Query buildQuery(
std::optional<std::string> from, std::optional<std::string> to, std::optional<int> limit);
static BaseJob::Body buildBody(std::string roomId, std::string eventId, std::string relType, std::string eventType, std::optional<std::string> from, std::optional<std::string> to, std::optional<int> limit);
GetRelatingEventsWithRelTypeAndEventTypeJob withData(JsonWrap j) &&;
GetRelatingEventsWithRelTypeAndEventTypeJob withData(JsonWrap j) const &;
};
using GetRelatingEventsWithRelTypeAndEventTypeResponse = GetRelatingEventsWithRelTypeAndEventTypeJob::JobResponse;
}
namespace nlohmann
{
using namespace Kazv;
using namespace Kazv::Api;
}
namespace Kazv::Api
{
} // namespace Kazv::Api

File Metadata

Mime Type
text/x-c++
Expires
Wed, May 14, 7:28 AM (1 d, 15 h)
Storage Engine
blob
Storage Format
Raw Data
Storage Handle
132952
Default Alt Text
relations.hpp (12 KB)

Event Timeline