Purchases UI Flutter

https://pub.dev/documentation/purchases_ui_flutter/latest
Admin
Purchases UI Flutter allows you to integrate RevenueCat's paywalls and customer center into your...
Tokens:20,406
Snippets:298
Trust Score:9.9
Update:2 months ago
Show doc for...
Tokens:
Raw
### CustomerCenterRefundRequestStarted typedef implementation

Source: https://pub.dev/documentation/purchases_ui_flutter/latest/views_customer_center_view_method_handler/CustomerCenterRefundRequestStarted.html

Defines the callback signature for when a refund request is started, requiring a product identifier string.

```dart
typedef CustomerCenterRefundRequestStarted = void Function(
  String productIdentifier,
);
```

--------------------------------

### Initialize PaywallPresentationConfiguration

Source: https://pub.dev/documentation/purchases_ui_flutter/latest/paywall_presentation_configuration/PaywallPresentationConfiguration/PaywallPresentationConfiguration.html

Use this constructor to specify the presentation styles for iOS and Android platforms.

```dart
const PaywallPresentationConfiguration({this.ios, this.android});
```

--------------------------------

### PaywallPurchaseLogic()

Source: https://pub.dev/documentation/purchases_ui_flutter/latest/purchase_logic/PaywallPurchaseLogic/PaywallPurchaseLogic.html

Initializes a new instance of the PaywallPurchaseLogic class. This is the primary way to create a PaywallPurchaseLogic object.

```APIDOC
## PaywallPurchaseLogic()

### Description
Initializes a new instance of the PaywallPurchaseLogic class.

### Method
Constructor

### Parameters
None

### Request Example
```dart
var paywallLogic = PaywallPurchaseLogic();
```

### Response
#### Success Response (Instance)
- **PaywallPurchaseLogic** (PaywallPurchaseLogic) - A new instance of the PaywallPurchaseLogic class.
```

--------------------------------

### Implement PaywallView build method

Source: https://pub.dev/documentation/purchases_ui_flutter/latest/views_paywall_view/PaywallView/build.html

This method prepares creation parameters from the offering and custom variables, then returns the appropriate platform-specific view.

```dart
@override
Widget build(BuildContext context) {
  final presentedOfferingContext = offering?.availablePackages
      .elementAtOrNull(0)
      ?.presentedOfferingContext;
  final creationParams = <String, dynamic>{
    'offeringIdentifier': offering?.identifier,
    'presentedOfferingContext': presentedOfferingContext?.toJson(),
    'displayCloseButton': displayCloseButton,
    'customVariables': convertCustomVariablesToNative(customVariables),
    'hasPurchaseLogic': purchaseLogic != null,
  };

  return Platform.isAndroid
      ? _buildAndroidPlatformViewLink(creationParams)
      : _buildUiKitView(creationParams);
}
```

--------------------------------

### Implementation of presentCustomerCenter

Source: https://pub.dev/documentation/purchases_ui_flutter/latest/purchases_ui_flutter/RevenueCatUI/presentCustomerCenter.html

This method handles the registration of optional lifecycle callbacks and invokes the native method channel to present the customer center.

```dart
static Future<void> presentCustomerCenter({
  CustomerCenterRestoreStarted? onRestoreStarted,
  CustomerCenterRestoreCompleted? onRestoreCompleted,
  CustomerCenterRestoreFailed? onRestoreFailed,
  CustomerCenterManageSubscriptions? onShowingManageSubscriptions,
  CustomerCenterRefundRequestStarted? onRefundRequestStarted,
  CustomerCenterRefundRequestCompleted? onRefundRequestCompleted,
  CustomerCenterFeedbackSurveyCompleted? onFeedbackSurveyCompleted,
  CustomerCenterManagementOptionSelected? onManagementOptionSelected,
  CustomerCenterCustomActionSelected? onCustomActionSelected,
  CustomerCenterPromotionalOfferSucceeded? onPromotionalOfferSucceeded,
}) async {
  _setMethodChannelHandlerIfNeeded();
  final hasCallbacks = onRestoreStarted != null ||
      onRestoreCompleted != null ||
      onRestoreFailed != null ||
      onShowingManageSubscriptions != null ||
      onRefundRequestStarted != null ||
      onRefundRequestCompleted != null ||
      onFeedbackSurveyCompleted != null ||
      onManagementOptionSelected != null ||
      onCustomActionSelected != null ||
      onPromotionalOfferSucceeded != null;

  await _clearCustomerCenterCallbacks();

  if (hasCallbacks) {
    await _registerCustomerCenterCallbacks(
      onRestoreStarted: onRestoreStarted,
      onRestoreCompleted: onRestoreCompleted,
      onRestoreFailed: onRestoreFailed,
      onShowingManageSubscriptions: onShowingManageSubscriptions,
      onRefundRequestStarted: onRefundRequestStarted,
      onRefundRequestCompleted: onRefundRequestCompleted,
      onFeedbackSurveyCompleted: onFeedbackSurveyCompleted,
      onManagementOptionSelected: onManagementOptionSelected,
      onCustomActionSelected: onCustomActionSelected,
      onPromotionalOfferSucceeded: onPromotionalOfferSucceeded,
    );
  }
  await _methodChannel.invokeMethod('presentCustomerCenter');
}
```

--------------------------------

### Initialize CustomerCenterView

Source: https://pub.dev/documentation/purchases_ui_flutter/latest/views_customer_center_view/CustomerCenterView/CustomerCenterView.html

The constructor allows configuration of the UI visibility and provides optional callbacks for tracking user interactions and subscription management events.

```dart
const CustomerCenterView({
  super.key,
  this.shouldShowCloseButton = true,
  this.onDismiss,
  this.onRestoreStarted,
  this.onRestoreCompleted,
  this.onRestoreFailed,
  this.onShowingManageSubscriptions,
  this.onRefundRequestStarted,
  this.onRefundRequestCompleted,
  this.onFeedbackSurveyCompleted,
  this.onManagementOptionSelected,
  this.onCustomActionSelected,
  this.onPromotionalOfferSucceeded,
});
```

--------------------------------

### PaywallPresentationConfiguration Constructor

Source: https://pub.dev/documentation/purchases_ui_flutter/latest/paywall_presentation_configuration/PaywallPresentationConfiguration-class.html

Initializes a new instance of the PaywallPresentationConfiguration class with optional iOS and Android presentation styles.

```APIDOC
## PaywallPresentationConfiguration

### Description
Configures how a paywall is presented on each platform.

### Parameters
* **ios** (IOSPaywallPresentationStyle?) - Optional iOS-specific presentation style.
* **android** (AndroidPaywallPresentationStyle?) - Optional Android-specific presentation style. Android always presents full screen; this field exists for API symmetry and future use.
```

--------------------------------

### presentCustomerCenter

Source: https://pub.dev/documentation/purchases_ui_flutter/latest/purchases_ui_flutter/RevenueCatUI-class.html

Presents the customer center modally using the native SDKs. Allows for customization of restore and feedback actions.

