ConfirmSetupOptions class abstract

Available extensions
Annotations
  • @freezed

Constructors

ConfirmSetupOptions({@ElementsConverter.new() required Elements elements, String? clientSecret, required ConfirmSetupParams confirmParams, SetupConfirmationRedirect? redirect})
const
factory
ConfirmSetupOptions.fromJson(Map<String, dynamic> json)
factory

Properties

clientSecret → String?
Required if you collect payment details before creating an Intent. It's always required if you don't provide an elements instance containing a client secret.
no setterinherited
confirmParams → ConfirmSetupParams
Parameters that will be passed on to the Stripe API. Refer to the Payment Intents API for a full list of parameters.
no setterinherited
copyWith → $ConfirmSetupOptionsCopyWith<ConfirmSetupOptions>
Create a copy of ConfirmSetupOptions with the given fields replaced by the non-null parameter values.
no setterinherited
elements → Elements
Required if you collect payment details before creating an Intent. It's always required if you don't provide a clientSecret.
no setterinherited
hashCode → int
The hash code for this object.
no setterinherited
redirect → SetupConfirmationRedirect?
By default, stripe.confirmSetup will always redirect to your return_url after a successful confirmation. If you set redirect: "if_required", then stripe.confirmSetup will only redirect if your user chooses a redirect-based payment method. Note: Setting if_required requires that you handle successful confirmations for redirect-based and non-redirect based payment methods separately. When a non-redirect based payment method is successfully confirmed, stripe.confirmSetup will resolve with a {setupIntent} object.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

map<TResult extends Object?>(TResult $default(_ConfirmSetupOptions value)) → TResult

Available on ConfirmSetupOptions, provided by the ConfirmSetupOptionsPatterns extension

A switch-like method, using callbacks.
mapOrNull<TResult extends Object?>(TResult? $default(_ConfirmSetupOptions value)?) → TResult?

Available on ConfirmSetupOptions, provided by the ConfirmSetupOptionsPatterns extension

A variant of map that fallback to returning null.
maybeMap<TResult extends Object?>(TResult $default(_ConfirmSetupOptions value)?, {required TResult orElse()}) → TResult

Available on ConfirmSetupOptions, provided by the ConfirmSetupOptionsPatterns extension

A variant of map that fallback to returning orElse.
maybeWhen<TResult extends Object?>(TResult $default(Elements elements, String? clientSecret, ConfirmSetupParams confirmParams, SetupConfirmationRedirect? redirect)?, {required TResult orElse()}) → TResult

Available on ConfirmSetupOptions, provided by the ConfirmSetupOptionsPatterns extension

A variant of when that fallback to an orElse callback.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toJson() → Map<String, dynamic>
Serializes this ConfirmSetupOptions to a JSON map.
inherited
toString() → String
A string representation of this object.
inherited
when<TResult extends Object?>(TResult $default(Elements elements, String? clientSecret, ConfirmSetupParams confirmParams, SetupConfirmationRedirect? redirect)) → TResult

Available on ConfirmSetupOptions, provided by the ConfirmSetupOptionsPatterns extension

A switch-like method, using callbacks.
whenOrNull<TResult extends Object?>(TResult? $default(Elements elements, String? clientSecret, ConfirmSetupParams confirmParams, SetupConfirmationRedirect? redirect)?) → TResult?

Available on ConfirmSetupOptions, provided by the ConfirmSetupOptionsPatterns extension

A variant of when that fallback to returning null

Operators

operator ==(Object other) → bool
The equality operator.
inherited