diff options
author | Alexey Rusakov <Kitsune-Ral@users.sf.net> | 2021-07-10 20:43:09 +0200 |
---|---|---|
committer | Alexey Rusakov <Kitsune-Ral@users.sf.net> | 2021-07-10 20:43:09 +0200 |
commit | 90a5ad87ac455d1d1eb6401824312b28a318fddb (patch) | |
tree | d006483f6c5c91b042f566fe210bb9f6732df55e /lib/csapi/third_party_membership.h | |
parent | b04ff258cc60687fadf0129eba0be2071f0da00c (diff) | |
parent | 32d6616677bc4a94554527110e8d227aaf3aea34 (diff) | |
download | libquotient-90a5ad87ac455d1d1eb6401824312b28a318fddb.tar.gz libquotient-90a5ad87ac455d1d1eb6401824312b28a318fddb.zip |
Merge branch '0.6.x' into kitsune-fix-read-receipts-and-markers-0.6
Diffstat (limited to 'lib/csapi/third_party_membership.h')
-rw-r--r-- | lib/csapi/third_party_membership.h | 15 |
1 files changed, 6 insertions, 9 deletions
diff --git a/lib/csapi/third_party_membership.h b/lib/csapi/third_party_membership.h index 55cab370..a424678f 100644 --- a/lib/csapi/third_party_membership.h +++ b/lib/csapi/third_party_membership.h @@ -10,14 +10,13 @@ namespace Quotient { /*! \brief Invite a user to participate in a particular room. * - * .. _invite-by-third-party-id-endpoint: - * * *Note that there are two forms of this API, which are documented separately. * This version of the API does not require that the inviter know the Matrix * identifier of the invitee, and instead relies on third party identifiers. * The homeserver uses an identity server to perform the mapping from * third party identifier to a Matrix identifier. The other is documented in - * the* `joining rooms section`_. + * the* [joining rooms + * section](/client-server-api/#post_matrixclientr0roomsroomidinvite). * * This API invites a user to participate in a particular room. * They do not start participating in the room until they actually join the @@ -27,7 +26,7 @@ namespace Quotient { * join that room. * * If the identity server did know the Matrix user identifier for the - * third party identifier, the homeserver will append a ``m.room.member`` + * third party identifier, the homeserver will append a `m.room.member` * event to the room. * * If the identity server does not know a Matrix user identifier for the @@ -35,7 +34,7 @@ namespace Quotient { * which can be accepted upon providing proof of ownership of the third * party identifier. This is achieved by the identity server generating a * token, which it gives to the inviting homeserver. The homeserver will - * add an ``m.room.third_party_invite`` event into the graph for the room, + * add an `m.room.third_party_invite` event into the graph for the room, * containing that token. * * When the invitee binds the invited third party identifier to a Matrix @@ -51,9 +50,7 @@ namespace Quotient { * - The matrix user ID who invited them to the room * * If a token is requested from the identity server, the homeserver will - * append a ``m.room.third_party_invite`` event to the room. - * - * .. _joining rooms section: `invite-by-user-id-endpoint`_ + * append a `m.room.third_party_invite` event to the room. */ class InviteBy3PIDJob : public BaseJob { public: @@ -73,7 +70,7 @@ public: * * \param medium * The kind of address being passed in the address field, for example - * ``email``. + * `email`. * * \param address * The invitee's third party identifier. |