SoftwarePay class
SoftwarePay provides a widget that handles the payment process. It allows you to customize the payment methods, icons, and success callbacks.
- Inheritance
-
- Object
- DiagnosticableTree
- Widget
- StatelessWidget
- SoftwarePay
Constructors
-
SoftwarePay({Key? key, required String apiKey, required String operationId, required Widget organizationLogo, Map<
PaymentMethodTypes, FutureOr< ? customHandlers, Map<void> Function()>PaymentMethodTypes, String> ? customIcons, Widget inputBuilder(VoidCallback open)?, FutureOr<void> onPaymentSuccess()?}) -
Constructor for SoftwarePay.
const
Properties
- apiKey → String
-
The API key required to authenticate the payment process.
final
-
customHandlers
→ Map<
PaymentMethodTypes, FutureOr< ?void> Function()> -
Optional map to override the default behavior of specific payment methods.
The keys are PaymentMethodTypes and the values are the custom callback functions.
final
-
customIcons
→ Map<
PaymentMethodTypes, String> ? -
Optional map to provide custom icons for each payment method type.
The keys are PaymentMethodTypes and the values are the paths to the custom icons.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- inputBuilder → Widget Function(VoidCallback open)?
-
Optional function to build a custom input widget for the payment process.
open
is the callback to open the payment sheet.final - key → Key?
-
Controls how one widget replaces another widget in the tree.
finalinherited
-
onPaymentSuccess
→ FutureOr<
void> Function()? -
Optional callback to be triggered upon successful payment.
final
- operationId → String
-
The operation ID associated with the current payment session.
final
- organizationLogo → Widget
-
The logo of the organization processing the payment.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
build(
BuildContext context) → Widget -
Describes the part of the user interface represented by this widget.
override
-
createElement(
) → _StatelessHookElement -
Creates a StatelessElement to manage this widget's location in the tree.
inherited
-
debugDescribeChildren(
) → List< DiagnosticsNode> -
Returns a list of DiagnosticsNode objects describing this node's
children.
inherited
-
debugFillProperties(
DiagnosticPropertiesBuilder properties) → void -
Add additional properties associated with the node.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toDiagnosticsNode(
{String? name, DiagnosticsTreeStyle? style}) → DiagnosticsNode -
Returns a debug representation of the object that is used by debugging
tools and by DiagnosticsNode.toStringDeep.
inherited
-
toString(
{DiagnosticLevel minLevel = DiagnosticLevel.info}) → String -
A string representation of this object.
inherited
-
toStringDeep(
{String prefixLineOne = '', String? prefixOtherLines, DiagnosticLevel minLevel = DiagnosticLevel.debug, int wrapWidth = 65}) → String -
Returns a string representation of this node and its descendants.
inherited
-
toStringShallow(
{String joiner = ', ', DiagnosticLevel minLevel = DiagnosticLevel.debug}) → String -
Returns a one-line detailed description of the object.
inherited
-
toStringShort(
) → String -
A short, textual description of this widget.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Static Methods
-
show(
BuildContext context, {required String apiKey, Map< PaymentMethodTypes, FutureOr< ? customHandlers, required String operationId, required Widget organizationLogo, FutureOr<void> Function()>void> onPaymentSuccess()?, Map<PaymentMethodTypes, String> ? customIcons}) → void -
Displays the
SoftwarePayBody
modal sheet to start the payment process.