1
0
mirror of https://github.com/matrix-org/matrix-js-sdk.git synced 2025-11-26 17:03:12 +03:00

Comment why we choose flows

This commit is contained in:
David Baker
2017-03-01 16:07:31 +00:00
parent d7216f44f5
commit 7dbe852606

View File

@@ -300,6 +300,14 @@ InteractiveAuth.prototype = {
/**
* Pick one of the flows from the returned list
* If a flow using all of the inputs is found, it will
* be returned, otherwise, null will be returned.
*
* Only flows using all given inputs are chosen because it
* is likley to be surprising if the user provides a
* credential and it is not used. For example, for registration,
* this could result in the email not being used which would leave
* the account with no means to reset a password.
*
* @private
* @return {object} flow