libkazv
Kazv::Api::GetAccount3PIDsJob Class Reference

Gets a list of a user's third party identifiers. More...

#include <administrative_contact.hpp>

Inheritance diagram for Kazv::Api::GetAccount3PIDsJob:
Collaboration diagram for Kazv::Api::GetAccount3PIDsJob:

Classes

class  JobResponse
 
struct  ThirdPartyIdentifier
 Gets a list of the third party identifiers that the homeserver has associated with the user's account. More...
 

Public Member Functions

 GetAccount3PIDsJob (std::string serverUrl, std::string _accessToken)
 Gets a list of a user's third party identifiers. More...
 
GetAccount3PIDsJob withData (JsonWrap j) &&
 
GetAccount3PIDsJob 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 ()
 
- 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

Gets a list of a user's third party identifiers.

Gets a list of the third party identifiers that the homeserver has associated with the user's account.

This is not the same as the list of third party identifiers bound to the user's Matrix ID in identity servers.

Identifiers in this list may be used by the homeserver as, for example, identifiers that it will accept to reset the user's account password.

Constructor & Destructor Documentation

◆ GetAccount3PIDsJob()

Kazv::Api::GetAccount3PIDsJob::GetAccount3PIDsJob ( std::string  serverUrl,
std::string  _accessToken 
)
explicit

Gets a list of a user's third party identifiers.

Member Function Documentation

◆ buildBody()

BaseJob::Body Kazv::Api::GetAccount3PIDsJob::buildBody ( )
static

◆ buildQuery()

BaseJob::Query Kazv::Api::GetAccount3PIDsJob::buildQuery ( )
static

◆ needsAuth()

static constexpr auto Kazv::Api::GetAccount3PIDsJob::needsAuth ( )
inlinestaticconstexpr

◆ withData() [1/2]

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

◆ withData() [2/2]

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

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