```APIDOC
## presentCustomerCenter

### Description
Presents the customer center modally using the native SDKs.

### Method
static Future<void> presentCustomerCenter({
  CustomerCenterRestoreStarted? onRestoreStarted,
  CustomerCenterRestoreCompleted? onRestoreCompleted,
  CustomerCenterRestoreFailed? onRestoreFailed,
  CustomerCenterManageSubscriptions? onShowingManageSubscriptions,
  CustomerCenterRefundRequestStarted? onRefundRequestStarted,
  CustomerCenterRefundRequestCompleted? onRefundRequestCompleted,
  CustomerCenterFeedbackSurveyCompleted? onFeedbackSurveyCompleted,
  CustomerCenterManagementOptionSelected? onManagementOptionSelected,
  CustomerCenterCustomActionSelected? onCustomActionSelected,
  CustomerCenterPromotionalOfferSucceeded? onPromotionalOfferSucceeded,
})

### Parameters
- `onRestoreStarted` (CustomerCenterRestoreStarted?) - Callback when a restore operation starts.
- `onRestoreCompleted` (CustomerCenterRestoreCompleted?) - Callback when a restore operation completes successfully.
- `onRestoreFailed` (CustomerCenterRestoreFailed?) - Callback when a restore operation fails.
- `onShowingManageSubscriptions` (CustomerCenterManageSubscriptions?) - Callback when the manage subscriptions view is shown.
- `onRefundRequestStarted` (CustomerCenterRefundRequestStarted?) - Callback when a refund request starts.
- `onRefundRequestCompleted` (CustomerCenterRefundRequestCompleted?) - Callback when a refund request completes successfully.
- `onFeedbackSurveyCompleted` (CustomerCenterFeedbackSurveyCompleted?) - Callback when the feedback survey is completed.
- `onManagementOptionSelected` (CustomerCenterManagementOptionSelected?) - Callback when a management option is selected.
- `onCustomActionSelected` (CustomerCenterCustomActionSelected?) - Callback when a custom action is selected.
- `onPromotionalOfferSucceeded` (CustomerCenterPromotionalOfferSucceeded?) - Callback when a promotional offer succeeds.
```

--------------------------------

### PaywallPresentationConfiguration()

Source: https://pub.dev/documentation/purchases_ui_flutter/latest/paywall_presentation_configuration/PaywallPresentationConfiguration/PaywallPresentationConfiguration.html

Creates a new instance of PaywallPresentationConfiguration with optional platform-specific presentation styles.

```APIDOC
## PaywallPresentationConfiguration()

### Description
Creates a new instance of PaywallPresentationConfiguration to define how paywalls are presented on different platforms.

### Parameters
- **ios** (IOSPaywallPresentationStyle?) - Optional - The presentation style for iOS platforms.
- **android** (AndroidPaywallPresentationStyle?) - Optional - The presentation style for Android platforms.

### Implementation
```dart
const PaywallPresentationConfiguration({this.ios, this.android});
```
```

--------------------------------

### PaywallView Constructor

Source: https://pub.dev/documentation/purchases_ui_flutter/latest/views_paywall_view/PaywallView/PaywallView.html

Initializes a new PaywallView widget with optional configuration for offerings, custom variables, and various purchase-related event callbacks.

```APIDOC
## PaywallView Constructor

### Description
Creates a new instance of the PaywallView widget. This widget handles the display of a paywall and provides hooks for purchase lifecycle events.

### Parameters
- **key** (Key?) - Optional - The widget key.
- **offering** (Offering?) - Optional - The specific offering to display.
- **displayCloseButton** (bool?) - Optional - Whether to show the close button.
- **customVariables** (Map<String, CustomVariableValue>?) - Optional - Custom variables for the paywall.
- **purchaseLogic** (PaywallPurchaseLogic?) - Optional - Custom logic for handling purchases.
- **onPurchaseStarted** (Function(Package)?) - Optional - Callback when a purchase starts.
- **onPurchaseCompleted** (Function(CustomerInfo, StoreTransaction)?) - Optional - Callback when a purchase is successful.
- **onPurchaseCancelled** (Function()?) - Optional - Callback when a purchase is cancelled.
- **onPurchaseError** (Function(PurchasesError)?) - Optional - Callback when a purchase error occurs.
- **onRestoreCompleted** (Function(CustomerInfo)?) - Optional - Callback when a restore is successful.
- **onRestoreError** (Function(PurchasesError)?) - Optional - Callback when a restore error occurs.
- **onDismiss** (Function()?) - Optional - Callback when the view is dismissed.
- **onWebCheckoutOpened** (Function()?) - Optional - Callback when web checkout is opened.
- **onUrlOpened** (Function(String)?) - Optional - Callback when a URL is opened.
```

--------------------------------

### Initialize OriginalTemplatePaywallFooterView

Source: https://pub.dev/documentation/purchases_ui_flutter/latest/views_paywall_footer_view/OriginalTemplatePaywallFooterView/OriginalTemplatePaywallFooterView.html

Constructor definition for the OriginalTemplatePaywallFooterView widget, including optional callbacks for purchase lifecycle events.

```dart
const OriginalTemplatePaywallFooterView({
  Key? key,
  this.offering,
  this.onPurchaseStarted,
  this.onPurchaseCompleted,
  this.onPurchaseCancelled,
  this.onPurchaseError,
  this.onRestoreCompleted,
  this.onRestoreError,
  this.onDismiss,
  required this.contentCreator,
}) : super(key: key);
```

--------------------------------

### onPurchaseStarted

Source: https://pub.dev/documentation/purchases_ui_flutter/latest/views_paywall_footer_view/OriginalTemplatePaywallFooterView/onPurchaseStarted.html

A callback function that is invoked when a purchase is initiated. It accepts a Package object as a parameter.

```APIDOC
## onPurchaseStarted

### Description
A callback function triggered when a purchase process is started. It provides the selected `Package` object to the handler.

### Signature
`dynamic Function(Package rcPackage)? onPurchaseStarted`

### Parameters
- **rcPackage** (Package) - The package selected for purchase.
```

--------------------------------

### OriginalTemplatePaywallFooterView Constructor

Source: https://pub.dev/documentation/purchases_ui_flutter/latest/views_paywall_footer_view/OriginalTemplatePaywallFooterView-class.html

Constructor for OriginalTemplatePaywallFooterView. Allows configuration of various callbacks and content.

```APIDOC
## OriginalTemplatePaywallFooterView

### Description
View that displays the paywall in footer mode. Not supported in macOS currently. Only available for original template paywalls. Ignored for V2 Paywalls.

### Parameters
- **key** (Key?): Controls how one widget replaces another widget in the tree.
- **offering** (Offering?): The offering object to be displayed in the paywall. Obtained from `Purchases.getOfferings`.
- **onPurchaseStarted** (dynamic Function(Package rcPackage)?): Callback that gets called when a purchase is started.
- **onPurchaseCompleted** (dynamic Function(CustomerInfo customerInfo, StoreTransaction storeTransaction)?): Callback that gets called when a purchase is completed.
- **onPurchaseCancelled** (dynamic Function()?): Callback that gets called when a purchase is cancelled.
- **onPurchaseError** (dynamic Function(PurchasesError)?): Callback that gets called when a purchase fails.
- **onRestoreCompleted** (dynamic Function(CustomerInfo customerInfo)?): 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** (dynamic Function(PurchasesError)?): Callback that gets called when a restore fails.
- **onDismiss** (dynamic Function()?): Callback that gets called when the paywall wants to dismiss. Currently, after a purchase is completed.
- **contentCreator** (required Widget Function(double bottomPadding)): A function that creates the content to be displayed above the paywall. Make sure you apply the given padding to the bottom of your content to avoid overlap.
```

