Adds contact information to the user's account. More...

#include <administrative_contact.hpp>

Inheritance diagram for Kazv::Api::Add3PIDJob:

Collaboration diagram for Kazv::Api::Add3PIDJob:

[legend]

Classes
class	JobResponse

Public Member Functions
	Add3PIDJob (std::string serverUrl, std::string _accessToken, std::string clientSecret, std::string sid, std::optional< AuthenticationData > auth=std::nullopt)
	Adds contact information to the user's account. More...

Add3PIDJob	withData (JsonWrap j) &&

Add3PIDJob	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 clientSecret, std::string sid, std::optional< AuthenticationData > auth)

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

Adds contact information to the user's account.

This API endpoint uses the User-Interactive Authentication API.

Adds contact information to the user's account. Homeservers should use 3PIDs added through this endpoint for password resets instead of relying on the identity server.

Homeservers should prevent the caller from adding a 3PID to their account if it has already been added to another user's account on the homeserver.

Constructor & Destructor Documentation

◆ Add3PIDJob()

Kazv::Api::Add3PIDJob::Add3PIDJob	(	std::string	serverUrl,
		std::string	_accessToken,
		std::string	clientSecret,
		std::string	sid,
		std::optional< AuthenticationData >	auth = `std::nullopt`
	)

explicit

Adds contact information to the user's account.

Parameters

clientSecret	The client secret used in the session with the homeserver.
sid	The session identifier given by the homeserver.
auth	Additional authentication information for the user-interactive authentication API.

Member Function Documentation

◆ buildBody()

BaseJob::Body Kazv::Api::Add3PIDJob::buildBody	(	std::string	clientSecret,
		std::string	sid,
		std::optional< AuthenticationData >	auth
	)

static

◆ buildQuery()

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

static

◆ needsAuth()

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

inlinestaticconstexpr

◆ withData() [1/2]

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

◆ withData() [2/2]

Add3PIDJob Kazv::Api::Add3PIDJob::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