libkazv
Kazv::Api::GetVersionsJob Class Reference

Gets the versions of the specification supported by the server. More...

#include <versions.hpp>

Inheritance diagram for Kazv::Api::GetVersionsJob:
Collaboration diagram for Kazv::Api::GetVersionsJob:

Classes

class  JobResponse
 

Public Member Functions

 GetVersionsJob (std::string serverUrl)
 Gets the versions of the specification supported by the server. More...
 
GetVersionsJob withData (JsonWrap j) &&
 
GetVersionsJob 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< FileDescresponseFile () const
 

Static Public Member Functions

static constexpr auto needsAuth ()
 
static BaseJob::Query buildQuery ()
 
static BaseJob::Body buildBody ()
 
- 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

Gets the versions of the specification supported by the server.

Gets the versions of the specification supported by the server.

Values will take the form vX.Y or rX.Y.Z in historical cases. See the Specification Versioning for more information.

The server may additionally advertise experimental features it supports through unstable_features. These features should be namespaced and may optionally include version information within their name if desired. Features listed here are not for optionally toggling parts of the Matrix specification and should only be used to advertise support for a feature which has not yet landed in the spec. For example, a feature currently undergoing the proposal process may appear here and eventually be taken off this list once the feature lands in the spec and the server deems it reasonable to do so. Servers may wish to keep advertising features here after they've been released into the spec to give clients a chance to upgrade appropriately. Additionally, clients should avoid using unstable features in their stable releases.

Constructor & Destructor Documentation

◆ GetVersionsJob()

Kazv::Api::GetVersionsJob::GetVersionsJob ( std::string  serverUrl)
explicit

Gets the versions of the specification supported by the server.

Member Function Documentation

◆ buildBody()

BaseJob::Body Kazv::Api::GetVersionsJob::buildBody ( )
static

◆ buildQuery()

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

◆ needsAuth()

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

◆ withData() [1/2]

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

◆ withData() [2/2]

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

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