--------------------------------

### PaywallPresentationConfiguration Constants

Source: https://pub.dev/documentation/purchases_ui_flutter/latest/paywall_presentation_configuration/PaywallPresentationConfiguration-class.html

Predefined configurations for PaywallPresentationConfiguration.

```APIDOC
## Constants

### defaultConfiguration
- Type: const PaywallPresentationConfiguration
- Description: Default platform behavior (sheet on iOS, full screen on Android).

### fullScreen
- Type: const PaywallPresentationConfiguration
- Description: Full-screen presentation on all platforms.
```

--------------------------------

### Implement build method for CustomerCenterView

Source: https://pub.dev/documentation/purchases_ui_flutter/latest/views_customer_center_view/CustomerCenterView/build.html

This method constructs the widget tree by checking the platform and passing creation parameters to the appropriate platform-specific view builder.

```dart
@override
Widget build(BuildContext context) {
  final creationParams = <String, dynamic>{
    'shouldShowCloseButton': shouldShowCloseButton,
  };

  return Platform.isAndroid
      ? _buildAndroidPlatformViewLink(creationParams)
      : _buildUiKitView(creationParams);
}
```

--------------------------------

### PaywallView Constructor Implementation

Source: https://pub.dev/documentation/purchases_ui_flutter/latest/views_paywall_view/PaywallView/PaywallView.html

The standard constructor for initializing a PaywallView widget with optional callbacks and configuration parameters.

```dart
const PaywallView({
  Key? key,
  this.offering,
  this.displayCloseButton,
  this.customVariables,
  this.purchaseLogic,
  this.onPurchaseStarted,
  this.onPurchaseCompleted,
  this.onPurchaseCancelled,
  this.onPurchaseError,
  this.onRestoreCompleted,
  this.onRestoreError,
  this.onDismiss,
  this.onWebCheckoutOpened,
  this.onUrlOpened,
}) : super(key: key);
```

--------------------------------

### PaywallFooterView Constructor

Source: https://pub.dev/documentation/purchases_ui_flutter/latest/views_paywall_footer_view/PaywallFooterView-class.html

Constructor for the PaywallFooterView class.

```APIDOC
## PaywallFooterView

### Description

Constructor for the PaywallFooterView class.

### Parameters

- **key** (Key?): Controls how one widget replaces another widget in the tree.
- **offering** (Offering?): The offering object to be displayed in the paywall. Obtained from `Purchases.getOfferings`.
- **onPurchaseStarted** (dynamic Function(Package rcPackage)?): Callback that gets called when a purchase is started.
- **onPurchaseCompleted** (dynamic Function(CustomerInfo customerInfo, StoreTransaction storeTransaction)?): Callback that gets called when a purchase is completed.
- **onPurchaseCancelled** (dynamic Function()?): Callback that gets called when a purchase is cancelled.
- **onPurchaseError** (dynamic Function(PurchasesError)?): Callback that gets called when a purchase fails.
- **onRestoreCompleted** (dynamic Function(CustomerInfo customerInfo)?): 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** (dynamic Function(PurchasesError)?): Callback that gets called when a restore fails.
- **onDismiss** (dynamic Function()?): Callback that gets called when the paywall wants to dismiss. Currently, after a purchase is completed.
- **contentCreator** (required Widget Function(double bottomPadding)): A function that creates the content to be displayed above the paywall. Make sure you apply the given padding to the bottom of your content to avoid overlap.
```

--------------------------------

### PaywallPresentationConfiguration Methods

Source: https://pub.dev/documentation/purchases_ui_flutter/latest/paywall_presentation_configuration/PaywallPresentationConfiguration-class.html

Available methods for the PaywallPresentationConfiguration class.

```APIDOC
## Methods

### toString
- Returns: String
- Description: A string representation of this object.
- Overrides: `Object.toString()`
```

```APIDOC
### noSuchMethod
- Parameters:
  - invocation (Invocation) - The invocation object.
- Returns: dynamic
- Description: Invoked when a nonexistent method or property is accessed.
- Inherited from: `Object.noSuchMethod()`
```

--------------------------------

### Implementation of onPurchaseStarted

Source: https://pub.dev/documentation/purchases_ui_flutter/latest/views_internal_paywall_footer_view/InternalPaywallFooterView/onPurchaseStarted.html

Defines the signature for the onPurchaseStarted callback property.

```dart
final Function(Package rcPackage)? onPurchaseStarted;
```

--------------------------------

### Paywall Configuration and Logic

Source: https://pub.dev/documentation/purchases_ui_flutter/latest/purchases_ui_flutter

Configure paywall presentation across platforms and implement custom purchase logic. Handles the result of paywall presentations and custom purchase operations.

```APIDOC
## Classes

### PaywallPresentationConfiguration

Configures how a paywall is presented on each platform.

### PaywallPurchaseLogic

Interface for custom purchase logic when `purchasesAreCompletedBy` is set to `myApp`.

## Enums

### PaywallResult

Possible values for the result of a paywall presentation.

### PurchaseLogicResult

Result of a custom purchase or restore operation performed by the app.
```

--------------------------------

### PaywallPresentationConfiguration.fullScreen

Source: https://pub.dev/documentation/purchases_ui_flutter/latest/paywall_presentation_configuration/PaywallPresentationConfiguration/fullScreen-constant.html

A constant configuration object that sets the presentation style to full-screen for both iOS and Android platforms.

```APIDOC
## PaywallPresentationConfiguration.fullScreen

### Description
A static constant used to configure the paywall presentation to appear in full-screen mode on all supported platforms.

### Definition
```dart
static const fullScreen = PaywallPresentationConfiguration(
  ios: IOSPaywallPresentationStyle.fullScreen,
  android: AndroidPaywallPresentationStyle.fullScreen,
);
```
```

--------------------------------

### PaywallViewMethodHandler constructor

Source: https://pub.dev/documentation/purchases_ui_flutter/latest/views_paywall_view_method_handler/PaywallViewMethodHandler/PaywallViewMethodHandler.html

Initializes a new instance of the PaywallViewMethodHandler with optional callback functions for handling purchase lifecycle events.

```APIDOC
## PaywallViewMethodHandler

### Description
Initializes the handler for paywall events, allowing the implementation of custom logic for purchase success, failure, cancellation, and restoration.

### Constructor Signature
```dart
const PaywallViewMethodHandler(
  Function(Package)? onPurchaseStarted,
  Function(CustomerInfo, StoreTransaction)? onPurchaseCompleted,
  Function()? onPurchaseCancelled,
  Function(PurchasesError)? onPurchaseError,
  Function(CustomerInfo)? onRestoreCompleted,
  Function(PurchasesError)? onRestoreError,
  Function()? onDismiss, {
  Function()? onWebCheckoutOpened,
  Function(String)? onUrlOpened,
  PaywallPurchaseLogic? purchaseLogic,
  MethodChannel? methodChannel,
})
```

### Parameters
- **onPurchaseStarted** (Function(Package)?) - Optional - Callback triggered when a purchase process begins.
- **onPurchaseCompleted** (Function(CustomerInfo, StoreTransaction)?) - Optional - Callback triggered when a purchase is successfully completed.
- **onPurchaseCancelled** (Function()?) - Optional - Callback triggered when the user cancels the purchase.
- **onPurchaseError** (Function(PurchasesError)?) - Optional - Callback triggered when an error occurs during purchase.
- **onRestoreCompleted** (Function(CustomerInfo)?) - Optional - Callback triggered when a restoration is successfully completed.
- **onRestoreError** (Function(PurchasesError)?) - Optional - Callback triggered when an error occurs during restoration.
- **onDismiss** (Function()?) - Optional - Callback triggered when the paywall is dismissed.
- **onWebCheckoutOpened** (Function()?) - Optional - Callback triggered when the web checkout flow is opened.
- **onUrlOpened** (Function(String)?) - Optional - Callback triggered when a URL is opened.
- **purchaseLogic** (PaywallPurchaseLogic?) - Optional - Custom purchase logic implementation.
- **methodChannel** (MethodChannel?) - Optional - Custom method channel for platform communication.
```

