PaywallView class

View that displays the paywall in full screen mode. Not supported in macOS currently.

offering (Optional) The offering object to be displayed in the paywall. Obtained from Purchases.getOfferings.

displayCloseButton (Optional) Whether to display a close button in the paywall. Defaults to false.

onPurchaseStarted (Optional) Callback that gets called when a purchase is started.

onPurchaseCompleted (Optional) Callback that gets called when a purchase is completed.

onPurchaseError (Optional) Callback that gets called when a purchase fails.

onRestoreCompleted (Optional) Callback that gets called when a restore is completed. Note that this may get called even if no entitlements have been granted in case no relevant purchases were found.

onRestoreError (Optional) Callback that gets called when a restore fails.

onDismiss (Optional) Callback that gets called when the paywall wants to dismiss. Currently, after a purchase is completed or when the close button is tapped.

Inheritance

Constructors

PaywallView({Key? key, Offering? offering, bool? displayCloseButton, dynamic onPurchaseStarted(Package rcPackage)?, dynamic onPurchaseCompleted(CustomerInfo customerInfo, StoreTransaction storeTransaction)?, dynamic onPurchaseError(PurchasesError)?, dynamic onRestoreCompleted(CustomerInfo customerInfo)?, dynamic onRestoreError(PurchasesError)?, dynamic onDismiss()?})
const

Properties

displayCloseButton → bool?
final
hashCode → int
The hash code for this object.
no setterinherited
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
offering → Offering?
final
onDismiss → dynamic Function()?
final
onPurchaseCompleted → dynamic Function(CustomerInfo customerInfo, StoreTransaction storeTransaction)?
final
onPurchaseError → dynamic Function(PurchasesError)?
final
onPurchaseStarted → dynamic Function(Package rcPackage)?
final
onRestoreCompleted → dynamic Function(CustomerInfo customerInfo)?
final
onRestoreError → dynamic Function(PurchasesError)?
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() → StatelessElement
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}) → 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