1/******************************************************************************
2 * THIS FILE IS GENERATED - ANY EDITS WILL BE OVERWRITTEN
3 */
4
5#pragma once
6
7#include <Quotient/jobs/basejob.h>
8
9namespace Quotient {
10
11/*! \brief Invite a user to participate in a particular room.
12 *
13 * *Note that there are two forms of this API, which are documented separately.
14 * This version of the API requires that the inviter knows the Matrix
15 * identifier of the invitee. The other is documented in the
16 * [third-party invites](/client-server-api/#third-party-invites) section.*
17 *
18 * This API invites a user to participate in a particular room.
19 * They do not start participating in the room until they actually join the
20 * room.
21 *
22 * Only users currently in a particular room can invite other users to
23 * join that room.
24 *
25 * If the user was invited to the room, the homeserver will append a
26 * `m.room.member` event to the room.
27 */
28class QUOTIENT_API InviteUserJob : public BaseJob {
29public:
30 /*! \brief Invite a user to participate in a particular room.
31 *
32 * \param roomId
33 * The room identifier (not alias) to which to invite the user.
34 *
35 * \param userId
36 * The fully qualified user ID of the invitee.
37 *
38 * \param reason
39 * Optional reason to be included as the `reason` on the subsequent
40 * membership event.
41 */
42 explicit InviteUserJob(const QString& roomId, const QString& userId,
43 const QString& reason = {});
44};
45
46} // namespace Quotient
47