--------------------------------

### presentPaywall Implementation

Source: https://pub.dev/documentation/purchases_ui_flutter/latest/purchases_ui_flutter/RevenueCatUI/presentPaywall.html

The internal implementation of the presentPaywall method, handling method channel communication and platform-specific presentation configurations.

```dart
static Future<PaywallResult> presentPaywall({
  Offering? offering,
  bool displayCloseButton = false,
  Map<String, CustomVariableValue>? customVariables,
  PaywallPresentationConfiguration? presentationConfiguration,
}) async {
  final presentedOfferingContext = offering?.availablePackages
      .elementAtOrNull(0)
      ?.presentedOfferingContext;
  final result = await _methodChannel.invokeMethod('presentPaywall', {
    'offeringIdentifier': offering?.identifier,
    'presentedOfferingContext': presentedOfferingContext?.toJson(),
    'displayCloseButton': displayCloseButton,
    'customVariables': convertCustomVariablesToNative(customVariables),
    // Only send when fullScreen is explicitly requested; omitting the key
    // lets the native SDK use its default (sheet). This avoids ambiguity
    // between "key absent" and "key present with false".
    if (presentationConfiguration?.ios ==
        IOSPaywallPresentationStyle.fullScreen)
      'useFullScreenPresentation': true,
  });
  return _parseStringToResult(result);
}
```

--------------------------------

### PaywallViewMethodHandler Constructor Implementation

Source: https://pub.dev/documentation/purchases_ui_flutter/latest/views_paywall_view_method_handler/PaywallViewMethodHandler/PaywallViewMethodHandler.html

The constructor initializes the handler with optional callback functions for managing purchase lifecycle events and optional configuration for purchase logic and method channels.

```dart
const PaywallViewMethodHandler(
  this.onPurchaseStarted,
  this.onPurchaseCompleted,
  this.onPurchaseCancelled,
  this.onPurchaseError,
  this.onRestoreCompleted,
  this.onRestoreError,
  this.onDismiss, {
  this.onWebCheckoutOpened,
  this.onUrlOpened,
  this.purchaseLogic,
  this.methodChannel,
});
```

--------------------------------

### handleMethodCall

Source: https://pub.dev/documentation/purchases_ui_flutter/latest/views_customer_center_view_method_handler/CustomerCenterViewMethodHandler-class.html

Handles incoming method calls for the customer center view.

```APIDOC
## handleMethodCall

### Description
Processes a given MethodCall object, executing the corresponding logic for the customer center view.

### Method
`handleMethodCall(MethodCall call)`

### Parameters
- **call** (MethodCall) - The method call object to handle.
```

--------------------------------

### performPurchase(Package packageToPurchase)

Source: https://pub.dev/documentation/purchases_ui_flutter/latest/purchase_logic/PaywallPurchaseLogic/performPurchase.html

This method is called when the user initiates a purchase from the paywall. It takes the selected package as an argument and returns the result of the purchase operation.

```APIDOC
## performPurchase

### Description
Called when the user initiates a purchase from the paywall. This method processes the selected package and returns the result of the purchase operation.

### Signature
`Future<PurchaseLogicResult> performPurchase(Package packageToPurchase)`

### Parameters
- **packageToPurchase** (Package) - Required - The package the user selected for purchase.

### Returns
- **Future<PurchaseLogicResult>** - The result of the purchase operation.
```

--------------------------------

### InternalPaywallFooterView build implementation

Source: https://pub.dev/documentation/purchases_ui_flutter/latest/views_internal_paywall_footer_view/InternalPaywallFooterView/build.html

This method determines the platform-specific view to render by checking Platform.isAndroid and passing the offering identifier as a creation parameter.

```dart
@override
Widget build(BuildContext context) {
  final creationParams = <String, dynamic>{
    'offeringIdentifier': offering?.identifier,
  };

  return Platform.isAndroid
      ? _buildAndroidPlatformViewLink(creationParams)
      : _buildUiKitView(creationParams);
}
```

--------------------------------

### PaywallFooterView Constructor Implementation

Source: https://pub.dev/documentation/purchases_ui_flutter/latest/views_paywall_footer_view/PaywallFooterView/PaywallFooterView.html

The constructor for PaywallFooterView, which accepts various callback functions for purchase and restore events, and a required contentCreator widget builder.

```dart
@Deprecated('use OriginalTemplatePaywallFooterView instead')
const PaywallFooterView({
  Key? key,
  Offering? offering,
  Function(Package rcPackage)? onPurchaseStarted,
  Function(CustomerInfo customerInfo, StoreTransaction storeTransaction)?
      onPurchaseCompleted,
  Function()? onPurchaseCancelled,
  Function(PurchasesError)? onPurchaseError,
  Function(CustomerInfo customerInfo)? onRestoreCompleted,
  Function(PurchasesError)? onRestoreError,
  Function()? onDismiss,
  required Widget Function(double bottomPadding) contentCreator,
}) : super(
        key: key,
        offering: offering,
        onPurchaseStarted: onPurchaseStarted,
        onPurchaseCompleted: onPurchaseCompleted,
        onPurchaseCancelled: onPurchaseCancelled,
        onPurchaseError: onPurchaseError,
        onRestoreCompleted: onRestoreCompleted,
        onRestoreError: onRestoreError,
        onDismiss: onDismiss,
        contentCreator: contentCreator,
      );
```

--------------------------------

### Implementation of onRefundRequestStarted

Source: https://pub.dev/documentation/purchases_ui_flutter/latest/views_customer_center_view/CustomerCenterView/onRefundRequestStarted.html

Defines the property type for handling refund request initiation events.

```dart
final CustomerCenterRefundRequestStarted? onRefundRequestStarted;
```

--------------------------------

### Define defaultConfiguration constant

Source: https://pub.dev/documentation/purchases_ui_flutter/latest/paywall_presentation_configuration/PaywallPresentationConfiguration/defaultConfiguration-constant.html

Sets the default presentation styles for iOS and Android platforms.

```dart
static const defaultConfiguration = PaywallPresentationConfiguration(
  ios: IOSPaywallPresentationStyle.sheet,
  android: AndroidPaywallPresentationStyle.fullScreen,
);
```

--------------------------------

### Implement handleMethodCall in PaywallViewMethodHandler

Source: https://pub.dev/documentation/purchases_ui_flutter/latest/views_paywall_view_method_handler/PaywallViewMethodHandler/handleMethodCall.html

This method uses a switch statement to route various purchase-related events to their respective handler functions.

