AdaptyUI/com.adapty.ui.listeners/AdaptyFlowEventListener

AdaptyFlowEventListener

interface AdaptyFlowEventListener

Implement this interface to respond to different events happening inside the purchase screen.

Inheritors

AdaptyFlowDefaultEventListener

Types

PermissionCallback

fun interface PermissionCallback

PurchaseParamsCallback

fun interface PurchaseParamsCallback

Functions

onActionPerformed

abstract fun onActionPerformed(action: AdaptyUI.Action, context: Context)

This callback is invoked when user interacts with some widgets on the flow.

onAnalyticEvent

abstract fun onAnalyticEvent(name: String, params: Map<String, Any?>, context: Context)

This callback is invoked when the flow reports a custom analytics event intended for your own analytics. Events intended only for Adapty analytics are not delivered here.

onAwaitingPurchaseParams

abstract fun onAwaitingPurchaseParams(product: AdaptyPaywallProduct, context: Context, onPurchaseParamsReceived: AdaptyFlowEventListener.PurchaseParamsCallback): AdaptyFlowEventListener.PurchaseParamsCallback.IveBeenInvoked

This callback is invoked when user initiates the purchase process, providing the ability to supply an AdaptyPurchaseParameters object with additional purchase options.

onBackPressed

abstract fun onBackPressed(context: Context): Boolean

This callback is invoked when the user presses the system back button (or performs the back gesture) while the flow is shown, and no on_device_back action is configured for the current screen or its navigator. A configured on_device_back takes precedence and is handled internally without invoking this callback.

onError

abstract fun onError(error: AdaptyError, context: Context)

This callback is invoked in case of errors that are not tied to a specific purchase or restore flow, e.g. errors during the screen rendering process.

onFinishWebPaymentNavigation

abstract fun onFinishWebPaymentNavigation(product: AdaptyPaywallProduct?, error: AdaptyError?, context: Context)

This callback is invoked after attempting to navigate to the web payment url for a purchase.

onFlowClosed

abstract fun onFlowClosed()

This callback is invoked when the flow view was dismissed.

onFlowShown

abstract fun onFlowShown(context: Context)

This callback is invoked when the flow view was presented.

onLoadingProductsFailure

abstract fun onLoadingProductsFailure(error: AdaptyError, context: Context): Boolean

This callback is invoked in case of errors during the products loading process.

onProductSelected

abstract fun onProductSelected(product: AdaptyPaywallProduct, context: Context)

This callback is invoked when a product was selected for purchase (by user or by system).

onPurchaseFailure

abstract fun onPurchaseFailure(error: AdaptyError, product: AdaptyPaywallProduct, context: Context)

This callback is invoked when the purchase process fails.

onPurchaseFinished

abstract fun onPurchaseFinished(purchaseResult: AdaptyPurchaseResult, product: AdaptyPaywallProduct, context: Context)

This callback is invoked to inform on a canceled, successful, and pending purchase.

onPurchaseStarted

abstract fun onPurchaseStarted(product: AdaptyPaywallProduct, context: Context)

This callback is invoked when user initiates the purchase process.

onRestoreFailure

abstract fun onRestoreFailure(error: AdaptyError, context: Context)

This callback is invoked when the restore process fails.

onRestoreStarted

abstract fun onRestoreStarted(context: Context)

This callback is invoked when user initiates the restore process.

onRestoreSuccess

abstract fun onRestoreSuccess(profile: AdaptyProfile, context: Context)

This callback is invoked when a successful restore is made.

onShowAppRate

abstract fun onShowAppRate(context: Context)

This callback is invoked when the flow requests an app-rating prompt.

onShowRequestPermission

abstract fun onShowRequestPermission(permission: String?, customArgs: Map<String, String>?, callback: AdaptyFlowEventListener.PermissionCallback, context: Context)

This callback is invoked when the flow requests a runtime permission.