Filip/matrix-spec
1
0
Fork 0
mirror of https://github.com/matrix-org/matrix-spec synced 2026-03-23 19:44:09 +01:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Clarify arguments of window.matrixLogin.onLogin

Browse source 
Fixes: #1900
Signed-off-by: Johannes Marbach <n0-0ne+github@mailbox.org>
This commit is contained in:
Johannes Marbach 2024-07-08 09:06:03 +02:00
parent e53e6ea876
commit 174a95f680
1 changed files with 4 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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
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`
endpoint can be provided as query string parameters here. These are to be