Kazv::Api::DeactivateAccountJob Class Reference

Deactivate a user's account. More...

#include <registration.hpp>

Inheritance diagram for Kazv::Api::DeactivateAccountJob:
Collaboration diagram for Kazv::Api::DeactivateAccountJob:


class  JobResponse

Public Member Functions

 DeactivateAccountJob (std::string serverUrl, std::string _accessToken, std::optional< AuthenticationData > auth=std::nullopt, std::optional< std::string > idServer=std::nullopt)
 Deactivate a user's account. More...
DeactivateAccountJob withData (JsonWrap j) &&
DeactivateAccountJob 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 (std::optional< AuthenticationData > auth, std::optional< std::string > idServer)
- 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

Deactivate a user's account.

Deactivate the user's account, removing all ability for the user to login again.

This API endpoint uses the User-Interactive Authentication API.

An access token should be submitted to this endpoint if the client has an active session.

The homeserver may change the flows available depending on whether a valid access token is provided.

Unlike other endpoints, this endpoint does not take an id_access_token parameter because the homeserver is expected to sign the request to the identity server instead.

Constructor & Destructor Documentation

◆ DeactivateAccountJob()

Kazv::Api::DeactivateAccountJob::DeactivateAccountJob ( std::string  serverUrl,
std::string  _accessToken,
std::optional< AuthenticationData auth = std::nullopt,
std::optional< std::string >  idServer = std::nullopt 

Deactivate a user's account.

authAdditional authentication information for the user-interactive authentication API.
idServerThe identity server to unbind all of the user's 3PIDs from. If not provided, the homeserver MUST use the id_server that was originally use to bind each identifier. If the homeserver does not know which id_server that was, it must return an id_server_unbind_result of no-support.

Member Function Documentation

◆ buildBody()

BaseJob::Body Kazv::Api::DeactivateAccountJob::buildBody ( std::optional< AuthenticationData auth,
std::optional< std::string >  idServer 

◆ buildQuery()

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

◆ needsAuth()

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

◆ withData() [1/2]

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

◆ withData() [2/2]

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

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