Page MenuHomePhorge
Files F7892925

inviting.hpp
No OneTemporary
Actions

Size
2 KB
Referenced Files
None
Subscribers
None

inviting.hpp
View Options

/******************************************************************************
* THIS FILE IS GENERATED - ANY EDITS WILL BE OVERWRITTEN
*/
#pragma once
#include "basejob.hpp"
namespace Kazv {
/*! \brief Invite a user to participate in a particular room.
*
* .. _invite-by-user-id-endpoint:
*
* *Note that there are two forms of this API, which are documented separately.
* This version of the API requires that the inviter knows the Matrix
* identifier of the invitee. The other is documented in the*
* `third party invites section`_.
*
* This API invites a user to participate in a particular room.
* They do not start participating in the room until they actually join the
* room.
*
* Only users currently in a particular room can invite other users to
* join that room.
*
* If the user was invited to the room, the homeserver will append a
* ``m.room.member`` event to the room.
*
* .. _third party invites section: `invite-by-third-party-id-endpoint`_
*/
class InviteUserJob : public BaseJob {
public:
class JobResponse : public Response
{
public:
JobResponse(Response r);
bool success() const;
};
static constexpr auto needsAuth() {
return true
;
}
// Construction/destruction
/*! \brief Invite a user to participate in a particular room.
*
* \param roomId
* The room identifier (not alias) to which to invite the user.
*
* \param userId
* The fully qualified user ID of the invitee.
*/
explicit InviteUserJob(std::string serverUrl
, std::string _accessToken
,
std::string roomId , std::string userId );
static BaseJob::Query buildQuery(
);
static BaseJob::Body buildBody(std::string roomId, std::string userId);
InviteUserJob withData(JsonWrap j) &&;
InviteUserJob withData(JsonWrap j) const &;
};
using InviteUserResponse = InviteUserJob::JobResponse;
}
namespace nlohmann
{
using namespace Kazv;
}
namespace Kazv
{
} // namespace Kazv

File Metadata

Mime Type
text/x-c++
Expires
Thu, Oct 2, 4:42 AM (1 d, 16 h)
Storage Engine
blob
Storage Format
Raw Data
Storage Handle
479006
Default Alt Text
inviting.hpp (2 KB)

Event Timeline