AdaptySDK 4.1.1
Loading...
Searching...
No Matches
AdaptySDK.IAdaptyFlowsEventsListener Interface Reference

Interface for listening to flow view events. More...

Public Member Functions

void FlowViewDidAppear (AdaptyUIFlowView view)
 Called when the flow view appears on screen.
void FlowViewDidDisappear (AdaptyUIFlowView view)
 Called when the flow view disappears from screen.
void FlowViewDidPerformAction (AdaptyUIFlowView view, AdaptyUIUserAction action)
 Called when a user performs an action in the flow view (e.g., close, system back, opening a URL, custom actions).
void FlowViewDidSelectProduct (AdaptyUIFlowView view, string productId)
 Called when a user selects a product in the flow view.
void FlowViewDidStartPurchase (AdaptyUIFlowView view, AdaptyPaywallProduct product)
 Called when a purchase is initiated for a product.
void FlowViewDidFinishPurchase (AdaptyUIFlowView view, AdaptyPaywallProduct product, AdaptyPurchaseResult purchasedResult)
 Called when a purchase is successfully completed.
void FlowViewDidFailPurchase (AdaptyUIFlowView view, AdaptyPaywallProduct product, AdaptyError error)
 Called when a purchase fails.
void FlowViewDidStartRestore (AdaptyUIFlowView view)
 Called when the restore purchases process is initiated.
void FlowViewDidFinishRestore (AdaptyUIFlowView view, AdaptyProfile profile)
 Called when the restore purchases process completes successfully.
void FlowViewDidFailRestore (AdaptyUIFlowView view, AdaptyError error)
 Called when the restore purchases process fails.
void FlowViewDidReceiveError (AdaptyUIFlowView view, AdaptyError error)
 Called when the flow view receives an error (including rendering failures).
void FlowViewDidFailLoadingProducts (AdaptyUIFlowView view, AdaptyError error)
 Called when the flow view fails to load products.
void FlowViewDidFinishWebPaymentNavigation (AdaptyUIFlowView view, AdaptyPaywallProduct product, AdaptyError error)
 Called when web payment navigation finishes (for web-based purchases).
void FlowViewDidReceiveAnalyticEvent (AdaptyUIFlowView view, string name, IReadOnlyDictionary< string, object > parameters)
 Called when the flow view emits a customer-facing analytics event.

Detailed Description

Interface for listening to flow view events.

Implement this interface to receive notifications about flow view lifecycle, user actions, purchases, and errors. Use Adapty.SetFlowsEventsListener(IAdaptyFlowsEventsListener) to register your listener. Note that the SDK applies no default behavior to these events: a successful purchase or an error does not dismiss the view automatically — call AdaptyUIFlowView.Dismiss(Action<AdaptyError>) yourself when appropriate.

Member Function Documentation

◆ FlowViewDidAppear()

void AdaptySDK.IAdaptyFlowsEventsListener.FlowViewDidAppear ( AdaptyUIFlowView view)

Called when the flow view appears on screen.

Parameters
viewThe AdaptyUIFlowView that appeared.

◆ FlowViewDidDisappear()

void AdaptySDK.IAdaptyFlowsEventsListener.FlowViewDidDisappear ( AdaptyUIFlowView view)

Called when the flow view disappears from screen.

Parameters
viewThe AdaptyUIFlowView that disappeared.

◆ FlowViewDidFailLoadingProducts()

void AdaptySDK.IAdaptyFlowsEventsListener.FlowViewDidFailLoadingProducts ( AdaptyUIFlowView view,
AdaptyError error )

Called when the flow view fails to load products.

Parameters
viewThe AdaptyUIFlowView that failed to load products.
errorThe AdaptyError object describing the error.

◆ FlowViewDidFailPurchase()

void AdaptySDK.IAdaptyFlowsEventsListener.FlowViewDidFailPurchase ( AdaptyUIFlowView view,
AdaptyPaywallProduct product,
AdaptyError error )

Called when a purchase fails.

Parameters
viewThe AdaptyUIFlowView where the purchase failed.
productThe AdaptyPaywallProduct that failed to purchase.
errorThe AdaptyError object describing the error.

◆ FlowViewDidFailRestore()

void AdaptySDK.IAdaptyFlowsEventsListener.FlowViewDidFailRestore ( AdaptyUIFlowView view,
AdaptyError error )

