Page MenuHomePhorge
Files F7892121

joining.hpp
No OneTemporary
Actions

Size
5 KB
Referenced Files
None
Subscribers
None

joining.hpp
View Options

/******************************************************************************
* THIS FILE IS GENERATED - ANY EDITS WILL BE OVERWRITTEN
*/
#pragma once
#include "basejob.hpp"
#include "csapi/definitions/third_party_signed.hpp"
namespace Kazv::Api {
/*! \brief Start the requesting user participating in a particular room.
*
* *Note that this API requires a room ID, not alias.*
* `/join/{roomIdOrAlias}` *exists if you have a room alias.*
*
* This API starts a user participating in a particular room, if that user
* is allowed to participate in that room. After this call, the client is
* allowed to see all current state events in the room, and all subsequent
* events associated with the room until the user leaves the room.
*
* After a user has joined a room, the room will appear as an entry in the
* response of the [`/initialSync`](/client-server-api/#get_matrixclientv3initialsync)
* and [`/sync`](/client-server-api/#get_matrixclientv3sync) APIs.
*/
class JoinRoomByIdJob : public BaseJob {
public:
class JobResponse : public Response
{
public:
JobResponse(Response r);
bool success() const;
// Result properties
/// The joined room ID.
std::string roomId() const;
};
static constexpr auto needsAuth() {
return true
;
}
// Construction/destruction
/*! \brief Start the requesting user participating in a particular room.
*
* \param roomId
* The room identifier (not alias) to join.
*
* \param thirdPartySigned
* If supplied, the homeserver must verify that it matches a pending
* `m.room.third_party_invite` event in the room, and perform
* key validity checking if required by the event.
*
* \param reason
* Optional reason to be included as the `reason` on the subsequent
* membership event.
*/
explicit JoinRoomByIdJob(std::string serverUrl
, std::string _accessToken
,
std::string roomId , std::optional<ThirdPartySigned> thirdPartySigned = std::nullopt, std::optional<std::string> reason = std::nullopt
);
static BaseJob::Query buildQuery(
);
static BaseJob::Body buildBody(std::string roomId, std::optional<ThirdPartySigned> thirdPartySigned, std::optional<std::string> reason);
JoinRoomByIdJob withData(JsonWrap j) &&;
JoinRoomByIdJob withData(JsonWrap j) const &;
};
using JoinRoomByIdResponse = JoinRoomByIdJob::JobResponse;
}
namespace nlohmann
{
using namespace Kazv;
using namespace Kazv::Api;
}
namespace Kazv::Api
{
/*! \brief Start the requesting user participating in a particular room.
*
* *Note that this API takes either a room ID or alias, unlike* `/room/{roomId}/join`.
*
* This API starts a user participating in a particular room, if that user
* is allowed to participate in that room. After this call, the client is
* allowed to see all current state events in the room, and all subsequent
* events associated with the room until the user leaves the room.
*
* After a user has joined a room, the room will appear as an entry in the
* response of the [`/initialSync`](/client-server-api/#get_matrixclientv3initialsync)
* and [`/sync`](/client-server-api/#get_matrixclientv3sync) APIs.
*/
class JoinRoomJob : public BaseJob {
public:
class JobResponse : public Response
{
public:
JobResponse(Response r);
bool success() const;
// Result properties
/// The joined room ID.
std::string roomId() const;
};
static constexpr auto needsAuth() {
return true
;
}
// Construction/destruction
/*! \brief Start the requesting user participating in a particular room.
*
* \param roomIdOrAlias
* The room identifier or alias to join.
*
* \param serverName
* The servers to attempt to join the room through. One of the servers
* must be participating in the room.
*
* \param thirdPartySigned
* If a `third_party_signed` was supplied, the homeserver must verify
* that it matches a pending `m.room.third_party_invite` event in the
* room, and perform key validity checking if required by the event.
*
* \param reason
* Optional reason to be included as the `reason` on the subsequent
* membership event.
*/
explicit JoinRoomJob(std::string serverUrl
, std::string _accessToken
,
std::string roomIdOrAlias , immer::array<std::string> serverName = {}, std::optional<ThirdPartySigned> thirdPartySigned = std::nullopt, std::optional<std::string> reason = std::nullopt
);
static BaseJob::Query buildQuery(
immer::array<std::string> serverName);
static BaseJob::Body buildBody(std::string roomIdOrAlias, immer::array<std::string> serverName, std::optional<ThirdPartySigned> thirdPartySigned, std::optional<std::string> reason);
JoinRoomJob withData(JsonWrap j) &&;
JoinRoomJob withData(JsonWrap j) const &;
};
using JoinRoomResponse = JoinRoomJob::JobResponse;
}
namespace nlohmann
{
using namespace Kazv;
using namespace Kazv::Api;
}
namespace Kazv::Api
{
} // namespace Kazv::Api

File Metadata

Mime Type
text/x-c++
Expires
Thu, Oct 2, 4:13 AM (11 h, 51 m)
Storage Engine
blob
Storage Format
Raw Data
Storage Handle
475867
Default Alt Text
joining.hpp (5 KB)

Event Timeline