libkazv
Kazv::Api::QueryKeysJob::JobResponse Class Reference

#include <keys.hpp>

Inheritance diagram for Kazv::Api::QueryKeysJob::JobResponse:
Collaboration diagram for Kazv::Api::QueryKeysJob::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, DeviceInformation > > deviceKeys () const
 Information on the queried devices. More...
 
immer::map< std::string, CrossSigningKeymasterKeys () const
 Information on the master cross-signing keys of the queried users. More...
 
immer::map< std::string, CrossSigningKeyselfSigningKeys () const
 Information on the self-signing keys of the queried users. More...
 
immer::map< std::string, CrossSigningKeyuserSigningKeys () const
 Information on the user-signing key of the user making the request, if they queried their own device information. 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::QueryKeysJob::JobResponse::JobResponse ( Response  r)

Member Function Documentation

◆ deviceKeys()

immer::map< std::string, immer::map< std::string, QueryKeysJob::DeviceInformation > > Kazv::Api::QueryKeysResponse::deviceKeys ( ) const

Information on the queried devices.

A map from user ID, to a map from device ID to device information. For each device, the information returned will be the same as uploaded via /keys/upload, with the addition of an unsigned property.

◆ failures()

immer::map< std::string, JsonWrap > Kazv::Api::QueryKeysResponse::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 device_keys result.

◆ masterKeys()

immer::map< std::string, CrossSigningKey > Kazv::Api::QueryKeysResponse::masterKeys ( ) const

Information on the master cross-signing keys of the queried users.

A map from user ID, to master key information. For each key, the information returned will be the same as uploaded via /keys/device_signing/upload, along with the signatures uploaded via /keys/signatures/upload that the requesting user is allowed to see.

◆ selfSigningKeys()

immer::map< std::string, CrossSigningKey > Kazv::Api::QueryKeysResponse::selfSigningKeys ( ) const

Information on the self-signing keys of the queried users.

A map from user ID, to self-signing key information. For each key, the information returned will be the same as uploaded via /keys/device_signing/upload.

◆ success()

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

◆ userSigningKeys()

immer::map< std::string, CrossSigningKey > Kazv::Api::QueryKeysResponse::userSigningKeys ( ) const

Information on the user-signing key of the user making the request, if they queried their own device information.

A map from user ID, to user-signing key information. The information returned will be the same as uploaded via /keys/device_signing/upload.


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