Called when the restore purchases process fails.

Parameters
viewThe AdaptyUIFlowView where the restore failed.
errorThe AdaptyError object describing the error.

◆ FlowViewDidFinishPurchase()

void AdaptySDK.IAdaptyFlowsEventsListener.FlowViewDidFinishPurchase ( AdaptyUIFlowView view,
AdaptyPaywallProduct product,
AdaptyPurchaseResult purchasedResult )

Called when a purchase is successfully completed.

The view is not dismissed automatically — call AdaptyUIFlowView.Dismiss(Action<AdaptyError>) if desired.

Parameters
viewThe AdaptyUIFlowView where the purchase was completed.
productThe AdaptyPaywallProduct that was purchased.
purchasedResultThe AdaptyPurchaseResult object containing purchase details.

◆ FlowViewDidFinishRestore()

void AdaptySDK.IAdaptyFlowsEventsListener.FlowViewDidFinishRestore ( AdaptyUIFlowView view,
AdaptyProfile profile )

Called when the restore purchases process completes successfully.

Parameters
viewThe AdaptyUIFlowView where the restore was completed.
profileThe updated AdaptyProfile object containing restored purchases.

◆ FlowViewDidFinishWebPaymentNavigation()

void AdaptySDK.IAdaptyFlowsEventsListener.FlowViewDidFinishWebPaymentNavigation ( AdaptyUIFlowView view,
AdaptyPaywallProduct product,
AdaptyError error )

Called when web payment navigation finishes (for web-based purchases).

Parameters
viewThe AdaptyUIFlowView where the navigation occurred.
productThe AdaptyPaywallProduct associated with the web payment, or null.
errorThe AdaptyError object, or null if no error occurred.

◆ FlowViewDidPerformAction()

void AdaptySDK.IAdaptyFlowsEventsListener.FlowViewDidPerformAction ( AdaptyUIFlowView view,
AdaptyUIUserAction action )

Called when a user performs an action in the flow view (e.g., close, system back, opening a URL, custom actions).

The Android system back button is delivered here as a system_back action and does not dismiss the view automatically. To keep the default URL behavior for open_url actions, call AdaptyUI.OpenUrl(string, AdaptyWebPresentation, Action<AdaptyError>).

Parameters
viewThe AdaptyUIFlowView where the action occurred.
actionThe AdaptyUIUserAction object describing the action.

◆ FlowViewDidReceiveAnalyticEvent()

void AdaptySDK.IAdaptyFlowsEventsListener.FlowViewDidReceiveAnalyticEvent ( AdaptyUIFlowView view,
string name,
IReadOnlyDictionary< string, object > parameters )

Called when the flow view emits a customer-facing analytics event.

Parameters
viewThe AdaptyUIFlowView where the event occurred.
nameThe name of the analytics event.
parametersThe parameters of the analytics event.

◆ FlowViewDidReceiveError()

void AdaptySDK.IAdaptyFlowsEventsListener.FlowViewDidReceiveError ( AdaptyUIFlowView view,
AdaptyError error )

Called when the flow view receives an error (including rendering failures).

The view is not dismissed automatically — call AdaptyUIFlowView.Dismiss(Action<AdaptyError>) if desired.

Parameters
viewThe AdaptyUIFlowView that received the error.
errorThe AdaptyError object describing the error.

◆ FlowViewDidSelectProduct()

void AdaptySDK.IAdaptyFlowsEventsListener.FlowViewDidSelectProduct ( AdaptyUIFlowView view,
string productId )

Called when a user selects a product in the flow view.

Parameters
viewThe AdaptyUIFlowView where the selection occurred.
productIdThe identifier of the selected product.

◆ FlowViewDidStartPurchase()

void AdaptySDK.IAdaptyFlowsEventsListener.FlowViewDidStartPurchase ( AdaptyUIFlowView view,
AdaptyPaywallProduct product )

Called when a purchase is initiated for a product.

Parameters
viewThe AdaptyUIFlowView where the purchase was initiated.
productThe AdaptyPaywallProduct being purchased.

◆ FlowViewDidStartRestore()

void AdaptySDK.IAdaptyFlowsEventsListener.FlowViewDidStartRestore ( AdaptyUIFlowView view)

Called when the restore purchases process is initiated.

Parameters
viewThe AdaptyUIFlowView where the restore was initiated.

The documentation for this interface was generated from the following file: