ProductAnalyticsOptions class
Represents options to pass to the Product Analytics configuration.
Constructors
- ProductAnalyticsOptions({bool? captureVendorId, bool? captureAdvertiserId, bool? clearEventPropertiesOnNewUser, bool? enableInteractionsAutocapture, bool? disablePageviewAutocapture, bool? disablePageviewTitleAutocapture, bool? disableInteractionAutocapture, bool? enablePushNotificationAutocapture, bool? enablePushNotificationTitleAutocapture, bool? enablePushNotificationBodyAutocapture, bool? resumePreviousSession, bool? disableScreenviewForwardToDXA, bool? disableScreenviewForwardToPA, Uri? baseUrl, Duration? uploadInterval, int? messageBatchByteLimit, int? messageBatchMessageLimit, int? pruningLookBackWindow, int? maximumDatabaseSize, int? maximumBatchCountPerUpload})
-
Creates a new instance of ProductAnalyticsOptions.
const
Properties
- baseUrl → Uri?
-
The base URL for the desired API endpoint
final
- captureAdvertiserId → bool?
-
Controls whether to capture advertiser ID
When true, advertiser ID will be captured
final
- captureVendorId → bool?
-
Controls whether to capture vendor ID
When true, vendor ID will be captured
final
- clearEventPropertiesOnNewUser → bool?
-
Controls whether to clear event properties on new user
When true, event properties will be cleared when a new user is detected
final
- disableInteractionAutocapture → bool?
-
Controls whether to disable interaction autocapture
When true, interaction autocapture will be disabled
final
- disablePageviewAutocapture → bool?
-
Controls whether to disable pageview autocapture
When true, pageview autocapture will be disabled
final
- disablePageviewTitleAutocapture → bool?
-
Controls whether to disable pageview title autocapture
When true, pageview title autocapture will be disabled
final
- disableScreenviewForwardToDXA → bool?
-
Controls whether to disable screenview forwarding to DXA
When true, screenview forwarding to DXA will be disabled
final
- disableScreenviewForwardToPA → bool?
-
Controls whether to disable screenview forwarding to PA
When true, screenview forwarding to PA will be disabled
final
- enableInteractionsAutocapture → bool?
-
Controls whether to enable Flutter interactions autocapture.
When true, interactions autocapture will be enabled.
When false or null, interactions will not be autocaptured.
final
- enablePushNotificationAutocapture → bool?
-
Controls whether to enable push notification autocapture
When true, push notification autocapture will be enabled
final
- enablePushNotificationBodyAutocapture → bool?
-
Controls whether to enable push notification body autocapture
When true, push notification body autocapture will be enabled
final
- enablePushNotificationTitleAutocapture → bool?
-
Controls whether to enable push notification title autocapture
When true, push notification title autocapture will be enabled
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- maximumBatchCountPerUpload → int?
-
The maximum number of batches to send per upload cycle. This can be
used in conjunction with messageBatchMessageLimit to control the amount
of data that is uploaded in a given cycle.
final
- maximumDatabaseSize → int?
-
The maximum size, in bytes, to allocate for the local event storage database.
final
- messageBatchByteLimit → int?
-
The maximum size of a batch of messages in bytes.
final
- messageBatchMessageLimit → int?
-
The maximum number of messages in a batch.
final
-
props
→ List<
Object?> -
The list of properties that will be used to determine whether
two instances are equal.
no setter
- pruningLookBackWindow → int?
-
The number of days to look back when pruning old data.
final
- resumePreviousSession → bool?
-
Controls whether to resume previous session
When true, the previous session will be resumed
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- stringify → bool?
-
If set to
true, thetoStringmethod will be overridden to output this instance'sprops.no setterinherited - uploadInterval → Duration?
-
The frequency at which events are uploaded.
final
Methods
-
copyWith(
{bool? captureVendorId, bool? captureAdvertiserId, bool? clearEventPropertiesOnNewUser, bool? enableInteractionsAutocapture, bool? disablePageviewAutocapture, bool? disablePageviewTitleAutocapture, bool? disableInteractionAutocapture, bool? enablePushNotificationAutocapture, bool? enablePushNotificationTitleAutocapture, bool? enablePushNotificationBodyAutocapture, bool? resumePreviousSession, bool? disableScreenviewForwardToDXA, bool? disableScreenviewForwardToPA, Uri? baseUrl, Duration? uploadInterval, int? messageBatchByteLimit, int? messageBatchMessageLimit, int? pruningLookBackWindow, int? maximumDatabaseSize, int? maximumBatchCountPerUpload}) → ProductAnalyticsOptions - Creates a copy of this ProductAnalyticsOptions with the given fields replaced by the new values.
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited