libkazv
knocking.hpp
Go to the documentation of this file.
1 /******************************************************************************
2  * THIS FILE IS GENERATED - ANY EDITS WILL BE OVERWRITTEN
3  */
4 
5 #pragma once
6 
7 #include "basejob.hpp"
8 
9 
10 namespace Kazv::Api {
11 
30 class KnockRoomJob : public BaseJob {
31 public:
32 
33 
34 
35 class JobResponse : public Response
36 {
37 
38 public:
40  bool success() const;
41 
42  // Result properties
43 
44 
45 
46 
48 std::string roomId() const;
49 
50 };
51  static constexpr auto needsAuth() {
52  return true
53  ;
54  }
55 
56 
57 // Construction/destruction
58 
72  explicit KnockRoomJob(std::string serverUrl
73  , std::string _accessToken
74  ,
75  std::string roomIdOrAlias , immer::array<std::string> serverName = {}, std::optional<std::string> reason = std::nullopt
76  );
77 
78 
80  immer::array<std::string> serverName);
81 
82  static BaseJob::Body buildBody(std::string roomIdOrAlias, immer::array<std::string> serverName, std::optional<std::string> reason);
83 
84 
85 
86 
87 
89  KnockRoomJob withData(JsonWrap j) const &;
90  };
92  }
93  namespace nlohmann
94  {
95  using namespace Kazv;
96  using namespace Kazv::Api;
97 
98  }
99 
100  namespace Kazv::Api
101  {
102 
103 } // namespace Kazv::Api
Kazv::Api::KnockRoomJob::JobResponse::success
bool success() const
Definition: knocking.cpp:79
Kazv::Api::KnockRoomJob::buildQuery
static BaseJob::Query buildQuery(immer::array< std::string > serverName)
Definition: knocking.cpp:15
Kazv::Api::KnockRoomJob::JobResponse::roomId
std::string roomId() const
The knocked room ID.
Definition: knocking.cpp:90
nlohmann
Definition: location.hpp:26
Kazv
Definition: location.hpp:10
Kazv::BaseJob::Query
Definition: basejob.hpp:90
Kazv::Api::KnockRoomJob::buildBody
static BaseJob::Body buildBody(std::string roomIdOrAlias, immer::array< std::string > serverName, std::optional< std::string > reason)
Definition: knocking.cpp:24
Kazv::Api
Definition: location.hpp:10
Kazv::Api::KnockRoomJob::needsAuth
static constexpr auto needsAuth()
Definition: knocking.hpp:55
Kazv::Api::KnockRoomJob::KnockRoomJob
KnockRoomJob(std::string serverUrl, std::string _accessToken, std::string roomIdOrAlias, immer::array< std::string > serverName={}, std::optional< std::string > reason=std::nullopt)
Knock on a room, requesting permission to join.
Definition: knocking.cpp:42
basejob.hpp
Kazv::JsonWrap
Definition: jsonwrap.hpp:22
Kazv::Api::KnockRoomJob
Knock on a room, requesting permission to join.
Definition: knocking.hpp:32
Kazv::Api::KnockRoomJob::JobResponse
Definition: knocking.hpp:39
Kazv::Api::KnockRoomJob::JobResponse::JobResponse
JobResponse(Response r)
Definition: knocking.cpp:76
Kazv::Api::KnockRoomJob::withData
KnockRoomJob withData(JsonWrap j) &&
Definition: knocking.cpp:62
Kazv::BaseJob::Body
::Kazv::Body Body
Definition: basejob.hpp:100
Kazv::Response
Definition: basejob.hpp:50