libkazv
Kazv::Api::ClaimKeysJob::JobResponse Class Reference

#include <keys.hpp>

Inheritance diagram for Kazv::Api::ClaimKeysJob::JobResponse:
Collaboration diagram for Kazv::Api::ClaimKeysJob::JobResponse:

Public Member Functions

 JobResponse (Response r)
 
bool success () const
 
immer::map< std::string, JsonWrapfailures () const
 If any remote homeservers could not be reached, they are recorded here. More...
 
immer::map< std::string, immer::map< std::string, JsonWrap > > oneTimeKeys () const
 One-time keys for the queried devices. 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::ClaimKeysJob::JobResponse::JobResponse ( Response  r)

Member Function Documentation

◆ failures()

immer::map< std::string, JsonWrap > Kazv::Api::ClaimKeysResponse::failures ( ) const

If any remote homeservers could not be reached, they are recorded here.

The names of the properties are the names of the unreachable servers.

If the homeserver could be reached, but the user or device was unknown, no failure is recorded. Instead, the corresponding user or device is missing from the one_time_keys result.

◆ oneTimeKeys()

immer::map< std::string, immer::map< std::string, JsonWrap > > Kazv::Api::ClaimKeysResponse::oneTimeKeys ( ) const

One-time keys for the queried devices.

A map from user ID, to a map from devices to a map from <algorithm>:<key_id> to the key object.

See the key algorithms section for information on the Key Object format.

If necessary, the claimed key might be a fallback key. Fallback keys are re-used by the server until replaced by the device.

◆ success()

bool Kazv::Api::ClaimKeysResponse::success ( ) const

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