wholetrans/docs-matrix-spec
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Clarify arguments of window.matrixLogin.onLogin (#1905)

Browse source
This commit is contained in:
Johannes Marbach 2024-07-08 13:51:27 +02:00 • committed by GitHub
parent e53e6ea876
commit 5abc31111f
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 5 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

1
changelogs/client_server/newsfragments/1905.clarification Normal file
View file

@ -0,0 +1 @@
Clarify that `window.matrixLogin.onLogin` is called with the response body of `POST /_matrix/client/v3/login`.

5
content/client-server-api/_index.md
View file

@ -1401,7 +1401,10 @@ fallback login API:
This returns an HTML and JavaScript page which can perform the entire This returns an HTML and JavaScript page which can perform the entire
login process. The page will attempt to call the JavaScript function login process. The page will attempt to call the JavaScript function
`window.matrixLogin.onLogin` when login has been successfully completed. `window.matrixLogin.onLogin(response)` when login has been successfully
completed. The argument, `response`, is the JSON response body of
[`POST /_matrix/client/v3/login`](#post_matrixclientv3login) parsed
into a JavaScript object.
{{% added-in v="1.1" %}} Non-credential parameters valid for the `/login` {{% added-in v="1.1" %}} Non-credential parameters valid for the `/login`
endpoint can be provided as query string parameters here. These are to be endpoint can be provided as query string parameters here. These are to be