AdaptySDK 4.1.1
Loading...
Searching...
No Matches
AdaptySDK.AdaptyUI Class Reference

Building, presenting and dismissing the views that render a flow. More...

Static Public Member Functions

static void CreateFlowView (AdaptyFlow flow, AdaptyUICreateFlowViewParameters optionalParameters, Action< AdaptyUIFlowView, AdaptyError > completionHandler)
 Creates a flow view from an AdaptyFlow object.
static void DismissFlowView (AdaptyUIFlowView view, Action< AdaptyError > completionHandler)
 Dismisses the flow view.
static void PresentFlowView (AdaptyUIFlowView view, Action< AdaptyError > completionHandler)
 Call this function if you wish to present the view.
static void PresentFlowView (AdaptyUIFlowView view, AdaptyUIIOSPresentationStyle iosPresentationStyle, Action< AdaptyError > completionHandler)
 Call this function if you wish to present the view.
static void ShowDialog (AdaptyUIFlowView view, AdaptyUIDialogConfiguration configuration, Action< AdaptyUIDialogActionType, AdaptyError > completionHandler)
 Presents a dialog on the flow view.
static void OpenUrl (string url, AdaptyWebPresentation openIn, Action< AdaptyError > completionHandler)
 Opens the URL natively, honoring the presentation option.
static void RequestAppReview (Action< AdaptyError > completionHandler)
 Requests a native store review prompt (App Store / Google Play in-app review).
static void CreateFlowView (AdaptyFlow flow, Action< AdaptyUIFlowView, AdaptyError > completionHandler)
 Creates a flow view from an AdaptyFlow object.
static void CreateOnboardingView (AdaptyOnboarding onboarding, AdaptyWebPresentation externalUrlsPresentation, Action< AdaptyUIOnboardingView, AdaptyError > completionHandler)
 Creates an onboarding view from an AdaptyOnboarding object.
static void PresentOnboardingView (AdaptyUIOnboardingView view, Action< AdaptyError > completionHandler)
 Presents the onboarding view to the user.
static void PresentOnboardingView (AdaptyUIOnboardingView view, AdaptyUIIOSPresentationStyle iosPresentationStyle, Action< AdaptyError > completionHandler)
 Presents the onboarding view to the user with a specified presentation style.
static void DismissOnboardingView (AdaptyUIOnboardingView view, Action< AdaptyError > completionHandler)
 Dismisses the onboarding view.
static void ShowDialog (AdaptyUIOnboardingView view, AdaptyUIDialogConfiguration configuration, Action< AdaptyUIDialogActionType, AdaptyError > completionHandler)
 Presents a dialog on the onboarding view.
static void CreateOnboardingView (AdaptyOnboarding onboarding, Action< AdaptyUIOnboardingView, AdaptyError > completionHandler)
 Creates an onboarding view from an AdaptyOnboarding object.

Static Package Functions

static void FlowViewAnswerPermission (string eventId, bool granted, string detail)
static void SendObserverEvent (string method, string eventId)

Static Private Member Functions

static void ShowDialog (string viewId, AdaptyUIDialogConfiguration configuration, Action< AdaptyUIDialogActionType, AdaptyError > completionHandler)
static void LogRoundTripError (string method, AdaptyError error)
static void DismissOnboardingView (AdaptyUIOnboardingView view, bool destroy, Action< AdaptyError > completionHandler)

Detailed Description

Building, presenting and dismissing the views that render a flow.

Member Function Documentation

◆ CreateFlowView() [1/2]

void AdaptySDK.AdaptyUI.CreateFlowView ( AdaptyFlow flow,
Action< AdaptyUIFlowView, AdaptyError > completionHandler )
static

Creates a flow view from an AdaptyFlow object.

Right after receiving an AdaptyFlow, you can create the corresponding AdaptyUIFlowView to present it afterwards. Read more at Adapty Documentation

Parameters
flowAn AdaptyFlow object for which you are trying to create a view.
completionHandlerThe action that will be called with the result. The result contains an AdaptyUIFlowView object.

◆ CreateFlowView() [2/2]

void AdaptySDK.AdaptyUI.CreateFlowView ( AdaptyFlow flow,
AdaptyUICreateFlowViewParameters optionalParameters,
Action< AdaptyUIFlowView, AdaptyError > completionHandler )
static

