Binds a 3PID to the user's account through an Identity Service. More...

#include <administrative_contact.hpp>

Inheritance diagram for Kazv::Api::Bind3PIDJob:

Collaboration diagram for Kazv::Api::Bind3PIDJob:

[legend]

Classes
class	JobResponse

Public Member Functions
	Bind3PIDJob (std::string serverUrl, std::string _accessToken, std::string clientSecret, std::string idServer, std::string idAccessToken, std::string sid)
	Binds a 3PID to the user's account through an Identity Service. More...

Bind3PIDJob	withData (JsonWrap j) &&

Bind3PIDJob	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 idServer, std::string idAccessToken, std::string sid)

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

Binds a 3PID to the user's account through an Identity Service.

Binds a 3PID to the user's account through the specified identity server.

Homeservers should not prevent this request from succeeding if another user has bound the 3PID. Homeservers should simply proxy any errors received by the identity server to the caller.

Homeservers should track successful binds so they can be unbound later.

Constructor & Destructor Documentation

◆ Bind3PIDJob()

Kazv::Api::Bind3PIDJob::Bind3PIDJob	(	std::string	serverUrl,
		std::string	_accessToken,
		std::string	clientSecret,
		std::string	idServer,
		std::string	idAccessToken,
		std::string	sid
	)

explicit

Binds a 3PID to the user's account through an Identity Service.

Parameters

clientSecret	The client secret used in the session with the identity server.
idServer	The identity server to use.
idAccessToken	An access token previously registered with the identity server.
sid	The session identifier given by the identity server.

Member Function Documentation

◆ buildBody()

BaseJob::Body Kazv::Api::Bind3PIDJob::buildBody	(	std::string	clientSecret,
		std::string	idServer,
		std::string	idAccessToken,
		std::string	sid
	)

static

◆ buildQuery()

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

static

◆ needsAuth()

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

inlinestaticconstexpr

◆ withData() [1/2]

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

◆ withData() [2/2]

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