diff options
author | Kitsune Ral <Kitsune-Ral@users.sf.net> | 2020-06-19 15:01:33 +0200 |
---|---|---|
committer | Kitsune Ral <Kitsune-Ral@users.sf.net> | 2020-06-19 15:03:24 +0200 |
commit | e17764a1ae81393968dfb747c7b67353c109bc71 (patch) | |
tree | bbff0707ae3622e22c67d0cc310370eb5126ac7e /lib/csapi/login.h | |
parent | cbd107e595bbb78ef3411a4a92f66d495c6fc5b4 (diff) | |
download | libquotient-e17764a1ae81393968dfb747c7b67353c109bc71.tar.gz libquotient-e17764a1ae81393968dfb747c7b67353c109bc71.zip |
csapi/: generated using the latest GTAD and matrix-doc
For matrix-doc, specifically, it is master (5cb4b086) merged with
https://github.com/matrix-org/matrix-doc/pull/2518.
Diffstat (limited to 'lib/csapi/login.h')
-rw-r--r-- | lib/csapi/login.h | 14 |
1 files changed, 11 insertions, 3 deletions
diff --git a/lib/csapi/login.h b/lib/csapi/login.h index 0483b77c..a406fc79 100644 --- a/lib/csapi/login.h +++ b/lib/csapi/login.h @@ -76,12 +76,20 @@ class LoginJob : public BaseJob { public: /*! \brief Authenticates the user. * - * * \param type * The login type being used. * * \param identifier - * Identification information for the user. + * Authenticates the user, and issues an access token they can + * use to authorize themself in subsequent requests. + * + * If the client does not supply a ``device_id``, the server must + * auto-generate one. + * + * The returned access token must be associated with the ``device_id`` + * supplied by the client or generated by the server. The server may + * invalidate any access token previously associated with that device. See + * `Relationship between access tokens and devices`_. * * \param password * Required when ``type`` is ``m.login.password``. The user's @@ -108,7 +116,7 @@ public: // Result properties - /// The fully-qualified Matrix ID that has been registered. + /// The fully-qualified Matrix ID for the account. QString userId() const { return loadFromJson<QString>("user_id"_ls); } /// An access token for the account. |