```dart
Future<void> handleMethodCall(MethodCall call) async {
  switch (call.method) {
    case 'onPurchaseStarted':
      _handleOnPurchaseStarted(call);
      break;
    case 'onPurchaseCompleted':
      _handleOnPurchaseCompleted(call);
      break;
    case 'onPurchaseCancelled':
      onPurchaseCancelled?.call();
      break;
    case 'onPurchaseError':
      _handleOnPurchaseError(call);
      break;
    case 'onRestoreCompleted':
      _handleOnRestoreCompleted(call);
      break;
    case 'onRestoreError':
      _handleOnRestoreError(call);
      break;
    case 'onDismiss':
      onDismiss?.call();
      break;
    case 'onWebCheckoutOpened':
      onWebCheckoutOpened?.call();
      break;
    case 'onUrlOpened':
      onUrlOpened?.call(
        Map<String, dynamic>.from(call.arguments)['url'] as String,
      );
      break;
    case 'onPerformPurchase':
      _handleOnPerformPurchase(call);
      break;
    case 'onPerformRestore':
      _handleOnPerformRestore(call);
      break;
    default:
      break;
  }
}
```

--------------------------------

### InternalPaywallFooterView Constructor Implementation

Source: https://pub.dev/documentation/purchases_ui_flutter/latest/views_internal_paywall_footer_view/InternalPaywallFooterView/InternalPaywallFooterView.html

The constructor initializes the footer view with optional purchase lifecycle callbacks and a required height change handler.

```dart
const InternalPaywallFooterView({
  Key? key,
  this.offering,
  this.onPurchaseStarted,
  this.onPurchaseCompleted,
  this.onPurchaseCancelled,
  this.onPurchaseError,
  this.onRestoreCompleted,
  this.onRestoreError,
  this.onDismiss,
  required this.onHeightChanged,
}) : super(key: key);
```

--------------------------------

### Define fullScreen configuration

Source: https://pub.dev/documentation/purchases_ui_flutter/latest/paywall_presentation_configuration/PaywallPresentationConfiguration/fullScreen-constant.html

Use this constant to apply full-screen presentation styles consistently across both iOS and Android platforms.

```dart
static const fullScreen = PaywallPresentationConfiguration(
  ios: IOSPaywallPresentationStyle.fullScreen,
  android: AndroidPaywallPresentationStyle.fullScreen,
);
```

--------------------------------

### CustomerCenterViewMethodHandler Constructor

Source: https://pub.dev/documentation/purchases_ui_flutter/latest/views_customer_center_view_method_handler/CustomerCenterViewMethodHandler-class.html

Initializes a new instance of the CustomerCenterViewMethodHandler class with various optional callback handlers for different customer center events.

```APIDOC
## CustomerCenterViewMethodHandler Constructor

### Description
Initializes a new instance of the CustomerCenterViewMethodHandler class.

### Parameters
- **onDismiss** (CustomerCenterOnDismiss?) - Optional callback for when the customer center is dismissed.
- **onRestoreStarted** (CustomerCenterRestoreStarted?) - Optional callback for when a restore operation starts.
- **onRestoreCompleted** (CustomerCenterRestoreCompleted?) - Optional callback for when a restore operation completes.
- **onRestoreFailed** (CustomerCenterRestoreFailed?) - Optional callback for when a restore operation fails.
- **onShowingManageSubscriptions** (CustomerCenterManageSubscriptions?) - Optional callback for when the manage subscriptions view is shown.
- **onRefundRequestStarted** (CustomerCenterRefundRequestStarted?) - Optional callback for when a refund request starts.
- **onRefundRequestCompleted** (CustomerCenterRefundRequestCompleted?) - Optional callback for when a refund request completes.
- **onFeedbackSurveyCompleted** (CustomerCenterFeedbackSurveyCompleted?) - Optional callback for when the feedback survey is completed.
- **onManagementOptionSelected** (CustomerCenterManagementOptionSelected?) - Optional callback for when a management option is selected.
- **onCustomActionSelected** (CustomerCenterCustomActionSelected?) - Optional callback for when a custom action is selected.
- **onPromotionalOfferSucceeded** (CustomerCenterPromotionalOfferSucceeded?) - Optional callback for when a promotional offer succeeds.
```

--------------------------------

### PaywallPresentationConfiguration.defaultConfiguration

Source: https://pub.dev/documentation/purchases_ui_flutter/latest/paywall_presentation_configuration/PaywallPresentationConfiguration/defaultConfiguration-constant.html

The defaultConfiguration constant provides a pre-configured instance of PaywallPresentationConfiguration with platform-specific defaults.

```APIDOC
## PaywallPresentationConfiguration.defaultConfiguration

### Description
Returns the default presentation configuration for paywalls. This configuration sets the iOS style to `sheet` and the Android style to `fullScreen`.

### Signature
`static const PaywallPresentationConfiguration defaultConfiguration`

### Configuration Details
- **ios**: `IOSPaywallPresentationStyle.sheet`
- **android**: `AndroidPaywallPresentationStyle.fullScreen`
```

--------------------------------

### Implement handleMethodCall in CustomerCenterViewMethodHandler

Source: https://pub.dev/documentation/purchases_ui_flutter/latest/views_customer_center_view_method_handler/CustomerCenterViewMethodHandler/handleMethodCall.html

This method uses a switch statement to delegate various customer center events to their respective internal handlers.

```dart
Future<void> handleMethodCall(MethodCall call) async {
  switch (call.method) {
    case 'onDismiss':
      onDismiss?.call();
      break;
    case 'onRestoreStarted':
      onRestoreStarted?.call();
      break;
    case 'onRestoreCompleted':
      _handleRestoreCompleted(call.arguments);
      break;
    case 'onRestoreFailed':
      _handleRestoreFailed(call.arguments);
      break;
    case 'onShowingManageSubscriptions':
      onShowingManageSubscriptions?.call();
      break;
    case 'onRefundRequestStarted':
      _handleRefundRequestStarted(call.arguments);
      break;
    case 'onRefundRequestCompleted':
      _handleRefundRequestCompleted(call.arguments);
      break;
    case 'onFeedbackSurveyCompleted':
      _handleFeedbackSurveyCompleted(call.arguments);
      break;
    case 'onManagementOptionSelected':
      _handleManagementOptionSelected(call.arguments);
      break;
    case 'onCustomActionSelected':
      _handleCustomActionSelected(call.arguments);
      break;
    case 'onPromotionalOfferSucceeded':
      _handlePromotionalOfferSucceeded(call.arguments);
      break;
    default:
      break;
  }
}
```

--------------------------------

### Implementation of onWebCheckoutOpened

Source: https://pub.dev/documentation/purchases_ui_flutter/latest/views_paywall_view/PaywallView/onWebCheckoutOpened.html

Defines the signature for the onWebCheckoutOpened callback property.

```dart
final Function()? onWebCheckoutOpened;
```

--------------------------------

### performPurchase Method Signature

Source: https://pub.dev/documentation/purchases_ui_flutter/latest/purchase_logic/PaywallPurchaseLogic/performPurchase.html

Defines the abstract method signature for handling purchase initiation within the paywall logic.

```dart
Future<PurchaseLogicResult> performPurchase(Package packageToPurchase);
```

--------------------------------

### InternalPaywallFooterView Methods

