Settings

The settings module in our SDK allows you to easily set some options directly from your application to change some of SDK behaviors without a need to reinitialize.

This article lists the currently available methods.

General

Enable/disable SDK

Parameter Type Default
Synerise.settings.sdk.enabled Bool true

This parameter specifies if the SDK functionalities are enabled.


Minimum time interval to refresh token

Parameter Type Default Minimum Value Maximum Value
Synerise.settings.sdk.minTokenRefreshInterval TimeInterval 1800 1800 -

This parameter sets a time interval (in seconds) counting backwards from the expiration time. Within this time, the authorization token will be automatically refreshed by the SDK.

Notifications

Enable/disable notifications

Parameter Type Default
Synerise.settings.notifications.enabled Bool true

This parameter specifies if handling notifications by the SDK is enabled.


Tracker

Minimum number of events in queue

Parameter Type Default Minimum Value Maximum Value
Synerise.settings.tracker.minBatchSize Integer 10 1 100

This parameter sets the minimum number of events in queue required to send the queue.

Note: If the timer runs out, events are sent even if the queue is smaller than defined in minBatchSize.

Maximum number of events in queue

Parameter Type Default Minimum Value Maximum Value
Synerise.settings.tracker.maxBatchSize Integer 100 1 100

This parameter sets the maximum number of events which may be sent in a single batch.


Interval between sending attempts

Parameter Type Default Minimum Value Maximum Value
Synerise.settings.tracker.autoFlushTimeout TimeInterval 5000 50 -

This parameter sets the time (in milliseconds) required before an attempt is made to sent the queue.

Note: If the minimum queue size is met, events are sent even if the timer has not run out.

Automatic location event sending

Parameter Type Default
Synerise.settings.tracker.locationAutomatic Bool false

This parameter specifies if location events are sent automatically.


Enable/disable Declarative Tracking

Parameter Type Default
Synerise.settings.tracker.tracking.enabled Bool true

This parameter specifies if the Declarative Tracking functionality is enabled.


Enable/disable auto-tracking

Parameter Type Default
Synerise.settings.tracker.autoTracking.enabled Bool true

This parameter specifies if the auto-tracking functionality is enabled.


Auto-tracking mode

Parameter Type Default
Synerise.settings.tracker.autoTracking.trackMode TrackMode DISABLED

This parameter defines the auto-tracking mode.

Available modes:

  • DISABLED - listeners are disabled (default).
  • EAGER - listeners are set to on-touch only.
  • PLAIN - listeners are set to on-click only.
  • FINE - listeners are attached to nearly everything in your app (even to activities and viewDidAppear, the method that records VisitedScreen events).

Classes excluded from auto-tracking

Parameter Type Default
Synerise.settings.tracker.autoTracking.excludedClasses List<Object> []

This parameter excludes classes from auto-tracking.

😕

We are sorry to hear that

Thank you for helping improve out documentation. If you need help or have any questions, please consider contacting support.

😉

Awesome!

Thank you for helping improve out documentation. If you need help or have any questions, please consider contacting support.