Page MenuHomePhorge
Files F7889098

banning.hpp
No OneTemporary
Actions

Size
3 KB
Referenced Files
None
Subscribers
None

banning.hpp
View Options

/******************************************************************************
* THIS FILE IS GENERATED - ANY EDITS WILL BE OVERWRITTEN
*/
#pragma once
#include "basejob.hpp"
namespace Kazv::Api {
/*! \brief Ban a user in the room.
*
* Ban a user in the room. If the user is currently in the room, also kick them.
*
* When a user is banned from a room, they may not join it or be invited to it until they are unbanned.
*
* The caller must have the required power level in order to perform this operation.
*/
class BanJob : public BaseJob {
public:
class JobResponse : public Response
{
public:
JobResponse(Response r);
bool success() const;
};
static constexpr auto needsAuth() {
return true
;
}
// Construction/destruction
/*! \brief Ban a user in the room.
*
* \param roomId
* The room identifier (not alias) from which the user should be banned.
*
* \param userId
* The fully qualified user ID of the user being banned.
*
* \param reason
* The reason the user has been banned. This will be supplied as the `reason` on the target's updated [`m.room.member`](/client-server-api/#mroommember) event.
*/
explicit BanJob(std::string serverUrl
, std::string _accessToken
,
std::string roomId , std::string userId , std::optional<std::string> reason = std::nullopt
);
static BaseJob::Query buildQuery(
);
static BaseJob::Body buildBody(std::string roomId, std::string userId, std::optional<std::string> reason);
BanJob withData(JsonWrap j) &&;
BanJob withData(JsonWrap j) const &;
};
using BanResponse = BanJob::JobResponse;
}
namespace nlohmann
{
using namespace Kazv;
using namespace Kazv::Api;
}
namespace Kazv::Api
{
/*! \brief Unban a user from the room.
*
* Unban a user from the room. This allows them to be invited to the room,
* and join if they would otherwise be allowed to join according to its join rules.
*
* The caller must have the required power level in order to perform this operation.
*/
class UnbanJob : public BaseJob {
public:
class JobResponse : public Response
{
public:
JobResponse(Response r);
bool success() const;
};
static constexpr auto needsAuth() {
return true
;
}
// Construction/destruction
/*! \brief Unban a user from the room.
*
* \param roomId
* The room identifier (not alias) from which the user should be unbanned.
*
* \param userId
* The fully qualified user ID of the user being unbanned.
*
* \param reason
* Optional reason to be included as the `reason` on the subsequent
* membership event.
*/
explicit UnbanJob(std::string serverUrl
, std::string _accessToken
,
std::string roomId , std::string userId , std::optional<std::string> reason = std::nullopt
);
static BaseJob::Query buildQuery(
);
static BaseJob::Body buildBody(std::string roomId, std::string userId, std::optional<std::string> reason);
UnbanJob withData(JsonWrap j) &&;
UnbanJob withData(JsonWrap j) const &;
};
using UnbanResponse = UnbanJob::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, 2:20 AM (20 h, 46 m)
Storage Engine
blob
Storage Format
Raw Data
Storage Handle
471966
Default Alt Text
banning.hpp (3 KB)

Event Timeline