Creates a flow view from an AdaptyFlow object.

Right after receiving an AdaptyFlow, you can create the corresponding AdaptyUIFlowView to present it afterwards. Read more at Adapty Documentation

Parameters
flowAn AdaptyFlow object for which you are trying to create a view.
optionalParametersAn optional AdaptyUICreateFlowViewParameters object that contains optional parameters like load timeout, custom tags, custom timers, product purchase parameters, and custom assets.
completionHandlerThe action that will be called with the result. The result contains an AdaptyUIFlowView object.

◆ CreateOnboardingView() [1/2]

void AdaptySDK.AdaptyUI.CreateOnboardingView ( AdaptyOnboarding onboarding,
Action< AdaptyUIOnboardingView, AdaptyError > completionHandler )
static

Creates an onboarding view from an AdaptyOnboarding object.

Parameters
onboardingAn AdaptyOnboarding object for which you are trying to create a view.
completionHandlerThe action that will be called with the result. The result contains an AdaptyUIOnboardingView object.

◆ CreateOnboardingView() [2/2]

void AdaptySDK.AdaptyUI.CreateOnboardingView ( AdaptyOnboarding onboarding,
AdaptyWebPresentation externalUrlsPresentation,
Action< AdaptyUIOnboardingView, AdaptyError > completionHandler )
static

Creates an onboarding view from an AdaptyOnboarding object.

Right after receiving an AdaptyOnboarding, you can create the corresponding AdaptyUIOnboardingView to present it afterwards. Read more at Adapty Documentation

Parameters
onboardingAn AdaptyOnboarding object for which you are trying to create a view.
externalUrlsPresentationControls how external URLs are presented in the onboarding (in-app browser vs external browser). Default is AdaptyWebPresentation.ExternalBrowser.
completionHandlerThe action that will be called with the result. The result contains an AdaptyUIOnboardingView object.

◆ DismissFlowView()

void AdaptySDK.AdaptyUI.DismissFlowView ( AdaptyUIFlowView view,
Action< AdaptyError > completionHandler )
static

Dismisses the flow view.

Call this method when you want to dismiss the flow view from the screen. A dismissed view is released and cannot be presented again — create a new view via CreateFlowView(AdaptyFlow, AdaptyUICreateFlowViewParameters, Action<AdaptyUIFlowView, AdaptyError>) if you need to re-present it.

Parameters
viewAn AdaptyUIFlowView object representing the view to dismiss.
completionHandlerThe action that will be called with the result.

◆ DismissOnboardingView() [1/2]

void AdaptySDK.AdaptyUI.DismissOnboardingView ( AdaptyUIOnboardingView view,
Action< AdaptyError > completionHandler )
static

Dismisses the onboarding view.

Call this method when you want to dismiss the onboarding view from the screen.

Parameters
viewAn AdaptyUIOnboardingView object representing the view to dismiss.
completionHandlerThe action that will be called with the result.

◆ DismissOnboardingView() [2/2]

void AdaptySDK.AdaptyUI.DismissOnboardingView ( AdaptyUIOnboardingView view,
bool destroy,
Action< AdaptyError > completionHandler )
staticprivate

◆ FlowViewAnswerPermission()

void AdaptySDK.AdaptyUI.FlowViewAnswerPermission ( string eventId,
bool granted,
string detail )
staticpackage

◆ LogRoundTripError()

void AdaptySDK.AdaptyUI.LogRoundTripError ( string method,
AdaptyError error )
staticprivate

◆ OpenUrl()

void AdaptySDK.AdaptyUI.OpenUrl ( string url,
AdaptyWebPresentation openIn,
Action< AdaptyError > completionHandler )
static

Opens the URL natively, honoring the presentation option.

This is the same handling the SDK applies by default to open_url user actions. Use it when you override IAdaptyFlowsEventsListener.FlowViewDidPerformAction(AdaptyUIFlowView, AdaptyUIUserAction) and want to keep the default URL behavior.

Parameters
urlThe URL to open.
openInControls whether to open in external browser or in-app browser. Default is AdaptyWebPresentation.ExternalBrowser.
completionHandlerThe action that will be called with the result.

◆ PresentFlowView() [1/2]

