Kazv::Api::Post3PIDsJob::JobResponse Class Reference
#include <administrative_contact.hpp>
Inheritance diagram for Kazv::Api::Post3PIDsJob::JobResponse:
Collaboration diagram for Kazv::Api::Post3PIDsJob::JobResponse:
Public Member Functions | |
| JobResponse (Response r) | |
| bool | success () const |
| std::optional< std::string > | submitUrl () const |
An optional field containing a URL where the client must submit the validation token to, with identical parameters to the Identity Service API's POST /validate/email/submitToken endpoint (without the requirement for an access token). More... | |
 Public Member Functions inherited from Kazv::Response | |
| std::string | errorCode () const |
| std::string | errorMessage () const |
| JsonWrap | jsonBody () const |
| constexpr bool | success () const |
| json | dataJson (const std::string &key) const |
| std::string | dataStr (const std::string &key) const |
| std::string | jobId () const |
Additional Inherited Members | |
| Public Types inherited from Kazv::Response | |
| using | StatusCode = int |
| Public Attributes inherited from Kazv::Response | |
| StatusCode | statusCode |
| Body | body |
| Header | header |
| JsonWrap | extraData |
Constructor & Destructor Documentation
◆ JobResponse()
| Kazv::Api::Post3PIDsJob::JobResponse::JobResponse | ( | Response | r | ) |
Member Function Documentation
◆ submitUrl()
| std::optional< std::string > Kazv::Api::Post3PIDsResponse::submitUrl | ( | ) | const |
An optional field containing a URL where the client must submit the validation token to, with identical parameters to the Identity Service API's POST /validate/email/submitToken endpoint (without the requirement for an access token).
The homeserver must send this token to the user (if applicable), who should then be prompted to provide it to the client.
If this field is not present, the client can assume that verification will happen without the client's involvement provided the homeserver advertises this specification version in the /versions response (ie: r0.5.0).
◆ success()
| bool Kazv::Api::Post3PIDsResponse::success | ( | ) | const |
The documentation for this class was generated from the following files:
- src/api/csapi/administrative_contact.hpp
- src/api/csapi/administrative_contact.cpp
