Deletes a third party identifier from the user's account. More...

#include <administrative_contact.hpp>

Inheritance diagram for Kazv::Api::Delete3pidFromAccountJob:

Collaboration diagram for Kazv::Api::Delete3pidFromAccountJob:

[legend]

Classes
class	JobResponse

Public Member Functions
	Delete3pidFromAccountJob (std::string serverUrl, std::string _accessToken, std::string medium, std::string address, std::optional< std::string > idServer=std::nullopt)
	Deletes a third party identifier from the user's account. More...

Delete3pidFromAccountJob	withData (JsonWrap j) &&

Delete3pidFromAccountJob	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 (std::string medium, std::string address, 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

Deletes a third party identifier from the user's account.

Removes a third party identifier from the user's account. This might not cause an unbind of the identifier from the identity server.

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

◆ Delete3pidFromAccountJob()

Kazv::Api::Delete3pidFromAccountJob::Delete3pidFromAccountJob	(	std::string	serverUrl,
		std::string	_accessToken,
		std::string	medium,
		std::string	address,
		std::optional< std::string >	idServer = `std::nullopt`
	)

explicit

Deletes a third party identifier from the user's account.

Parameters

medium	The medium of the third party identifier being removed.
address	The third party address being removed.
idServer	The identity server to unbind from. If not provided, the homeserver MUST use the `id_server` the identifier was added through. If the homeserver does not know the original `id_server`, it MUST return a `id_server_unbind_result` of `no-support`.

Member Function Documentation

◆ buildBody()

BaseJob::Body Kazv::Api::Delete3pidFromAccountJob::buildBody	(	std::string	medium,
		std::string	address,
		std::optional< std::string >	idServer
	)

static

◆ buildQuery()

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

static

◆ needsAuth()

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

inlinestaticconstexpr

◆ withData() [1/2]

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

◆ withData() [2/2]

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

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

src/api/csapi/administrative_contact.hpp
src/api/csapi/administrative_contact.cpp

Classes

Public Member Functions

Static Public Member Functions

Additional Inherited Members