diff options
Diffstat (limited to 'lib/csapi/third_party_membership.h')
| -rw-r--r-- | lib/csapi/third_party_membership.h | 21 |
1 files changed, 16 insertions, 5 deletions
diff --git a/lib/csapi/third_party_membership.h b/lib/csapi/third_party_membership.h index c85e8ab4..f8196f6f 100644 --- a/lib/csapi/third_party_membership.h +++ b/lib/csapi/third_party_membership.h @@ -8,8 +8,6 @@ namespace Quotient { -// Operations - /*! \brief Invite a user to participate in a particular room. * * .. _invite-by-third-party-id-endpoint: @@ -61,15 +59,28 @@ class InviteBy3PIDJob : public BaseJob { public: /*! \brief Invite a user to participate in a particular room. * + * * \param roomId * The room identifier (not alias) to which to invite the user. + * * \param idServer * The hostname+port of the identity server which should be used for third - * party identifier lookups. \param medium The kind of address being passed - * in the address field, for example ``email``. \param address The invitee's - * third party identifier. + * party identifier lookups. + * + * \param idAccessToken + * An access token previously registered with the identity server. Servers + * can treat this as optional to distinguish between r0.5-compatible + * clients and this specification version. + * + * \param medium + * The kind of address being passed in the address field, for example + * ``email``. + * + * \param address + * The invitee's third party identifier. */ explicit InviteBy3PIDJob(const QString& roomId, const QString& idServer, + const QString& idAccessToken, const QString& medium, const QString& address); }; |