Source: https://pub.dev/documentation/purchases_ui_flutter/latest/views_internal_paywall_footer_view/InternalPaywallFooterView-class.html

Methods available on the InternalPaywallFooterView class.

```APIDOC
## InternalPaywallFooterView Methods

### `build`
* Signature: `build(BuildContext context) → Widget`
* Description: Describes the part of the user interface represented by this widget.
```

--------------------------------

### Presenting a Paywall with Custom Variables

Source: https://pub.dev/documentation/purchases_ui_flutter/latest/custom_variable_value/CustomVariableValue-class.html

Pass a map of custom variables to the presentPaywall method to inject dynamic data into the paywall UI.

```dart
RevenueCatUI.presentPaywall(
  customVariables: {
    'player_name': CustomVariableValue.string('John'),
    'level': CustomVariableValue.number(42),
    'is_premium': CustomVariableValue.boolean(true),
  },
);
```

--------------------------------

### InternalPaywallFooterView Constructor

Source: https://pub.dev/documentation/purchases_ui_flutter/latest/views_internal_paywall_footer_view/InternalPaywallFooterView-class.html

Constructor for the InternalPaywallFooterView widget. It accepts optional callbacks for purchase events and a required callback for height changes.

```APIDOC
## InternalPaywallFooterView Constructor

### Description
Initializes a new instance of the `InternalPaywallFooterView` class.

### Parameters
* `key` (Key?): An optional key to identify the widget.
* `offering` (Offering?): An optional offering object.
* `onPurchaseStarted` (dynamic Function(Package rcPackage)?): Callback function invoked when a purchase attempt starts.
* `onPurchaseCompleted` (dynamic Function(CustomerInfo customerInfo, StoreTransaction storeTransaction)?): Callback function invoked when a purchase is successfully completed.
* `onPurchaseCancelled` (dynamic Function()?): Callback function invoked when a purchase is cancelled.
* `onPurchaseError` (dynamic Function(PurchasesError)?): Callback function invoked when a purchase error occurs.
* `onRestoreCompleted` (dynamic Function(CustomerInfo customerInfo)?): Callback function invoked when a restore operation is successfully completed.
* `onRestoreError` (dynamic Function(PurchasesError)?): Callback function invoked when a restore error occurs.
* `onDismiss` (dynamic Function()?): Callback function invoked when the paywall is dismissed.
* `onHeightChanged` (dynamic Function(double)): Required callback function invoked when the height of the paywall changes.
```

--------------------------------

### String toString()

Source: https://pub.dev/documentation/purchases_ui_flutter/latest/paywall_presentation_configuration/AndroidPaywallPresentationStyle/toString.html

Returns a string representation of the AndroidPaywallPresentationStyle object.

```APIDOC
## String toString()

### Description
Returns a string representation of the object. This method is typically overridden to provide useful information when inspecting the object for debugging or logging purposes.

### Signature
`String toString()`

### Returns
- **String** - A string representation of the object.
```

--------------------------------

### presentPaywallIfNeeded Implementation

Source: https://pub.dev/documentation/purchases_ui_flutter/latest/purchases_ui_flutter/RevenueCatUI/presentPaywallIfNeeded.html

The internal implementation of the presentPaywallIfNeeded method, showing how it invokes the native method channel and handles configuration parameters.

```dart
static Future<PaywallResult> presentPaywallIfNeeded(
  String requiredEntitlementIdentifier, {
  Offering? offering,
  bool displayCloseButton = false,
  Map<String, CustomVariableValue>? customVariables,
  PaywallPresentationConfiguration? presentationConfiguration,
}) async {
  final presentedOfferingContext = offering?.availablePackages
      .elementAtOrNull(0)
      ?.presentedOfferingContext;
  final result = await _methodChannel.invokeMethod('presentPaywallIfNeeded', {
    'requiredEntitlementIdentifier': requiredEntitlementIdentifier,
    'offeringIdentifier': offering?.identifier,
    'presentedOfferingContext': presentedOfferingContext?.toJson(),
    'displayCloseButton': displayCloseButton,
    'customVariables': convertCustomVariablesToNative(customVariables),
    // Only send when fullScreen is explicitly requested; omitting the key
    // lets the native SDK use its default (sheet). This avoids ambiguity
    // between "key absent" and "key present with false".
    if (presentationConfiguration?.ios ==
        IOSPaywallPresentationStyle.fullScreen)
      'useFullScreenPresentation': true,
  });
  return _parseStringToResult(result);
}
```

--------------------------------

### onWebCheckoutOpened

Source: https://pub.dev/documentation/purchases_ui_flutter/latest/views_paywall_view/PaywallView/onWebCheckoutOpened.html

A callback function property that executes when the web checkout flow is opened.

```APIDOC
## onWebCheckoutOpened

### Description
A callback function that is invoked when the web checkout process is opened. This property is defined as a `dynamic Function()?`.

### Signature
`final Function()? onWebCheckoutOpened;`
```

--------------------------------

### presentPaywallIfNeeded

Source: https://pub.dev/documentation/purchases_ui_flutter/latest/purchases_ui_flutter/RevenueCatUI/presentPaywallIfNeeded.html

Presents the paywall as an activity on Android or a modal in iOS if the user does not have the given entitlement identifier active.

```APIDOC
## presentPaywallIfNeeded

### Description
Presents the paywall as an activity on Android or a modal in iOS as long as the user does not have the given entitlement identifier active. Returns a PaywallResult indicating the result of the paywall presentation.

### Signature
`Future<PaywallResult> presentPaywallIfNeeded(String requiredEntitlementIdentifier, {Offering? offering, bool displayCloseButton = false, Map<String, CustomVariableValue>? customVariables, PaywallPresentationConfiguration? presentationConfiguration})`

### Parameters
- **requiredEntitlementIdentifier** (String) - Required - Entitlement identifier to check if the user has access to before presenting the paywall.
- **offering** (Offering?) - Optional - If set, will present the paywall associated to the given Offering.
- **displayCloseButton** (bool) - Optional - Optionally present the paywall with a close button. Only available for original template paywalls. Ignored for V2 Paywalls.
- **customVariables** (Map<String, CustomVariableValue>?) - Optional - A map of custom variable names to their values for text substitution.
- **presentationConfiguration** (PaywallPresentationConfiguration?) - Optional - Configuration for how the paywall is presented on each platform.

### Returns
- **PaywallResult** - Indicates the result of the paywall presentation.
```

--------------------------------

### Present Customer Center

Source: https://pub.dev/documentation/purchases_ui_flutter/latest/index.html

Displays the customer center modal, optionally with callbacks for restore and refund events.

```dart
await RevenueCatUI.presentCustomerCenter(
  onRestoreCompleted: (customerInfo) {
    // handle restore success
  },
  onRefundRequestCompleted: (productId, status) {
    // handle refund completion
  },
);

// Or, if you don't need callbacks:
await RevenueCatUI.presentCustomerCenter();
```

--------------------------------

### Define CustomerCenterPromotionalOfferSucceeded typedef

Source: https://pub.dev/documentation/purchases_ui_flutter/latest/views_customer_center_view_method_handler/CustomerCenterPromotionalOfferSucceeded.html

This typedef defines the function signature for handling successful promotional offer purchases, requiring customer info, transaction details, and the offer ID.

