Grovs class

Main class for interacting with the Grovs SDK

Constructors

Grovs()

Properties

hashCode → int
The hash code for this object.
no setterinherited
onDeeplinkReceived → Stream<DeeplinkDetails>
Stream of deeplink events
no setter
onError → Stream<GrovsError>
Stream of asynchronous SDK errors on iOS.
no setter
onInAppMessage → Stream<InAppMessageEvent>
Stream of in-app message events, such as shown, clicked and dismissed.
no setter
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

discardInAppMessages({bool dismissCurrent = false}) → Future<void>
Drop the in-app messages that are queued to show.
Generate a Grovs link with the specified parameters
getPlatformVersion() → Future<String?>
Get the platform version
handleNotificationOpen(Map<String, dynamic> data) → Future<bool>
Record a tap on a Grovs push notification, so the tap is counted and the notification's link is opened.
handleUrl(String url) → Future<bool>
Resolve a Grovs link that was tapped inside your app.
isGrovsNotification(Map<String, dynamic> data) → Future<bool>
Whether a push payload was sent by Grovs.
linkDetails(String path) → Future<GrovsLinkDetails>
Fetch the details of a Grovs link
logCustomPurchase({required TransactionType type, required int priceInCents, required String currency, required String productId, DateTime? startDate}) → Future<void>
Log a custom purchase for revenue tracking
logInAppPurchase(String transactionId) → Future<void>
Log an in-app purchase from the platform store
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
pauseInAppMessages() → Future<void>
Hold back in-app messages until resumeInAppMessages is called.
resumeInAppMessages() → Future<void>
Allow in-app messages to show again after pauseInAppMessages or discardInAppMessages.
setDebugLevel(String level) → Future<void>
Set debug level for logging
setGlobalTags(List<String>? tags) → Future<void>
Set global tags applied to every subsequent custom event
setInAppDebugLogging(bool enabled) → Future<void>
Turn the in-app message debug logs on or off.
setInAppExcludedScreens(List<String> screens) → Future<void>
Set the screens where in-app messages are not shown.
setPushToken(String token) → Future<void>
Set push notification token
setScreenAliases(Map<String, String> aliases) → Future<void>
Set screen aliases (raw screen name → friendly name)
setSDK(bool enabled) → Future<void>
Enable or disable the SDK at runtime.
setUserAttributes(Map<String, dynamic> attributes) → Future<void>
Set user attributes
setUserIdentifier(String identifier) → Future<void>
Set the user identifier
toString() → String
A string representation of this object.
inherited
track(String name, {Map<String, dynamic>? properties, List<String>? tags}) → Future<void>
Log a custom analytics event
trackScreenView(String screenName, {Map<String, dynamic>? properties}) → Future<void>
Log a manual screen view

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Properties

A shared GrovsNavigatorObserver for automatic screen tracking.
no setter
screenAliases → Map<String, String>
The current screen aliases. Read by GrovsNavigatorObserver.
no setter