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 | Compability | Type | Default |
|---|---|---|---|
Synerise.Settings.sdk.enabled |
iOS, Android | boolean |
true |
This parameter specifies if the SDK functionalities are enabled.
Minimum time interval to refresh token
| Parameter | Compability | Type | Default | Minimum Value | Maximum Value |
|---|---|---|---|---|---|
Synerise.Settings.sdk.minTokenRefreshInterval |
iOS, Android | number |
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 notifications
| Parameter | Compability | Type | Default |
|---|---|---|---|
Synerise.Settings.notifications.enabled |
iOS, Android | boolean |
true |
This parameter specifies if handling notifications by the SDK is enabled.
Enable/disable In-App notification alerts
| Parameter | Compability | Type | Default |
|---|---|---|---|
Synerise.Settings.notifications.disableInAppAlerts |
iOS | boolean |
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 | Compability | Type | Default |
|---|---|---|---|
Synerise.Settings.notifications.appGroupIdentifier |
iOS | string |
nil |
This parameter identifies the group used by applications and extensions that your app belongs to.
Tracker
Minimum number of events in queue to send
| Parameter | Compability | Type | Default | Minimum Value | Maximum Value |
|---|---|---|---|---|---|
Synerise.Settings.tracker.minBatchSize |
iOS, Android | number |
10 | 1 | 100 |
This parameter sets a minimum number of events in queue required to send them.
minBatchSize.Maximum number of events in queue to send
| Parameter | Compability | Type | Default | Minimum Value | Maximum Value |
|---|---|---|---|---|---|
Synerise.Settings.tracker.maxBatchSize |
iOS, Android | number |
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 | Compability | Type | Default | Minimum Value | Maximum Value |
|---|---|---|---|---|---|
Synerise.Settings.tracker.autoFlushTimeout |
iOS, Android | number |
5.0 | 0.5 | - |
This parameter sets the time required to elapse before attempting to send the event queue.