AdaptySDK.AdaptyOnboardingsEventsListener Interface Reference

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

Public Member Functions
void	OnboardingViewDidFailWithError (AdaptyUIOnboardingView view, AdaptyError error)
	Called when the onboarding view fails with an error.
void	OnboardingViewDidFinishLoading (AdaptyUIOnboardingView view, AdaptyUIOnboardingMeta meta)
	Called when the onboarding view finishes loading.
void	OnboardingViewOnCloseAction (AdaptyUIOnboardingView view, AdaptyUIOnboardingMeta meta, string actionId)
	Called when a close action is triggered in the onboarding view.
void	OnboardingViewOnPaywallAction (AdaptyUIOnboardingView view, AdaptyUIOnboardingMeta meta, string actionId)
	Called when a paywall action is triggered in the onboarding view.
void	OnboardingViewOnCustomAction (AdaptyUIOnboardingView view, AdaptyUIOnboardingMeta meta, string actionId)
	Called when a custom action is triggered in the onboarding view.
void	OnboardingViewOnStateUpdatedAction (AdaptyUIOnboardingView view, AdaptyUIOnboardingMeta meta, string elementId, AdaptyOnboardingsStateUpdatedParams @params)
	Called when the state of an element in the onboarding view is updated.
void	OnboardingViewOnAnalyticsEvent (AdaptyUIOnboardingView view, AdaptyUIOnboardingMeta meta, AdaptyOnboardingsAnalyticsEvent analyticsEvent)
	Called when an analytics event is triggered in the onboarding view.

Detailed Description

Interface for listening to onboarding view events.

Implement this interface to receive notifications about onboarding view lifecycle, user actions, and analytics events. Use Adapty.SetOnboardingsEventsListener(AdaptyOnboardingsEventsListener) to register your listener.

Member Function Documentation

OnboardingViewDidFailWithError()

void AdaptySDK.AdaptyOnboardingsEventsListener.OnboardingViewDidFailWithError	(	AdaptyUIOnboardingView	view,
		AdaptyError	error )

Called when the onboarding view fails with an error.

Parameters

view	The AdaptyUIOnboardingView that failed.
error	The AdaptyError object describing the error.

OnboardingViewDidFinishLoading()

void AdaptySDK.AdaptyOnboardingsEventsListener.OnboardingViewDidFinishLoading	(	AdaptyUIOnboardingView	view,
		AdaptyUIOnboardingMeta	meta )

Called when the onboarding view finishes loading.

Parameters

view	The AdaptyUIOnboardingView that finished loading.
meta	The AdaptyUIOnboardingMeta object containing onboarding metadata.

OnboardingViewOnAnalyticsEvent()

void AdaptySDK.AdaptyOnboardingsEventsListener.OnboardingViewOnAnalyticsEvent	(	AdaptyUIOnboardingView	view,
		AdaptyUIOnboardingMeta	meta,
		AdaptyOnboardingsAnalyticsEvent	analyticsEvent )

Called when an analytics event is triggered in the onboarding view.

Parameters

view	The AdaptyUIOnboardingView where the event occurred.
meta	The AdaptyUIOnboardingMeta object containing onboarding metadata.
analyticsEvent	The AdaptyOnboardingsAnalyticsEvent object containing analytics event data.

OnboardingViewOnCloseAction()

void AdaptySDK.AdaptyOnboardingsEventsListener.OnboardingViewOnCloseAction	(	AdaptyUIOnboardingView	view,
		AdaptyUIOnboardingMeta	meta,
		string	actionId )

Called when a close action is triggered in the onboarding view.

Parameters

view	The AdaptyUIOnboardingView where the action occurred.
meta	The AdaptyUIOnboardingMeta object containing onboarding metadata.
actionId	The identifier of the close action.

OnboardingViewOnCustomAction()

void AdaptySDK.AdaptyOnboardingsEventsListener.OnboardingViewOnCustomAction	(	AdaptyUIOnboardingView	view,
		AdaptyUIOnboardingMeta	meta,
		string	actionId )

Called when a custom action is triggered in the onboarding view.

Parameters

view	The AdaptyUIOnboardingView where the action occurred.
meta	The AdaptyUIOnboardingMeta object containing onboarding metadata.
actionId	The identifier of the custom action.

OnboardingViewOnPaywallAction()

void AdaptySDK.AdaptyOnboardingsEventsListener.OnboardingViewOnPaywallAction	(	AdaptyUIOnboardingView	view,
		AdaptyUIOnboardingMeta	meta,
		string	actionId )

Called when a paywall action is triggered in the onboarding view.

Parameters

view	The AdaptyUIOnboardingView where the action occurred.
meta	The AdaptyUIOnboardingMeta object containing onboarding metadata.
actionId	The identifier of the paywall action.

OnboardingViewOnStateUpdatedAction()

void AdaptySDK.AdaptyOnboardingsEventsListener.OnboardingViewOnStateUpdatedAction	(	AdaptyUIOnboardingView	view,
		AdaptyUIOnboardingMeta	meta,
		string	elementId,
		AdaptyOnboardingsStateUpdatedParams @	params )

Called when the state of an element in the onboarding view is updated.

Parameters

view	The AdaptyUIOnboardingView where the update occurred.
meta	The AdaptyUIOnboardingMeta object containing onboarding metadata.
elementId	The identifier of the element whose state was updated.
params	The AdaptyOnboardingsStateUpdatedParams object containing the updated state parameters.

---

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

• AdaptyEventListener.cs