PlatformPayWebPaymentRequestCreateOptions class abstract

Available extensions

• PlatformPayWebPaymentRequestCreateOptionsPatterns

Annotations

• @freezed

Constructors

PlatformPayWebPaymentRequestCreateOptions({required String country, required String currency, required PlatformPayWebPaymentItem total, @Default.new([]) List<PlatformPayWebPaymentItem> displayItems, @Default.new(false) bool requestPayerName, @Default.new(false) bool requestPayerEmail, @Default.new(false) bool requestPayerPhone, @Default.new(false) bool requestShipping, @Default.new([]) List<PlatformPayWebShippingOption> shippingOptions, @Default.new([]) List<PlatformPayWebWalletType> disableWallets})

const

factory

PlatformPayWebPaymentRequestCreateOptions.fromJson(Map<String, dynamic> json)

factory

Properties

copyWith → $PlatformPayWebPaymentRequestCreateOptionsCopyWith<PlatformPayWebPaymentRequestCreateOptions>

Create a copy of PlatformPayWebPaymentRequestCreateOptions with the given fields replaced by the non-null parameter values.

no setter, inherited

country → String

The two-letter country code of your Stripe account (e.g., US).

no setter, inherited

currency → String

Three character currency code (e.g., usd).

no setter, inherited

disableWallets → List<PlatformPayWebWalletType>

An array of wallet strings. Can be one or more of applePay, googlePay, link, and browserCard. Use this option to disable Apple Pay, Google Pay, Link, and/or browser-saved cards.

no setter, inherited

displayItems → List<PlatformPayWebPaymentItem>

An array of PaymentItem objects. These objects are shown as line items in the browser’s payment interface. Note that the sum of the line item amounts does not need to add up to the total amount above.

no setter, inherited

hashCode → int

The hash code for this object.

no setter, inherited

requestPayerEmail → bool

See the requestPayerName option.

no setter, inherited

requestPayerName → bool

By default, the browser‘s payment interface only asks the customer for actual payment information. A customer name can be collected by setting this option to true. This collected name will appears in the PaymentResponse object.

no setter, inherited

requestPayerPhone → bool

See the requestPayerName option.

no setter, inherited

requestShipping → bool

Collect shipping address by setting this option to true. The address appears in the PaymentResponse.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

shippingOptions → List<PlatformPayWebShippingOption>

An array of ShippingOption objects. The first shipping option listed appears in the browser payment interface as the default option.

no setter, inherited

total → PlatformPayWebPaymentItem

A PaymentItem object. This PaymentItem is shown to the customer in the browser’s payment interface.

no setter, inherited

Methods

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

Available on PlatformPayWebPaymentRequestCreateOptions, provided by the PlatformPayWebPaymentRequestCreateOptionsPatterns extension

A switch-like method, using callbacks.

mapOrNull<TResult extends Object?>(TResult? $default(_PaymentRequestCreateOptions value)?) → TResult?

Available on PlatformPayWebPaymentRequestCreateOptions, provided by the PlatformPayWebPaymentRequestCreateOptionsPatterns extension

A variant of map that fallback to returning null.

maybeMap<TResult extends Object?>(TResult $default(_PaymentRequestCreateOptions value)?, {required TResult orElse()}) → TResult

Available on PlatformPayWebPaymentRequestCreateOptions, provided by the PlatformPayWebPaymentRequestCreateOptionsPatterns extension

A variant of map that fallback to returning orElse.

maybeWhen<TResult extends Object?>(TResult $default(String country, String currency, PlatformPayWebPaymentItem total, List<PlatformPayWebPaymentItem> displayItems, bool requestPayerName, bool requestPayerEmail, bool requestPayerPhone, bool requestShipping, List<PlatformPayWebShippingOption> shippingOptions, List<PlatformPayWebWalletType> disableWallets)?, {required TResult orElse()}) → TResult

Available on PlatformPayWebPaymentRequestCreateOptions, provided by the PlatformPayWebPaymentRequestCreateOptionsPatterns 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 PlatformPayWebPaymentRequestCreateOptions to a JSON map.

inherited

toString() → String

A string representation of this object.

inherited

when<TResult extends Object?>(TResult $default(String country, String currency, PlatformPayWebPaymentItem total, List<PlatformPayWebPaymentItem> displayItems, bool requestPayerName, bool requestPayerEmail, bool requestPayerPhone, bool requestShipping, List<PlatformPayWebShippingOption> shippingOptions, List<PlatformPayWebWalletType> disableWallets)) → TResult

Available on PlatformPayWebPaymentRequestCreateOptions, provided by the PlatformPayWebPaymentRequestCreateOptionsPatterns extension

A switch-like method, using callbacks.

whenOrNull<TResult extends Object?>(TResult? $default(String country, String currency, PlatformPayWebPaymentItem total, List<PlatformPayWebPaymentItem> displayItems, bool requestPayerName, bool requestPayerEmail, bool requestPayerPhone, bool requestShipping, List<PlatformPayWebShippingOption> shippingOptions, List<PlatformPayWebWalletType> disableWallets)?) → TResult?

Available on PlatformPayWebPaymentRequestCreateOptions, provided by the PlatformPayWebPaymentRequestCreateOptionsPatterns extension

A variant of when that fallback to returning null

Operators

operator ==(Object other) → bool

The equality operator.

inherited

Constants

defaultOptions → const PlatformPayWebPaymentRequestCreateOptions