Settings

There is a settings module available in our SDK that allows you to easily set some options directly from your Application. Thanks to this, you can change some SDK behaviors without a need to reinitialize.

As of now, we have the following settings grouped for the functionality in our SDK:

General

Enable/disable SDK

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

This parameter specifies if all of the SDK functionalities are enabled.


Minimum interval time to refresh token

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

This parameter sets a time interval counting backwards from the expiration time. Within this time, the 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.


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: Adding any event to a queue runs auto flush, so even a queue with fewer events than the minimum will attempt to be sent.

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 required to elapse before event’s queue will attempt to be sent.


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 Declarative Tracking functionality is enabled.


Enable/disable AutoTracking

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

This parameter specifies if AutoTracking functionality is enabled.


AutoTracking mode

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

This parameter sets mode of AutoTracking.

Available modes:

DISABLED - listeners are disabled, which is default mode.

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: method to record VisitedScreen events).


Excluded Classes from AutoTracking

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

This parameter sets excluded classes from AutoTracking.


Excluded View Tags from AutoTracking

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

This parameter sets excluded view tags from AutoTracking.


Injector

Enable/disable automatic starting Mobile Campaigns

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

This parameter specifies that if Synerise Mobile Campaigns shall be treated 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.