```dart
typedef CustomerCenterPromotionalOfferSucceeded = void Function(
  CustomerInfo customerInfo,
  StoreTransaction transaction,
  String offerId,
);
```

--------------------------------

### presentPaywallIfNeeded

Source: https://pub.dev/documentation/purchases_ui_flutter/latest/purchases_ui_flutter/RevenueCatUI-class.html

Presents the paywall if the user does not have the specified entitlement active. Allows for customization of the offering, close button, custom variables, and presentation configuration.

```APIDOC
## presentPaywallIfNeeded

### Description
Presents the paywall as an activity on android or a modal in iOS as long as the user does not have the given entitlement identifier active. Returns a PaywallResult indicating the result of the paywall presentation.

### Method
static Future<PaywallResult> presentPaywallIfNeeded(
  String requiredEntitlementIdentifier,
  {
    Offering? offering,
    bool displayCloseButton = false,
    Map<String, CustomVariableValue>? customVariables,
    PaywallPresentationConfiguration? presentationConfiguration,
  }
)

### Parameters
- `requiredEntitlementIdentifier` (String) - The identifier of the entitlement that must not be active for the paywall to be presented.
- `offering` (Offering?) - If set, will present the paywall associated to the given Offering.
- `displayCloseButton` (bool) - Optionally present the paywall with a close button. Only available for original template paywalls. Ignored for V2 Paywalls.
- `customVariables` (Map<String, CustomVariableValue>?) - A map of custom variable names to their values. These values can be used for text substitution in paywalls using the `{{ custom.variable_name }}` syntax.
- `presentationConfiguration` (PaywallPresentationConfiguration?) - Optional configuration for how the paywall is presented on each platform.
```

--------------------------------

### Implementation of onRefundRequestCompleted

Source: https://pub.dev/documentation/purchases_ui_flutter/latest/views_customer_center_view/CustomerCenterView/onRefundRequestCompleted.html

Defines the callback property for handling completed refund requests.

```dart
final CustomerCenterRefundRequestCompleted? onRefundRequestCompleted;
```

--------------------------------

### Implementation of onShowingManageSubscriptions

Source: https://pub.dev/documentation/purchases_ui_flutter/latest/views_customer_center_view/CustomerCenterView/onShowingManageSubscriptions.html

Defines the property type for managing subscription display callbacks.

```dart
final CustomerCenterManageSubscriptions? onShowingManageSubscriptions;
```

--------------------------------

### presentPaywall

Source: https://pub.dev/documentation/purchases_ui_flutter/latest/purchases_ui_flutter/RevenueCatUI-class.html

Presents the paywall as an activity on android or a modal in iOS. Allows for customization of the offering, close button, custom variables, and presentation configuration.

```APIDOC
## presentPaywall

### Description
Presents the paywall as an activity on android or a modal in iOS. Returns a PaywallResult indicating the result of the paywall presentation.

### Method
static Future<PaywallResult> presentPaywall({
  Offering? offering,
  bool displayCloseButton = false,
  Map<String, CustomVariableValue>? customVariables,
  PaywallPresentationConfiguration? presentationConfiguration,
})

### Parameters
- `offering` (Offering?) - If set, will present the paywall associated to the given Offering.
- `displayCloseButton` (bool) - Optionally present the paywall with a close button. Only available for original template paywalls. Ignored for V2 Paywalls.
- `customVariables` (Map<String, CustomVariableValue>?) - A map of custom variable names to their values. These values can be used for text substitution in paywalls using the `{{ custom.variable_name }}` syntax.
- `presentationConfiguration` (PaywallPresentationConfiguration?) - Optional configuration for how the paywall is presented on each platform.
```

--------------------------------

### Paywall Widgets

Source: https://pub.dev/documentation/purchases_ui_flutter/latest/purchases_ui_flutter

Provides widgets for displaying paywalls and customer support information within your application. Includes full-screen paywalls, footer views, and customer center views.

```APIDOC
## Classes

### CustomerCenterView

A widget that displays the customer center inline within your app.

### OriginalTemplatePaywallFooterView

View that displays the paywall in footer mode. Not supported in macOS currently. Only available for original template paywalls. Ignored for V2 Paywalls.

### PaywallFooterView

View that displays the paywall in footer mode. Not supported in macOS currently. Only available for original template paywalls. Ignored for V2 Paywalls.

### PaywallView

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

--------------------------------

### Define CustomerCenterRestoreCompleted typedef

Source: https://pub.dev/documentation/purchases_ui_flutter/latest/views_customer_center_view_method_handler/CustomerCenterRestoreCompleted.html

Defines the function signature for handling successful purchase restoration, receiving the updated CustomerInfo.

```dart
typedef CustomerCenterRestoreCompleted = void Function(
  CustomerInfo customerInfo,
);
```

--------------------------------

### PaywallPresentationConfiguration Properties

Source: https://pub.dev/documentation/purchases_ui_flutter/latest/paywall_presentation_configuration/PaywallPresentationConfiguration-class.html

Details of the properties available for PaywallPresentationConfiguration.

```APIDOC
## Properties

### android
- Type: AndroidPaywallPresentationStyle?
- Description: Optional Android-specific presentation style. Android always presents full screen; this field exists for API symmetry and future use.

### ios
- Type: IOSPaywallPresentationStyle?
- Description: Optional iOS-specific presentation style.
```

--------------------------------

### Implementation of onManagementOptionSelected

Source: https://pub.dev/documentation/purchases_ui_flutter/latest/views_customer_center_view/CustomerCenterView/onManagementOptionSelected.html

Defines the callback type for management option selection in the CustomerCenterView.

```dart
final CustomerCenterManagementOptionSelected? onManagementOptionSelected;
```

--------------------------------

### StringCustomVariableValue Methods and Operators

Source: https://pub.dev/documentation/purchases_ui_flutter/latest/custom_variable_value/StringCustomVariableValue-class.html

Provides methods for object interaction and comparison.

```APIDOC
## Methods 

noSuchMethod(Invocation invocation) → dynamic 
     Invoked when a nonexistent method or property is accessed.
inherited 

twoString() → String 
     A string representation of this object.
override

## Operators 

operator ==(Object other) → bool 
     The equality operator.
override
```

--------------------------------

### PaywallPresentationConfiguration Operators

Source: https://pub.dev/documentation/purchases_ui_flutter/latest/paywall_presentation_configuration/PaywallPresentationConfiguration-class.html

Operators available for the PaywallPresentationConfiguration class.

```APIDOC
## Operators

### operator ==
- Parameters:
  - other (Object) - The object to compare with.
- Returns: bool
- Description: The equality operator.
- Overrides: `Object.operator ==`
```

--------------------------------

### PurchaseLogicResult Methods and Operators

Source: https://pub.dev/documentation/purchases_ui_flutter/latest/purchase_logic/PurchaseLogicResult.html

This snippet lists the methods and operators available for the PurchaseLogicResult enum.

```APIDOC
## Methods

*   **noSuchMethod(Invocation invocation)** → dynamic
    Invoked when a nonexistent method or property is accessed.
*   **toString()** → String
    A string representation of this object.

## Operators

*   **operator ==(Object other)** → bool
    The equality operator.
