ExponeaPlugin class
Constructors
Properties
- hashCode → int
-
The hash code for this object.
no setterinherited
-
openedPushStream
→ Stream<
OpenedPush> -
A stream of opened push notifications.
The SDK will hold last data until you set the listener.
Don't forget to call cancel on the subscription when no longer listening.
no setter
-
receivedPushStream
→ Stream<
ReceivedPush> -
A stream of received push notifications.
Called for both regular and silent push notifications on Android, and silent notifications only on iOS.
The SDK will hold last data until you set the listener.
Don't forget to call cancel on the subscription when no longer listening.
no setter
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
anonymize(
[ExponeaConfigurationChange configurationChange = const ExponeaConfigurationChange()]) → Future< void> - Anonymize current customer and create a new one. Push token is cleared on Exponea backend. Optionally changes default Exponea project and event-project mapping.
-
checkPushSetup(
) → Future< void> - Enable automatic push notification diagnostics before configuring the SDK to help you with push notification integration.
-
configure(
ExponeaConfiguration configuration) → Future< bool> - Configure Exponea SDK. Should only be called once. You need to configure ExponeaSDK before calling most methods. Returns true if configuration was successful. Returns false if sdk was already configured.
-
fetchAppInbox(
) → Future< List< AppInboxMessage> > - Fetches AppInbox for the current customer
-
fetchAppInboxItem(
String messageId) → Future< AppInboxMessage> - Fetches AppInbox message by ID for the current customer
-
fetchConsents(
) → Future< List< Consent> > - Fetch consents for the current customer.
-
fetchRecommendations(
RecommendationOptions options) → Future< List< Recommendation> > - Fetch recommendations based on RecommendationOptions.
-
flushData(
) → Future< void> - Flush data to Exponea backend. Only usable in FlushMode.manual.
-
getCustomerCookie(
) → Future< String> - Get cookie of the current customer.
-
getDefaultProperties(
) → Future< Map< String, dynamic> > - Get default properties tracked with every event
-
getFlushMode(
) → Future< FlushMode> -
Get current
FlushModeused by the SDK. -
getFlushPeriod(
) → Future< Duration> - Get the period with which events are tracked to Exponea backend. Only valid in FlushMode.period.
-
getLogLevel(
) → Future< LogLevel> -
Get current
LogLevelnative SDK uses. -
identifyCustomer(
Customer customer) → Future< void> - Identify current customer with new customer ids and properties.
-
inAppMessageActionStream(
{bool overrideDefaultBehavior = false, bool trackActions = true}) → Stream< InAppMessageAction> - A stream of In-app message actions. The SDK will hold last data until you set the listener. Don't forget to call cancel on the subscription when no longer listening. If overrideDefaultBehavior is set to true, default in-app action will not be performed ( e.g. deep link ) If trackActions is set to false, click and close in-app events will not be tracked automatically
-
isConfigured(
) → Future< bool> - Check whether Exponea SDK is configured.
-
markAppInboxAsRead(
AppInboxMessage message) → Future< bool> - Marks AppInbox message as read
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
requestIosPushAuthorization(
) → Future< bool> - Request push authorization on iOS.
-
requestPushAuthorization(
) → Future< bool> - Request push authorization on Android or iOS.
-
setAppInboxProvider(
AppInboxStyle style) → Future< void> - Set AppInboxProvider
-
setDefaultProperties(
Map< String, dynamic> properties) → Future<void> - Set default properties tracked with every event. Only use for reconfiguration, preferred way of setting default properties is configuration object.
-
setFlushMode(
FlushMode mode) → Future< void> - Set the Flush mode used by the SDK.
-
setFlushPeriod(
Duration period) → Future< void> - Set the period with which events are tracked to Exponea backend. Only valid in FlushMode.period.
-
setLogLevel(
LogLevel level) → Future< void> - Set LogLevel for native SDK.
-
toString(
) → String -
A string representation of this object.
inherited
-
trackAppInboxClick(
AppInboxAction action, AppInboxMessage message) → Future< void> - Track AppInbox message click event Event is tracked if one or both conditions met: - parameter 'message' has TRUE value of 'hasTrackingConsent' property - parameter 'buttonLink' has TRUE value of query parameter 'xnpe_force_track'
-
trackAppInboxClickWithoutTrackingConsent(
AppInboxAction action, AppInboxMessage message) → Future< void> - Track AppInbox message click event
-
trackAppInboxOpened(
AppInboxMessage message) → Future< void> - Track AppInbox message detail opened event Event is tracked if parameter 'message' has TRUE value of 'hasTrackingConsent' property
-
trackAppInboxOpenedWithoutTrackingConsent(
AppInboxMessage message) → Future< void> - Track AppInbox message detail opened event
-
trackEvent(
Event event) → Future< void> - Track custom event to Exponea backend.
-
trackSessionEnd(
{DateTime? timestamp}) → Future< void> - Manually track session end. Only usable when ExponeaConfiguration.automaticSessionTracking is disabled. NOTE: iOS doesn't support using a specific timestamp.
-
trackSessionStart(
{DateTime? timestamp}) → Future< void> - Manually track session start. Only usable when ExponeaConfiguration.automaticSessionTracking is disabled. NOTE: iOS doesn't support using a specific timestamp.
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited