libkazv
Classes | Public Member Functions | Static Public Member Functions | List of all members
Kazv::Api::GetProtocolMetadataJob Class Reference

Retrieve metadata about a specific protocol that the homeserver supports. More...

#include <third_party_lookup.hpp>

Inheritance diagram for Kazv::Api::GetProtocolMetadataJob:
Inheritance graph
[legend]
Collaboration diagram for Kazv::Api::GetProtocolMetadataJob:
Collaboration graph
[legend]

Classes

class  JobResponse
 

Public Member Functions

 GetProtocolMetadataJob (std::string serverUrl, std::string _accessToken, std::string protocol)
 Retrieve metadata about a specific protocol that the homeserver supports. More...
 
GetProtocolMetadataJob withData (JsonWrap j) &&
 
GetProtocolMetadataJob 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 ()
 
static BaseJob::Body buildBody (std::string protocol)
 
- 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 metadata about a specific protocol that the homeserver supports.

Fetches the metadata from the homeserver about a particular third party protocol.

Constructor & Destructor Documentation

◆ GetProtocolMetadataJob()

Kazv::Api::GetProtocolMetadataJob::GetProtocolMetadataJob ( std::string  serverUrl,
std::string  _accessToken,
std::string  protocol 
)
explicit

Retrieve metadata about a specific protocol that the homeserver supports.

Parameters
protocolThe name of the protocol.

Member Function Documentation

◆ buildBody()

BaseJob::Body Kazv::Api::GetProtocolMetadataJob::buildBody ( std::string  protocol)
static

◆ buildQuery()

BaseJob::Query Kazv::Api::GetProtocolMetadataJob::buildQuery ( )
static

◆ needsAuth()

static constexpr auto Kazv::Api::GetProtocolMetadataJob::needsAuth ( )
inlinestaticconstexpr

◆ withData() [1/2]

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

◆ withData() [2/2]

GetProtocolMetadataJob Kazv::Api::GetProtocolMetadataJob::withData ( JsonWrap  j) const &
The documentation for this class was generated from the following files: