amplitude_engagement library

Classes

AmplitudeCardEmbedView
Anchors an inline card embed to child.
AmplitudeEngagementView
A SemanticsTag that provides an explicit, stable identifier for element targeting. When present on a SemanticsNode, this identifier takes precedence over the node's accessibility label.
AmplitudeInitOptions
GuideOrSurvey

Enums

AmplitudeCardPosition
Where an inline card embed renders relative to the AmplitudeCardEmbedView child.
AmplitudeLogLevel
AmplitudeServerZone
AmplitudeThemeMode

Functions

addCallback(String key, dynamic callback()) → Future<void>
Add a callback to execute Dart code when triggered from a guide or survey.
boot({String? userId, String? deviceId, Map<String, dynamic>? userProperties, List<AmplitudeIntegration>? integrations}) → Future<void>
Boot the SDK.
closeAll() → Future<void>
Close all currently displayed guides and surveys.
disable() → Future<void>
Temporarily disable the SDK.
disableElementTargeting() → Future<void>
Stop listening for semantics tree changes and clear the native element store.
enable() → Future<void>
Re-enable the SDK after it has been disabled with disable.
enableElementTargeting() → void
Start listening for semantics tree changes and send element positions to the native SDK for tooltip/nudge anchoring.
forwardEvent(Map<String, dynamic> event) → Future<void>
Forward third-party analytics events to the Guides and Surveys SDK.
handleURL(String url) → Future<bool>
Handle a deep link URL for preview mode.
init(String apiKey, {AmplitudeInitOptions? options}) → Future<bool>
Initialize the Amplitude Engagement SDK (standalone native instance).
installAmplitudeEngagementPlugin(Amplitude amplitude, {AmplitudeInitOptions? options}) → Future<void>
Installs the Amplitude Engagement SDK as an Analytics plugin.
list() → Future<List<GuideOrSurvey>>
Retrieve a list of all live guides and surveys along with their status.
reset(String key, [int stepIndex = 0]) → Future<void>
Reset a guide or survey to a specific step.
resetEngagementForTesting() → void
Resets global engagement state. Only intended for use in tests.
screen(String screenName) → Future<void>
Track a screen view.
setRouter(void router(String url)) → Future<void>
Sets the router used for "Go to screen" actions in guides and surveys.
setSessionProperty(String key, Object value) → Future<void>
Set a session property for the current session.
setThemeMode(AmplitudeThemeMode themeMode) → Future<void>
Set the theme mode for the SDK.
show(String key, [int stepIndex = 0]) → Future<void>
Display a specific guide or survey.
shutdown() → Future<void>
Shut down the SDK.
unsetRouter() → Future<void>
Removes the router set with setRouter.
updateLanguage(String locale) → Future<void>
Update the locale used by the engagement SDK.

Typedefs

AmplitudeIntegration = void Function(String eventType, Map<String, dynamic> eventProperties)
Receives an event tracked by the Guides and Surveys SDK.