libkazv
joining.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"
9 
10 namespace Kazv::Api {
11 
26 class JoinRoomByIdJob : public BaseJob {
27 public:
28 
29 
30 
31 class JobResponse : public Response
32 {
33 
34 public:
36  bool success() const;
37 
38  // Result properties
39 
40 
41 
42 
44 std::string roomId() const;
45 
46 };
47  static constexpr auto needsAuth() {
48  return true
49  ;
50  }
51 
52 
53 // Construction/destruction
54 
69  explicit JoinRoomByIdJob(std::string serverUrl
70  , std::string _accessToken
71  ,
72  std::string roomId , std::optional<ThirdPartySigned> thirdPartySigned = std::nullopt, std::optional<std::string> reason = std::nullopt
73  );
74 
75 
77  );
78 
79  static BaseJob::Body buildBody(std::string roomId, std::optional<ThirdPartySigned> thirdPartySigned, std::optional<std::string> reason);
80 
81 
82 
83 
84 
87  };
89  }
90  namespace nlohmann
91  {
92  using namespace Kazv;
93  using namespace Kazv::Api;
94 
95  }
96 
97  namespace Kazv::Api
98  {
99 
113 class JoinRoomJob : public BaseJob {
114 public:
115 
116 
117 
118 class JobResponse : public Response
119 {
120 
121 public:
123  bool success() const;
124 
125  // Result properties
126 
127 
128 
129 
131 std::string roomId() const;
132 
133 };
134  static constexpr auto needsAuth() {
135  return true
136  ;
137  }
138 
139 
140 // Construction/destruction
141 
160  explicit JoinRoomJob(std::string serverUrl
161  , std::string _accessToken
162  ,
163  std::string roomIdOrAlias , immer::array<std::string> serverName = {}, std::optional<ThirdPartySigned> thirdPartySigned = std::nullopt, std::optional<std::string> reason = std::nullopt
164  );
165 
166 
167  static BaseJob::Query buildQuery(
168  immer::array<std::string> serverName);
169 
170  static BaseJob::Body buildBody(std::string roomIdOrAlias, immer::array<std::string> serverName, std::optional<ThirdPartySigned> thirdPartySigned, std::optional<std::string> reason);
171 
172 
173 
174 
175 
176  JoinRoomJob withData(JsonWrap j) &&;
177  JoinRoomJob withData(JsonWrap j) const &;
178  };
180  }
181  namespace nlohmann
182  {
183  using namespace Kazv;
184  using namespace Kazv::Api;
185 
186  }
187 
188  namespace Kazv::Api
189  {
190 
191 } // namespace Kazv::Api
Kazv::Api::JoinRoomByIdJob::buildBody
static BaseJob::Body buildBody(std::string roomId, std::optional< ThirdPartySigned > thirdPartySigned, std::optional< std::string > reason)
Definition: joining.cpp:23
Kazv::Api::JoinRoomByIdJob::JoinRoomByIdJob
JoinRoomByIdJob(std::string serverUrl, std::string _accessToken, std::string roomId, std::optional< ThirdPartySigned > thirdPartySigned=std::nullopt, std::optional< std::string > reason=std::nullopt)
Start the requesting user participating in a particular room.
Definition: joining.cpp:43
nlohmann
Definition: location.hpp:26
Kazv
Definition: location.hpp:10
Kazv::Api::JoinRoomJob::JobResponse
Definition: joining.hpp:118
Kazv::BaseJob::Query
Definition: basejob.hpp:90
Kazv::Api::JoinRoomByIdJob::buildQuery
static BaseJob::Query buildQuery()
Definition: joining.cpp:15
third_party_signed.hpp
Kazv::Api::JoinRoomByIdJob::JobResponse::success
bool success() const
Definition: joining.cpp:80
Kazv::Api
Definition: location.hpp:10
Kazv::Api::JoinRoomByIdJob::JobResponse::JobResponse
JobResponse(Response r)
Definition: joining.cpp:77
Kazv::Api::JoinRoomByIdJob::needsAuth
static constexpr auto needsAuth()
Definition: joining.hpp:51
basejob.hpp
Kazv::JsonWrap
Definition: jsonwrap.hpp:22
Kazv::Api::JoinRoomByIdJob
Start the requesting user participating in a particular room.
Definition: joining.hpp:28
Kazv::BaseJob
Definition: basejob.hpp:76
Kazv::Api::JoinRoomJob
Start the requesting user participating in a particular room.
Definition: joining.hpp:113
Kazv::Api::JoinRoomByIdJob::withData
JoinRoomByIdJob withData(JsonWrap j) &&
Definition: joining.cpp:63
Kazv::BaseJob::Body
::Kazv::Body Body
Definition: basejob.hpp:100
Kazv::Api::JoinRoomByIdJob::JobResponse::roomId
std::string roomId() const
The joined room ID.
Definition: joining.cpp:91
Kazv::Api::JoinRoomJob::needsAuth
static constexpr auto needsAuth()
Definition: joining.hpp:134
Kazv::Response
Definition: basejob.hpp:50
Kazv::Api::JoinRoomByIdJob::JobResponse
Definition: joining.hpp:35