```

--------------------------------

### Present Paywall Conditionally

Source: https://pub.dev/documentation/purchases_ui_flutter/latest/index.html

Displays the paywall only if the user does not have the specified entitlement.

```dart
await RevenueCatUI.presentPaywallIfNeeded("requiredEntitlementId");
```

--------------------------------

### AndroidPaywallPresentationStyle.fullScreen

Source: https://pub.dev/documentation/purchases_ui_flutter/latest/paywall_presentation_configuration/AndroidPaywallPresentationStyle-class.html

Presents the paywall as a full-screen activity, which is the default Android behavior.

```APIDOC
## Constants

fullScreen → const AndroidPaywallPresentationStyle
     Presents the paywall as a full-screen activity (default Android behavior).
```

--------------------------------

### Implementation of onRestoreStarted

Source: https://pub.dev/documentation/purchases_ui_flutter/latest/views_customer_center_view/CustomerCenterView/onRestoreStarted.html

Defines the onRestoreStarted property as a CustomerCenterRestoreStarted callback.

```dart
final CustomerCenterRestoreStarted? onRestoreStarted;
```

--------------------------------

### Implementation of onFeedbackSurveyCompleted

Source: https://pub.dev/documentation/purchases_ui_flutter/latest/views_customer_center_view/CustomerCenterView/onFeedbackSurveyCompleted.html

Defines the callback property for handling completed feedback surveys.

```dart
final CustomerCenterFeedbackSurveyCompleted? onFeedbackSurveyCompleted;
```

--------------------------------

### Define onPromotionalOfferSucceeded property

Source: https://pub.dev/documentation/purchases_ui_flutter/latest/views_customer_center_view/CustomerCenterView/onPromotionalOfferSucceeded.html

Declaration of the callback property used to handle successful promotional offer purchases.

```dart
final CustomerCenterPromotionalOfferSucceeded? onPromotionalOfferSucceeded;
```

--------------------------------

### IOSPaywallPresentationStyle Constants

Source: https://pub.dev/documentation/purchases_ui_flutter/latest/paywall_presentation_configuration/IOSPaywallPresentationStyle-class.html

Defines the available presentation styles for paywalls on iOS. These are static constants that can be used to configure the paywall's appearance.

```APIDOC
## Constants

### `fullScreen` → `const IOSPaywallPresentationStyle`

Presents the paywall as a full-screen modal. Useful to avoid white areas in landscape orientation.

### `sheet` → `const IOSPaywallPresentationStyle`

Presents the paywall as a sheet (default iOS behavior).
```

--------------------------------

### Paywall Presentation Styles

Source: https://pub.dev/documentation/purchases_ui_flutter/latest/purchases_ui_flutter

Defines how the paywall is presented on different platforms. Use AndroidPaywallPresentationStyle for Android and IOSPaywallPresentationStyle for iOS.

```APIDOC
## Enums

### AndroidPaywallPresentationStyle

Controls how the paywall is presented on Android.

### IOSPaywallPresentationStyle

Controls how the paywall is presented on iOS.
```

--------------------------------

### CustomerCenterView constructor

Source: https://pub.dev/documentation/purchases_ui_flutter/latest/views_customer_center_view/CustomerCenterView/CustomerCenterView.html

The constructor for the CustomerCenterView widget, which allows configuration of UI behavior and event callbacks for subscription management.

```APIDOC
## CustomerCenterView()

### Description
Initializes the CustomerCenterView widget with optional configuration for the close button and various event callbacks for subscription management operations.

### Parameters
- **key** (Key?) - Optional - The widget key.
- **shouldShowCloseButton** (bool) - Optional - Whether to display the close button. Defaults to true.
- **onDismiss** (CustomerCenterOnDismiss?) - Optional - Callback triggered when the view is dismissed.
- **onRestoreStarted** (CustomerCenterRestoreStarted?) - Optional - Callback triggered when a restore operation begins.
- **onRestoreCompleted** (CustomerCenterRestoreCompleted?) - Optional - Callback triggered when a restore operation completes.
- **onRestoreFailed** (CustomerCenterRestoreFailed?) - Optional - Callback triggered when a restore operation fails.
- **onShowingManageSubscriptions** (CustomerCenterManageSubscriptions?) - Optional - Callback triggered when the manage subscriptions view is shown.
- **onRefundRequestStarted** (CustomerCenterRefundRequestStarted?) - Optional - Callback triggered when a refund request begins.
- **onRefundRequestCompleted** (CustomerCenterRefundRequestCompleted?) - Optional - Callback triggered when a refund request completes.
- **onFeedbackSurveyCompleted** (CustomerCenterFeedbackSurveyCompleted?) - Optional - Callback triggered when a feedback survey is completed.
- **onManagementOptionSelected** (CustomerCenterManagementOptionSelected?) - Optional - Callback triggered when a management option is selected.
- **onCustomActionSelected** (CustomerCenterCustomActionSelected?) - Optional - Callback triggered when a custom action is selected.
- **onPromotionalOfferSucceeded** (CustomerCenterPromotionalOfferSucceeded?) - Optional - Callback triggered when a promotional offer is successfully applied.
```

--------------------------------

### Implementation of onCustomActionSelected

Source: https://pub.dev/documentation/purchases_ui_flutter/latest/views_customer_center_view/CustomerCenterView/onCustomActionSelected.html

Defines the signature for the onCustomActionSelected callback property.

```dart
final CustomerCenterCustomActionSelected? onCustomActionSelected;
```

--------------------------------

### Define fullScreen presentation style

Source: https://pub.dev/documentation/purchases_ui_flutter/latest/paywall_presentation_configuration/IOSPaywallPresentationStyle/fullScreen-constant.html

This constant defines the full-screen modal presentation style for iOS paywalls.

```dart
static const fullScreen = IOSPaywallPresentationStyle._('fullScreen');
```

--------------------------------

### IOSPaywallPresentationStyle.fullScreen

Source: https://pub.dev/documentation/purchases_ui_flutter/latest/paywall_presentation_configuration/IOSPaywallPresentationStyle/fullScreen-constant.html

Presents the paywall as a full-screen modal. This style is particularly useful for avoiding white areas when the device is in landscape orientation.

```APIDOC
## IOSPaywallPresentationStyle.fullScreen

### Description
A constant value used to set the paywall presentation style to full-screen. This ensures the paywall occupies the entire screen, preventing layout issues such as white bars in landscape mode.

### Signature
`static const IOSPaywallPresentationStyle fullScreen = IOSPaywallPresentationStyle._('fullScreen');`
```

--------------------------------

### Define CustomerCenterRefundRequestCompleted typedef

Source: https://pub.dev/documentation/purchases_ui_flutter/latest/views_customer_center_view_method_handler/CustomerCenterRefundRequestCompleted.html

This typedef defines the signature for a callback function that receives the product identifier and status string upon refund request completion.

```dart
typedef CustomerCenterRefundRequestCompleted = void Function(
  String productIdentifier,
  String status,
);
```

--------------------------------

### Present Paywall

Source: https://pub.dev/documentation/purchases_ui_flutter/latest/index.html

Displays the RevenueCat paywall to the user.

```dart
await RevenueCatUI.presentPaywall();
```

--------------------------------

### Define Android Paywall Presentation Style

Source: https://pub.dev/documentation/purchases_ui_flutter/latest/paywall_presentation_configuration/PaywallPresentationConfiguration/android.html

Declare the optional Android-specific presentation style property within the configuration class.

```dart
final AndroidPaywallPresentationStyle? android;
```
Tokens:
Raw