libkazv
Public Types | Public Member Functions | Public Attributes | List of all members
Kazv::Response Struct Reference

#include <basejob.hpp>

Inherited by Kazv::Api::Add3PIDJob::JobResponse, Kazv::Api::BanJob::JobResponse, Kazv::Api::Bind3PIDJob::JobResponse, Kazv::Api::ChangePasswordJob::JobResponse, Kazv::Api::CheckUsernameAvailabilityJob::JobResponse, Kazv::Api::ClaimKeysJob::JobResponse, Kazv::Api::CreateRoomJob::JobResponse, Kazv::Api::DeactivateAccountJob::JobResponse, Kazv::Api::DefineFilterJob::JobResponse, Kazv::Api::Delete3pidFromAccountJob::JobResponse, Kazv::Api::DeleteDeviceJob::JobResponse, Kazv::Api::DeleteDevicesJob::JobResponse, Kazv::Api::DeletePushRuleJob::JobResponse, Kazv::Api::DeleteRoomAliasJob::JobResponse, Kazv::Api::DeleteRoomTagJob::JobResponse, Kazv::Api::ForgetRoomJob::JobResponse, Kazv::Api::GetAccount3PIDsJob::JobResponse, Kazv::Api::GetAccountDataJob::JobResponse, Kazv::Api::GetAccountDataPerRoomJob::JobResponse, Kazv::Api::GetAvatarUrlJob::JobResponse, Kazv::Api::GetCapabilitiesJob::JobResponse, Kazv::Api::GetConfigJob::JobResponse, Kazv::Api::GetContentJob::JobResponse, Kazv::Api::GetContentOverrideNameJob::JobResponse, Kazv::Api::GetContentThumbnailJob::JobResponse, Kazv::Api::GetDeviceJob::JobResponse, Kazv::Api::GetDevicesJob::JobResponse, Kazv::Api::GetDisplayNameJob::JobResponse, Kazv::Api::GetEventContextJob::JobResponse, Kazv::Api::GetEventsJob::JobResponse, Kazv::Api::GetFilterJob::JobResponse, Kazv::Api::GetJoinedMembersByRoomJob::JobResponse, Kazv::Api::GetJoinedRoomsJob::JobResponse, Kazv::Api::GetKeysChangesJob::JobResponse, Kazv::Api::GetLocalAliasesJob::JobResponse, Kazv::Api::GetLoginFlowsJob::JobResponse, Kazv::Api::GetMembersByRoomJob::JobResponse, Kazv::Api::GetNotificationsJob::JobResponse, Kazv::Api::GetOneEventJob::JobResponse, Kazv::Api::GetOneRoomEventJob::JobResponse, Kazv::Api::GetPresenceJob::JobResponse, Kazv::Api::GetProtocolMetadataJob::JobResponse, Kazv::Api::GetProtocolsJob::JobResponse, Kazv::Api::GetPublicRoomsJob::JobResponse, Kazv::Api::GetPushRuleActionsJob::JobResponse, Kazv::Api::GetPushRuleJob::JobResponse, Kazv::Api::GetPushRulesJob::JobResponse, Kazv::Api::GetPushersJob::JobResponse, Kazv::Api::GetRelatingEventsJob::JobResponse, Kazv::Api::GetRelatingEventsWithRelTypeAndEventTypeJob::JobResponse, Kazv::Api::GetRelatingEventsWithRelTypeJob::JobResponse, Kazv::Api::GetRoomEventsJob::JobResponse, Kazv::Api::GetRoomIdByAliasJob::JobResponse, Kazv::Api::GetRoomStateJob::JobResponse, Kazv::Api::GetRoomStateWithKeyJob::JobResponse, Kazv::Api::GetRoomTagsJob::JobResponse, Kazv::Api::GetRoomVisibilityOnDirectoryJob::JobResponse, Kazv::Api::GetSpaceHierarchyJob::JobResponse, Kazv::Api::GetTokenOwnerJob::JobResponse, Kazv::Api::GetTurnServerJob::JobResponse, Kazv::Api::GetUrlPreviewJob::JobResponse, Kazv::Api::GetUserProfileJob::JobResponse, Kazv::Api::GetVersionsJob::JobResponse, Kazv::Api::GetWellknownJob::JobResponse, Kazv::Api::GetWhoIsJob::JobResponse, Kazv::Api::InitialSyncJob::JobResponse, Kazv::Api::InviteBy3PIDJob::JobResponse, Kazv::Api::InviteUserJob::JobResponse, Kazv::Api::IsPushRuleEnabledJob::JobResponse, Kazv::Api::JoinRoomByIdJob::JobResponse, Kazv::Api::JoinRoomJob::JobResponse, Kazv::Api::KickJob::JobResponse, Kazv::Api::KnockRoomJob::JobResponse, Kazv::Api::LeaveRoomJob::JobResponse, Kazv::Api::LoginJob::JobResponse, Kazv::Api::LogoutAllJob::JobResponse, Kazv::Api::LogoutJob::JobResponse, Kazv::Api::PeekEventsJob::JobResponse, Kazv::Api::Post3PIDsJob::JobResponse, Kazv::Api::PostPusherJob::JobResponse, Kazv::Api::PostReceiptJob::JobResponse, Kazv::Api::QueryKeysJob::JobResponse, Kazv::Api::QueryLocationByAliasJob::JobResponse, Kazv::Api::QueryLocationByProtocolJob::JobResponse, Kazv::Api::QueryPublicRoomsJob::JobResponse, Kazv::Api::QueryUserByIDJob::JobResponse, Kazv::Api::QueryUserByProtocolJob::JobResponse, Kazv::Api::RedactEventJob::JobResponse, Kazv::Api::RefreshJob::JobResponse, Kazv::Api::RegisterJob::JobResponse, Kazv::Api::RegistrationTokenValidityJob::JobResponse, Kazv::Api::ReportContentJob::JobResponse, Kazv::Api::RequestOpenIdTokenJob::JobResponse, Kazv::Api::RequestTokenTo3PIDEmailJob::JobResponse, Kazv::Api::RequestTokenTo3PIDMSISDNJob::JobResponse, Kazv::Api::RequestTokenToRegisterEmailJob::JobResponse, Kazv::Api::RequestTokenToRegisterMSISDNJob::JobResponse, Kazv::Api::RequestTokenToResetPasswordEmailJob::JobResponse, Kazv::Api::RequestTokenToResetPasswordMSISDNJob::JobResponse, Kazv::Api::RoomInitialSyncJob::JobResponse, Kazv::Api::SearchJob::JobResponse, Kazv::Api::SearchUserDirectoryJob::JobResponse, Kazv::Api::SendMessageJob::JobResponse, Kazv::Api::SendToDeviceJob::JobResponse, Kazv::Api::SetAccountDataJob::JobResponse, Kazv::Api::SetAccountDataPerRoomJob::JobResponse, Kazv::Api::SetAvatarUrlJob::JobResponse, Kazv::Api::SetDisplayNameJob::JobResponse, Kazv::Api::SetPresenceJob::JobResponse, Kazv::Api::SetPushRuleActionsJob::JobResponse, Kazv::Api::SetPushRuleEnabledJob::JobResponse, Kazv::Api::SetPushRuleJob::JobResponse, Kazv::Api::SetReadMarkerJob::JobResponse, Kazv::Api::SetRoomAliasJob::JobResponse, Kazv::Api::SetRoomStateWithKeyJob::JobResponse, Kazv::Api::SetRoomTagJob::JobResponse, Kazv::Api::SetRoomVisibilityOnDirectoryJob::JobResponse, Kazv::Api::SetTypingJob::JobResponse, Kazv::Api::SyncJob::JobResponse, Kazv::Api::UnbanJob::JobResponse, Kazv::Api::Unbind3pidFromAccountJob::JobResponse, Kazv::Api::UpdateAppserviceRoomDirectoryVisibilityJob::JobResponse, Kazv::Api::UpdateDeviceJob::JobResponse, Kazv::Api::UpgradeRoomJob::JobResponse, Kazv::Api::UploadContentJob::JobResponse, Kazv::Api::UploadCrossSigningKeysJob::JobResponse, Kazv::Api::UploadCrossSigningSignaturesJob::JobResponse, and Kazv::Api::UploadKeysJob::JobResponse.

Collaboration diagram for Kazv::Response:
Collaboration graph
[legend]

Public Types

using StatusCode = int
 

Public Member Functions

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
 

Public Attributes

StatusCode statusCode
 
Body body
 
Header header
 
JsonWrap extraData
 

Member Typedef Documentation

◆ StatusCode

using Kazv::Response::StatusCode = int

Member Function Documentation

◆ dataJson()

json Kazv::Response::dataJson ( const std::string &  key) const

◆ dataStr()

std::string Kazv::Response::dataStr ( const std::string &  key) const

◆ errorCode()

std::string Kazv::Response::errorCode ( ) const

◆ errorMessage()

std::string Kazv::Response::errorMessage ( ) const

◆ jobId()

std::string Kazv::Response::jobId ( ) const

◆ jsonBody()

JsonWrap Kazv::Response::jsonBody ( ) const

◆ success()

constexpr bool Kazv::Response::success ( ) const
inlineconstexpr

Member Data Documentation

◆ body

Body Kazv::Response::body

◆ extraData

JsonWrap Kazv::Response::extraData

◆ header

Header Kazv::Response::header

◆ statusCode

StatusCode Kazv::Response::statusCode
The documentation for this struct was generated from the following files: