Requests a validation token be sent to the given phone number for the purpose of resetting a user's password. More...

#include <registration.hpp>

Inheritance diagram for Kazv::Api::RequestTokenToResetPasswordMSISDNJob:

Collaboration diagram for Kazv::Api::RequestTokenToResetPasswordMSISDNJob:

[legend]

Classes
class	JobResponse

Public Member Functions
	RequestTokenToResetPasswordMSISDNJob (std::string serverUrl, MsisdnValidationData body)
	Requests a validation token be sent to the given phone number for the purpose of resetting a user's password. More...

RequestTokenToResetPasswordMSISDNJob	withData (JsonWrap j) &&

RequestTokenToResetPasswordMSISDNJob	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 (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

Requests a validation token be sent to the given phone number for the purpose of resetting a user's password.

The homeserver must check that the given phone number is associated with an account on this homeserver. This API should be used to request validation tokens when authenticating for the /account/password endpoint.

This API's parameters and response are identical to that of the /register/msisdn/requestToken endpoint, except that M_THREEPID_NOT_FOUND may be returned if no account matching the given phone number could be found. The server may instead send the SMS to the given phone number prompting the user to create an account. M_THREEPID_IN_USE may not be returned.

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

◆ RequestTokenToResetPasswordMSISDNJob()

Kazv::Api::RequestTokenToResetPasswordMSISDNJob::RequestTokenToResetPasswordMSISDNJob	(	std::string	serverUrl,
		MsisdnValidationData	body
	)

explicit

Requests a validation token be sent to the given phone number for the purpose of resetting a user's password.

Parameters

body	The homeserver must check that the given phone number is associated with an account on this homeserver. This API should be used to request validation tokens when authenticating for the `/account/password` endpoint.

This API's parameters and response are identical to that of the /register/msisdn/requestToken endpoint, except that M_THREEPID_NOT_FOUND may be returned if no account matching the given phone number could be found. The server may instead send the SMS to the given phone number prompting the user to create an account. M_THREEPID_IN_USE may not be returned.

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::RequestTokenToResetPasswordMSISDNJob::buildBody ( MsisdnValidationData body )

static

◆ buildQuery()

BaseJob::Query Kazv::Api::RequestTokenToResetPasswordMSISDNJob::buildQuery ( )

static

◆ needsAuth()

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

inlinestaticconstexpr

◆ withData() [1/2]

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

◆ withData() [2/2]

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

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

src/api/csapi/registration.hpp
src/api/csapi/registration.cpp

Classes

Public Member Functions

Static Public Member Functions

Additional Inherited Members