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 token will be automatically refreshed by the SDK.

Notifications


Enable/disable Push Notifications

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

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

Enable/disable In-App notification alerts

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

This parameter determines whether the SDK displays an additional alert in the application after receiving a notification.

If you have your own notifications implementation, you can disable In-App notification alerts from the Synerise SDK.

Set up App Group Identifier

Parameter Type Default
Synerise.settings.notifications.appGroupIdentifier String nil

This parameter identifies the group used by applications and extensions that your app belongs to.

Note: This property is required to allow the SDK communicating with Host App and its extensions to properly handle Rich Media Notifications.

Tracker


Minimum number of events in queue to send

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

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

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 to send

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

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

Timeout to send events automatically

Parameter Type Default Minimum Value Maximum Value
Synerise.settings.tracker.autoFlushTimeout TimeInterval 5.0 0.5 -

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.

Setup for location event to be sent automatically

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 auto-tracking functionality is enabled.

Auto-Tracking mode

Parameter Type Default
Synerise.settings.tracker.autoTracking.mode Bool DISABLED

This parameter sets the mode of auto-tracking.

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 Array []

This parameter excludes classes from Auto-Tracking.

View Tags excluded from Auto-Tracking

Parameter Type Default
Synerise.settings.tracker.autoTracking.excludedViewTags Array []

This parameter excludes view tags from Auto-Tracking.

Injector


Enable/disable automatic starting of Mobile Campaigns

Parameter Type Default
Synerise.settings.injector.automatic Bool false

This parameter specifies if Synerise Mobile Campaigns are processed automatically or not.

😕

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.