void AdaptySDK.AdaptyUI.PresentFlowView ( AdaptyUIFlowView view,
Action< AdaptyError > completionHandler )
static

Call this function if you wish to present the view.

Parameters
viewan [AdaptyUIFlowView] object, for which is representing the view.
completionHandlerThe action that will be called with the result.

◆ PresentFlowView() [2/2]

void AdaptySDK.AdaptyUI.PresentFlowView ( AdaptyUIFlowView view,
AdaptyUIIOSPresentationStyle iosPresentationStyle,
Action< AdaptyError > completionHandler )
static

Call this function if you wish to present the view.

Parameters
viewan [AdaptyUIFlowView] object, for which is representing the view.
iosPresentationStylean [AdaptyUIIOSPresentationStyle] object, for which is representing the iOS presentation style.
completionHandlerThe action that will be called with the result.

◆ PresentOnboardingView() [1/2]

void AdaptySDK.AdaptyUI.PresentOnboardingView ( AdaptyUIOnboardingView view,
Action< AdaptyError > completionHandler )
static

Presents the onboarding view to the user.

This method presents the onboarding view using the default full-screen presentation style.

Parameters
viewAn AdaptyUIOnboardingView object representing the view to present.
completionHandlerThe action that will be called with the result.

◆ PresentOnboardingView() [2/2]

void AdaptySDK.AdaptyUI.PresentOnboardingView ( AdaptyUIOnboardingView view,
AdaptyUIIOSPresentationStyle iosPresentationStyle,
Action< AdaptyError > completionHandler )
static

Presents the onboarding view to the user with a specified presentation style.

This method presents the onboarding view using the specified iOS presentation style (iOS only).

Parameters
viewAn AdaptyUIOnboardingView object representing the view to present.
iosPresentationStyleAn AdaptyUIIOSPresentationStyle object representing the iOS presentation style (iOS only).
completionHandlerThe action that will be called with the result.

◆ RequestAppReview()

void AdaptySDK.AdaptyUI.RequestAppReview ( Action< AdaptyError > completionHandler)
static

Requests a native store review prompt (App Store / Google Play in-app review).

This is the same handling the SDK applies by default to the flow app review request. Use it when you override IAdaptyUISystemRequestsHandler.FlowViewDidRequestAppReview(AdaptyUIFlowView) and want to keep the default behavior.

Parameters
completionHandlerThe action that will be called with the result.

◆ SendObserverEvent()

void AdaptySDK.AdaptyUI.SendObserverEvent ( string method,
string eventId )
staticpackage

◆ ShowDialog() [1/3]

void AdaptySDK.AdaptyUI.ShowDialog ( AdaptyUIFlowView view,
AdaptyUIDialogConfiguration configuration,
Action< AdaptyUIDialogActionType, AdaptyError > completionHandler )
static

Presents a dialog on the flow view.

This method shows a dialog with custom configuration on the flow view. The dialog can be used for various purposes like showing terms, privacy policy, or custom messages.

Parameters
viewAn AdaptyUIFlowView object representing the view on which to show the dialog.
configurationAn AdaptyUIDialogConfiguration object that contains the dialog configuration.
completionHandlerThe action that will be called with the result. The result contains the AdaptyUIDialogActionType indicating which action was taken.

◆ ShowDialog() [2/3]

void AdaptySDK.AdaptyUI.ShowDialog ( AdaptyUIOnboardingView view,
AdaptyUIDialogConfiguration configuration,
Action< AdaptyUIDialogActionType, AdaptyError > completionHandler )
static

Presents a dialog on the onboarding view.

This method shows a dialog with custom configuration on the onboarding view. The dialog can be used for various purposes like showing terms, privacy policy, or custom messages.

Parameters
viewAn AdaptyUIOnboardingView object representing the view on which to show the dialog.
configurationAn AdaptyUIDialogConfiguration object that contains the dialog configuration.
completionHandlerThe action that will be called with the result. The result contains the AdaptyUIDialogActionType indicating which action was taken.

◆ ShowDialog() [3/3]

void AdaptySDK.AdaptyUI.ShowDialog ( string viewId,
AdaptyUIDialogConfiguration configuration,
Action< AdaptyUIDialogActionType, AdaptyError > completionHandler )
staticprivate

The documentation for this class was generated from the following files: