libkazv
Kazv::Api::RequestTokenTo3PIDMSISDNJob Class Reference

Begins the validation process for a phone number for association with the user's account. More...

#include <administrative_contact.hpp>

Inheritance diagram for Kazv::Api::RequestTokenTo3PIDMSISDNJob:
Collaboration diagram for Kazv::Api::RequestTokenTo3PIDMSISDNJob:

Classes

class  JobResponse
 

Public Member Functions

 RequestTokenTo3PIDMSISDNJob (std::string serverUrl, MsisdnValidationData body)
 Begins the validation process for a phone number for association with the user's account. More...
 
RequestTokenTo3PIDMSISDNJob withData (JsonWrap j) &&
 
RequestTokenTo3PIDMSISDNJob 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 (MsisdnValidationData body)
 
- 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

Begins the validation process for a phone number for association with the user's account.

The homeserver must check that the given phone number is not already associated with an account on this homeserver. This API should be used to request validation tokens when adding a phone number to an account. This API's parameters and response are identical to that of the /register/msisdn/requestToken endpoint. The homeserver should validate the phone number itself, either by sending a validation message itself or by using a service it has control over.

Constructor & Destructor Documentation

◆ RequestTokenTo3PIDMSISDNJob()

Kazv::Api::RequestTokenTo3PIDMSISDNJob::RequestTokenTo3PIDMSISDNJob ( std::string  serverUrl,
MsisdnValidationData  body 
)
explicit

Begins the validation process for a phone number for association with the user's account.

Parameters
bodyThe homeserver must check that the given phone number is not already associated with an account on this homeserver. This API should be used to request validation tokens when adding a phone number to an account. This API's parameters and response are identical to that of the /register/msisdn/requestToken endpoint. The homeserver should validate the phone number itself, either by sending a validation message itself or by using a service it has control over.

Member Function Documentation

◆ buildBody()

BaseJob::Body Kazv::Api::RequestTokenTo3PIDMSISDNJob::buildBody ( MsisdnValidationData  body)
static

◆ buildQuery()

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

◆ needsAuth()

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

◆ withData() [1/2]

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

◆ withData() [2/2]

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

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