From 174a95f680468b03fe321f971ffad4a5cd04088e Mon Sep 17 00:00:00 2001 From: Johannes Marbach Date: Mon, 8 Jul 2024 09:06:03 +0200 Subject: [PATCH 1/2] Clarify arguments of window.matrixLogin.onLogin Fixes: #1900 Signed-off-by: Johannes Marbach --- content/client-server-api/_index.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/content/client-server-api/_index.md b/content/client-server-api/_index.md index be9a23849..a9c813c4c 100644 --- a/content/client-server-api/_index.md +++ b/content/client-server-api/_index.md @@ -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 From 8e630c79aa8603fb025da14a6e5e040b3e89aaae Mon Sep 17 00:00:00 2001 From: Johannes Marbach Date: Mon, 8 Jul 2024 09:08:26 +0200 Subject: [PATCH 2/2] Add changelog --- changelogs/client_server/newsfragments/1905.clarification | 1 + 1 file changed, 1 insertion(+) create mode 100644 changelogs/client_server/newsfragments/1905.clarification diff --git a/changelogs/client_server/newsfragments/1905.clarification b/changelogs/client_server/newsfragments/1905.clarification new file mode 100644 index 000000000..341391dbe --- /dev/null +++ b/changelogs/client_server/newsfragments/1905.clarification @@ -0,0 +1 @@ +Clarify that `window.matrixLogin.onLogin` is called with the response body of `POST /_matrix/client/v3/login`.