libkazv
|
Retrieve Matrix-side portals rooms leading to a third party location. More...
#include <third_party_lookup.hpp>
Classes | |
class | JobResponse |
Public Member Functions | |
QueryLocationByProtocolJob (std::string serverUrl, std::string _accessToken, std::string protocol, std::optional< std::string > searchFields=std::nullopt) | |
Retrieve Matrix-side portals rooms leading to a third party location. More... | |
QueryLocationByProtocolJob | withData (JsonWrap j) && |
QueryLocationByProtocolJob | 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< std::string > searchFields) |
static BaseJob::Body | buildBody (std::string protocol, std::optional< std::string > searchFields) |
![]() | |
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) |
Retrieve Matrix-side portals rooms leading to a third party location.
Requesting this endpoint with a valid protocol name results in a list of successful mapping results in a JSON array. Each result contains objects to represent the Matrix room or rooms that represent a portal to this third party network. Each has the Matrix room alias string, an identifier for the particular third party network protocol, and an object containing the network-specific fields that comprise this identifier. It should attempt to canonicalise the identifier as much as reasonably possible given the network type.
|
explicit |
Retrieve Matrix-side portals rooms leading to a third party location.
protocol | The protocol used to communicate to the third party network. |
searchFields | One or more custom fields to help identify the third party location. |
|
static |
|
static |
|
inlinestaticconstexpr |
QueryLocationByProtocolJob Kazv::Api::QueryLocationByProtocolJob::withData | ( | JsonWrap | j | ) | && |
QueryLocationByProtocolJob Kazv::Api::QueryLocationByProtocolJob::withData | ( | JsonWrap | j | ) | const & |