aboutsummaryrefslogtreecommitdiff
path: root/lib/csapi/inviting.h
diff options
context:
space:
mode:
authorAlexey Rusakov <Kitsune-Ral@users.sf.net>2021-06-23 19:12:38 +0200
committerAlexey Rusakov <Kitsune-Ral@users.sf.net>2021-06-23 19:12:38 +0200
commit0d4315008374d9a4dfb11f934875b1a16670ec74 (patch)
tree4327eecbf44d79152ac02a37c64bab402b22a8af /lib/csapi/inviting.h
parent65e6ecd9711372e1e2afde769967ee46b3920307 (diff)
downloadlibquotient-0d4315008374d9a4dfb11f934875b1a16670ec74.tar.gz
libquotient-0d4315008374d9a4dfb11f934875b1a16670ec74.zip
Re-generate API files
Diffstat (limited to 'lib/csapi/inviting.h')
-rw-r--r--lib/csapi/inviting.h16
1 files changed, 9 insertions, 7 deletions
diff --git a/lib/csapi/inviting.h b/lib/csapi/inviting.h
index 59a61b89..eb13cc95 100644
--- a/lib/csapi/inviting.h
+++ b/lib/csapi/inviting.h
@@ -10,12 +10,11 @@ namespace Quotient {
/*! \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`_.
+ * [third party invites
+ * section](/client-server-api/#post_matrixclientr0roomsroomidinvite-1).
*
* This API invites a user to participate in a particular room.
* They do not start participating in the room until they actually join the
@@ -25,9 +24,7 @@ namespace Quotient {
* 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`_
+ * `m.room.member` event to the room.
*/
class InviteUserJob : public BaseJob {
public:
@@ -38,8 +35,13 @@ public:
*
* \param userId
* The fully qualified user ID of the invitee.
+ *
+ * \param reason
+ * Optional reason to be included as the `reason` on the subsequent
+ * membership event.
*/
- explicit InviteUserJob(const QString& roomId, const QString& userId);
+ explicit InviteUserJob(const QString& roomId, const QString& userId,
+ const QString& reason = {});
};
} // namespace Quotient