the return type of the request when it is successful
get the client secret used for validation sessions with the identity server.
client secret
Gets the sid for the email validation session Specific to m.login.email.identity
The sid of the email auth session
get the auth session ID
session id
get the server params for a given stage
login type for the stage
any parameters from the server for this stage
Poll to check if the auth session or current stage has been completed out-of-band. If so, the attemptAuth promise will be resolved.
Requests a new email token and sets the email sid for the validation session
Sets the sid for the email validation session This must be set in order to successfully poll for completion of the email validation. Specific to m.login.email.identity
The sid for the email validation session
submit a new auth dict and fire off the request. This will either make attemptAuth resolve/reject, or cause the startAuthStage callback to be called for a new stage.
new auth dict to send to the server. Should
include a type property denoting the login type, as well as any
other params for that stage.
If true, this request failing will not result in the attemptAuth promise being rejected. This can be set to true for requests that just poll to see if auth has been completed elsewhere.
Abstracts the logic used to drive the interactive auth process.
Components implementing an interactive auth flow should instantiate one of these, passing in the necessary callbacks to the constructor. They should then call attemptAuth, which will return a promise which will resolve or reject when the interactive-auth process completes.
Meanwhile, calls will be made to the startAuthStage and doRequest callbacks, and information gathered from the user can be submitted with submitAuthDict.
Param: opts
options object