Retrieve Matrix-side portals rooms leading to a third party location. More...

#include <third_party_lookup.hpp>

Inheritance diagram for Kazv::Api::QueryLocationByProtocolJob:

Collaboration diagram for Kazv::Api::QueryLocationByProtocolJob:

[legend]

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 &

Public Member Functions inherited from Kazv::BaseJob
	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 Public Member Functions inherited from Kazv::BaseJob
static bool	contentTypeMatches (immer::array< std::string > expected, std::string actual)

Additional Inherited Members
Public Types inherited from Kazv::BaseJob
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 Public Attributes inherited from Kazv::BaseJob
static Get	GET {}

static Post	POST {}

static Put	PUT {}

static Delete	DELETE {}

Protected Member Functions inherited from Kazv::BaseJob
void	attachData (JsonWrap data)

Detailed Description

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.

Constructor & Destructor Documentation

◆ QueryLocationByProtocolJob()

Kazv::Api::QueryLocationByProtocolJob::QueryLocationByProtocolJob	(	std::string	serverUrl,
		std::string	_accessToken,
		std::string	protocol,
		std::optional< std::string >	searchFields = `std::nullopt`
	)

explicit

Retrieve Matrix-side portals rooms leading to a third party location.

Parameters

protocol	The protocol used to communicate to the third party network.
searchFields	One or more custom fields to help identify the third party location.

Member Function Documentation

◆ buildBody()

BaseJob::Body Kazv::Api::QueryLocationByProtocolJob::buildBody	(	std::string	protocol,
		std::optional< std::string >	searchFields
	)

static

◆ buildQuery()

BaseJob::Query Kazv::Api::QueryLocationByProtocolJob::buildQuery ( std::optional< std::string > searchFields )

static

◆ needsAuth()

static constexpr auto Kazv::Api::QueryLocationByProtocolJob::needsAuth ( )

inlinestaticconstexpr

◆ withData() [1/2]

QueryLocationByProtocolJob Kazv::Api::QueryLocationByProtocolJob::withData ( JsonWrap j ) &&

◆ withData() [2/2]

QueryLocationByProtocolJob Kazv::Api::QueryLocationByProtocolJob::withData ( JsonWrap j ) const &

The documentation for this class was generated from the following files:

src/api/csapi/third_party_lookup.hpp
src/api/csapi/third_party_lookup.cpp

Classes

Public Member Functions

Static Public Member Functions

Additional Inherited Members