WebAuthFlowDetails constructor

WebAuthFlowDetails({
  1. required String url,
  2. bool? interactive,
  3. bool? abortOnLoadForNonInteractive,
  4. int? timeoutMsForNonInteractive,
})

Implementation

WebAuthFlowDetails({
  /// The URL that initiates the auth flow.
  required String url,

  /// Whether to launch auth flow in interactive mode.
  ///
  /// Since some auth flows may immediately redirect to a result URL,
  /// `launchWebAuthFlow` hides its web view until the first
  /// navigation either redirects to the final URL, or finishes loading a page
  /// meant to be displayed.
  ///
  /// If the `interactive` flag is `true`, the window
  /// will be displayed when a page load completes. If the flag is
  /// `false` or omitted, `launchWebAuthFlow` will return
  /// with an error if the initial navigation does not complete the flow.
  ///
  /// For flows that use JavaScript for redirection,
  /// `abortOnLoadForNonInteractive` can be set to `false`
  /// in combination with setting `timeoutMsForNonInteractive` to give
  /// the page a chance to perform any redirects.
  bool? interactive,

  /// Whether to terminate `launchWebAuthFlow` for non-interactive
  /// requests after the page loads. This parameter does not affect
  /// interactive
  /// flows.
  ///
  /// When set to `true` (default) the flow will terminate
  /// immediately after the page loads. When set to `false`, the
  /// flow will only terminate after the
  /// `timeoutMsForNonInteractive` passes. This is useful for
  /// identity providers that use JavaScript to perform redirections after the
  /// page loads.
  bool? abortOnLoadForNonInteractive,

  /// The maximum amount of time, in miliseconds,
  /// `launchWebAuthFlow` is allowed to run in non-interactive mode
  /// in total. Only has an effect if `interactive` is
  /// `false`.
  int? timeoutMsForNonInteractive,
}) : _wrapped = $js.WebAuthFlowDetails(
        url: url,
        interactive: interactive,
        abortOnLoadForNonInteractive: abortOnLoadForNonInteractive,
        timeoutMsForNonInteractive: timeoutMsForNonInteractive,
      );