Kazv::Api::GetTurnServerJob Class Reference
Obtain TURN server credentials. More...
#include <voip.hpp>
Inheritance diagram for Kazv::Api::GetTurnServerJob:
Collaboration diagram for Kazv::Api::GetTurnServerJob:
Classes | |
| class | JobResponse |
Public Member Functions | |
| GetTurnServerJob (std::string serverUrl, std::string _accessToken) | |
| Obtain TURN server credentials. More... | |
| GetTurnServerJob | withData (JsonWrap j) && |
| GetTurnServerJob | 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 () |
| 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
Obtain TURN server credentials.
This API provides credentials for the client to use when initiating calls.
Constructor & Destructor Documentation
◆ GetTurnServerJob()
|
explicit |
Obtain TURN server credentials.
Member Function Documentation
◆ buildBody()
|
static |
◆ buildQuery()
|
static |
◆ needsAuth()
|
inlinestaticconstexpr |
◆ withData() [1/2]
| GetTurnServerJob Kazv::Api::GetTurnServerJob::withData | ( | JsonWrap | j | ) | && |
◆ withData() [2/2]
| GetTurnServerJob Kazv::Api::GetTurnServerJob::withData | ( | JsonWrap | j | ) | const & |
The documentation for this class was generated from the following files:
