Settings (deltaDNA SDK 4.11.3.1 API)

java.lang.Object
- com.deltadna.android.sdk.helpers.Settings

```
public class Settings
extends java.lang.Object
```
DeltaDNA runtime setting. Note: default values should be set here or initialised before start() is called.

Constructor Summary

Constructors
Constructor and Description

Settings()

Constructors
Constructor and Description
`Settings()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`backgroundEventUpload()` Test if background event uploading is enabled.
`int`	`backgroundEventUploadRepeatRateSeconds()` The background upload repeat rate.
`int`	`backgroundEventUploadStartDelaySeconds()` The delay in seconds before background upload starts.
`boolean`	`debugMode()` Gets the SDK debig mode.
`EventActionHandler.GameParametersHandler`	`getDefaultGameParametersHandler()`
`EventActionHandler.ImageMessageHandler`	`getDefaultImageMessageHandler()`
`int`	`getEngageCacheExpiry()` Gets the Engage cache expiry value.
`int`	`getHttpRequestCollectTimeout()` Gets the connection timeout in seconds for Collect HTTP requests.
`int`	`getHttpRequestConfigMaxRetries()` Gets the number of retries to perform when an Session Configuration HTTP request fails.
`int`	`getHttpRequestConfigRetryDelayFactor()` Gets the time factor in seconds between failed Session Configuration HTTP requests.
`int`	`getHttpRequestConfigTimeout()` Gets the connection timeout in seconds for Session Configuration HTTP requests.
`int`	`getHttpRequestEngageTimeout()` Gets the connection timeout in seconds for Engage HTTP requests.
`int`	`getHttpRequestMaxRetries()` Gets the number of retries to perform when an HTTP request fails.
`int`	`getHttpRequestRetryDelay()` Gets the time to wait in seconds before retrying HTTP requests.
`int`	`getSessionTimeout()` Gets the session timeout.
`boolean`	`isMultipleActionsForEventTriggerEnabled()` Gets whether multiple actions should be processed when evaluating Event-Triggers for an event.
`boolean`	`isUseInternalStorageForEngage()`
`boolean`	`isUseInternalStorageForEvents()`
`boolean`	`isUseInternalStorageForImageMessages()`
`boolean`	`onFirstRunSendNewPlayerEvent()` TRUE to send new player event on first run of application.
`boolean`	`onInitSendClientDeviceEvent()` TRUE to send the client device event.
`boolean`	`onInitSendGameStartedEvent()` TRUE to send the game started event.
`void`	`setBackgroundEventUpload(boolean b)` Sets the background uploading behaviour.
`void`	`setBackgroundEventUploadRepeatRateSeconds(int i)` Sets the background upload repeat rate.
`void`	`setBackgroundEventUploadStartDelaySeconds(int i)` Sets the delay before background upload starts.
`void`	`setDebugMode(boolean b)` Sets the SDK debug mode.
`void`	`setDefaultGameParametersHandler(EventActionHandler.GameParametersHandler defaultGameParametersHandler)`
`void`	`setDefaultImageMessageHandler(EventActionHandler.ImageMessageHandler defaultImageMessageHandler)`
`Settings`	`setEngageCacheExpiry(int seconds)` Sets the Engage cache expiry value.
`void`	`setHttpRequestCollectTimeout(int seconds)` Sets the connection timeout in seconds for Collect HTTP requests.
`void`	`setHttpRequestConfigMaxRetries(int httpRequestConfigMaxRetries)` Sets the number of retries to perform when an Session Configuration HTTP request fails.
`void`	`setHttpRequestConfigRetryDelayFactor(int httpRequestConfigRetryDelayFactor)`
`void`	`setHttpRequestConfigTimeout(int timeoutInSeconds)` Sets the connection timeout in seconds for Session Configuration HTTP requests.
`void`	`setHttpRequestEngageTimeout(int seconds)` Sets the connection timeout in seconds for Engage HTTP requests.
`void`	`setHttpRequestMaxRetries(int retries)` Sets the number of retries to perform when an HTTP request fails.
`void`	`setHttpRequestRetryDelay(int seconds)` Sets the time to wait in seconds before retrying HTTP requests.
`void`	`setMultipleActionsForEventTriggerEnabled(boolean multipleActionsForEventTriggerEnabled)` Sets whether multiple actions should be processed when evaluating Event-Triggers for an event.
`void`	`setOnFirstRunSendNewPlayerEvent(boolean b)` Sets the first run event behaviour.
`void`	`setOnInitSendClientDeviceEvent(boolean b)` Sets the client device event behaviour.
`void`	`setOnInitSendGameStartedEvent(boolean b)` Sets the game started event behaviour.
`void`	`setSessionTimeout(int timeout)` Sets the session timeout.
`void`	`setUseInternalStorageForEngage(boolean useInternal)`
`void`	`setUseInternalStorageForEvents(boolean useInternal)`
`void`	`setUseInternalStorageForImageMessages(boolean useInternal)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Settings
```
public Settings()
```
- Method Detail
  - onFirstRunSendNewPlayerEvent
```
public boolean onFirstRunSendNewPlayerEvent()
```
    TRUE to send new player event on first run of application.
    
    Returns:
    
    TRUE if the new player event will be sent, FALSE otherwise.
  - setOnFirstRunSendNewPlayerEvent
```
public void setOnFirstRunSendNewPlayerEvent(boolean b)
```
    Sets the first run event behaviour.
    
    Parameters:
    
    b - TRUE to send new player event on first run, FALSE otherwise.
  - onInitSendClientDeviceEvent
```
public boolean onInitSendClientDeviceEvent()
```
    TRUE to send the client device event.
    
    Returns:
    
    TRUE if the client device event will be sent, FALSE otherwise.
  - setOnInitSendClientDeviceEvent
```
public void setOnInitSendClientDeviceEvent(boolean b)
```
    Sets the client device event behaviour.
    
    Parameters:
    
    b - TRUE to send client device event, FALSE otherwise.
  - onInitSendGameStartedEvent
```
public boolean onInitSendGameStartedEvent()
```
    TRUE to send the game started event.
    
    Returns:
    
    TRUE if the game started event will be sent, FALSE otherwise.
  - setOnInitSendGameStartedEvent
```
public void setOnInitSendGameStartedEvent(boolean b)
```
    Sets the game started event behaviour.
    
    Parameters:
    
    b - TRUE to send game started event, FALSE otherwise.
  - debugMode
```
public boolean debugMode()
```
    Gets the SDK debig mode.
    
    Returns:
    
    TRUE if the SDK is in debug mode, FALSE otherwise.
  - setDebugMode
```
public void setDebugMode(boolean b)
```
    Sets the SDK debug mode.
    
    Parameters:
    
    b - The new SDK debug mode.
  - backgroundEventUpload
```
public boolean backgroundEventUpload()
```
    Test if background event uploading is enabled.
    
    Returns:
    
    TRUE if background uploading is enabled, FALSE otherwise.
  - setBackgroundEventUpload
```
public void setBackgroundEventUpload(boolean b)
```
    Sets the background uploading behaviour.
    
    Parameters:
    
    b - TRUE to enable background uploading, FALSE otherwise.
  - backgroundEventUploadStartDelaySeconds
```
public int backgroundEventUploadStartDelaySeconds()
```
    The delay in seconds before background upload starts.
    
    Returns:
    
    The background upload delay in seconds.
  - setBackgroundEventUploadStartDelaySeconds
```
public void setBackgroundEventUploadStartDelaySeconds(int i)
```
    Sets the delay before background upload starts.
    
    Parameters:
    
    i - The new delay in seconds.
  - backgroundEventUploadRepeatRateSeconds
```
public int backgroundEventUploadRepeatRateSeconds()
```
    The background upload repeat rate.
    
    Returns:
    
    The upload repeat rate in seconds.
  - setBackgroundEventUploadRepeatRateSeconds
```
public void setBackgroundEventUploadRepeatRateSeconds(int i)
```
    Sets the background upload repeat rate.
    
    Parameters:
    
    i - The new background upload repeat rate in seconds.
  - getSessionTimeout
```
public int getSessionTimeout()
```
    Gets the session timeout.
    
    Returns:
    
    the session timeout, in milliseconds
  - setSessionTimeout
```
public void setSessionTimeout(int timeout)
```
    Sets the session timeout.
    A timeout of 0 will disable automatic session refreshing.
    
    Parameters:
    
    timeout - the session timeout, in milliseconds
    
    Throws:
    
    java.lang.IllegalArgumentException - if timeout is negative
  - getEngageCacheExpiry
```
public int getEngageCacheExpiry()
```
    Gets the Engage cache expiry value.
    
    Returns:
    
    the Engage cache expiry value, in seconds.
  - setEngageCacheExpiry
```
public Settings setEngageCacheExpiry(int seconds)
```
    Sets the Engage cache expiry value.
    A value of 0 will disable the Engage cache.
    
    Parameters:
    
    seconds - the Engage cache expiry value, in seconds
    
    Returns:
    
    this Settings instance
    
    Throws:
    
    java.lang.IllegalArgumentException - if seconds is negative
  - getHttpRequestMaxRetries
```
public int getHttpRequestMaxRetries()
```
    Gets the number of retries to perform when an HTTP request fails.
    Only applies to Collect requests.
    
    Returns:
    
    the number of retries
  - setHttpRequestMaxRetries
```
public void setHttpRequestMaxRetries(int retries)
```
    Sets the number of retries to perform when an HTTP request fails. A value of 0 means no retries will be performed.
    Only applies to Collect requests.
    
    Parameters:
    
    retries - the number of retries
    
    Throws:
    
    java.lang.IllegalArgumentException - if the retries is negative
  - getHttpRequestRetryDelay
```
public int getHttpRequestRetryDelay()
```
    Gets the time to wait in seconds before retrying HTTP requests.
    Only applies to Collect requests.
    
    Returns:
    
    the time to wait in seconds
  - setHttpRequestRetryDelay
```
public void setHttpRequestRetryDelay(int seconds)
```
    Sets the time to wait in seconds before retrying HTTP requests.
    Only applies to Collect requests.
    
    Parameters:
    
    seconds - the time to wait in seconds
    
    Throws:
    
    java.lang.IllegalArgumentException - if the seconds is negative
  - getHttpRequestCollectTimeout
```
public int getHttpRequestCollectTimeout()
```
    Gets the connection timeout in seconds for Collect HTTP requests.
    
    Returns:
    
    the timeout in seconds
  - setHttpRequestCollectTimeout
```
public void setHttpRequestCollectTimeout(int seconds)
```
    Sets the connection timeout in seconds for Collect HTTP requests.
    
    Parameters:
    
    seconds - the timeout in seconds
    
    Throws:
    
    java.lang.IllegalArgumentException - if the seconds is negative
  - getHttpRequestEngageTimeout
```
public int getHttpRequestEngageTimeout()
```
    Gets the connection timeout in seconds for Engage HTTP requests.
    
    Returns:
    
    the timeout in seconds
  - setHttpRequestEngageTimeout
```
public void setHttpRequestEngageTimeout(int seconds)
```
    Sets the connection timeout in seconds for Engage HTTP requests.
    
    Parameters:
    
    seconds - the timeout in seconds
    
    Throws:
    
    java.lang.IllegalArgumentException - if the seconds is negative
  - isUseInternalStorageForEvents
```
public boolean isUseInternalStorageForEvents()
```
  - setUseInternalStorageForEvents
```
public void setUseInternalStorageForEvents(boolean useInternal)
```
  - isUseInternalStorageForEngage
```
public boolean isUseInternalStorageForEngage()
```
  - setUseInternalStorageForEngage
```
public void setUseInternalStorageForEngage(boolean useInternal)
```
  - isUseInternalStorageForImageMessages
```
public boolean isUseInternalStorageForImageMessages()
```
  - setUseInternalStorageForImageMessages
```
public void setUseInternalStorageForImageMessages(boolean useInternal)
```
  - isMultipleActionsForEventTriggerEnabled
```
public boolean isMultipleActionsForEventTriggerEnabled()
```
    Gets whether multiple actions should be processed when evaluating Event-Triggers for an event. If true, all applicable actions will be passed to their respective action handler. If false, only the first applicable parameter will be passed to the respective action handler. N.b. Even when true, Only the first image action will be handled; but this will not stop any subsequent parameter actions from being handled.
    
    Returns:
    
    whether multiple actions per event-trigger are enabled.
  - setMultipleActionsForEventTriggerEnabled
```
public void setMultipleActionsForEventTriggerEnabled(boolean multipleActionsForEventTriggerEnabled)
```
    Sets whether multiple actions should be processed when evaluating Event-Triggers for an event. If true, all applicable actions will be passed to their respective action handler. If false, only the first applicable parameter will be passed to the respective action handler. N.b. Even when true, Only the first image action will be handled; but this will not stop any subsequent parameter actions from being handled.
  - getDefaultImageMessageHandler
```
public EventActionHandler.ImageMessageHandler getDefaultImageMessageHandler()
```
  - setDefaultImageMessageHandler
```
public void setDefaultImageMessageHandler(EventActionHandler.ImageMessageHandler defaultImageMessageHandler)
```
  - getDefaultGameParametersHandler
```
public EventActionHandler.GameParametersHandler getDefaultGameParametersHandler()
```
  - setDefaultGameParametersHandler
```
public void setDefaultGameParametersHandler(EventActionHandler.GameParametersHandler defaultGameParametersHandler)
```
  - getHttpRequestConfigTimeout
```
public int getHttpRequestConfigTimeout()
```
    Gets the connection timeout in seconds for Session Configuration HTTP requests.
    
    Returns:
    
    the timeout in seconds
  - setHttpRequestConfigTimeout
```
public void setHttpRequestConfigTimeout(int timeoutInSeconds)
```
    Sets the connection timeout in seconds for Session Configuration HTTP requests.
  - getHttpRequestConfigRetryDelayFactor
```
public int getHttpRequestConfigRetryDelayFactor()
```
    Gets the time factor in seconds between failed Session Configuration HTTP requests. This is used as part of an exponential backoff retry mechanism, e.g. if this was set to 5 seconds, the time before we retry failed config requests would be 5s, 10s, 20s, 40s And so on.
    
    Returns:
    
    the factor in seconds
  - setHttpRequestConfigRetryDelayFactor
```
public void setHttpRequestConfigRetryDelayFactor(int httpRequestConfigRetryDelayFactor)
```
  - getHttpRequestConfigMaxRetries
```
public int getHttpRequestConfigMaxRetries()
```
    Gets the number of retries to perform when an Session Configuration HTTP request fails. A value of 0 means no retries will be performed.
    Only applies to Session Configuration requests.
    
    Throws:
    
    java.lang.IllegalArgumentException - if the retries is negative
  - setHttpRequestConfigMaxRetries
```
public void setHttpRequestConfigMaxRetries(int httpRequestConfigMaxRetries)
```
    Sets the number of retries to perform when an Session Configuration HTTP request fails. A value of 0 means no retries will be performed.
    Only applies to Session Configuration requests.
    
    Parameters:
    
    httpRequestConfigMaxRetries - the number of retries
    
    Throws:
    
    java.lang.IllegalArgumentException - if the retries is negative

Class Settings

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Settings

Method Detail

onFirstRunSendNewPlayerEvent

setOnFirstRunSendNewPlayerEvent

onInitSendClientDeviceEvent

setOnInitSendClientDeviceEvent

onInitSendGameStartedEvent

setOnInitSendGameStartedEvent

debugMode

setDebugMode

backgroundEventUpload

setBackgroundEventUpload

backgroundEventUploadStartDelaySeconds

setBackgroundEventUploadStartDelaySeconds

backgroundEventUploadRepeatRateSeconds

setBackgroundEventUploadRepeatRateSeconds

getSessionTimeout

setSessionTimeout

getEngageCacheExpiry

setEngageCacheExpiry

getHttpRequestMaxRetries

setHttpRequestMaxRetries

getHttpRequestRetryDelay

setHttpRequestRetryDelay

getHttpRequestCollectTimeout

setHttpRequestCollectTimeout

getHttpRequestEngageTimeout

setHttpRequestEngageTimeout

isUseInternalStorageForEvents

setUseInternalStorageForEvents

isUseInternalStorageForEngage

setUseInternalStorageForEngage

isUseInternalStorageForImageMessages

setUseInternalStorageForImageMessages

isMultipleActionsForEventTriggerEnabled

setMultipleActionsForEventTriggerEnabled

getDefaultImageMessageHandler

setDefaultImageMessageHandler

getDefaultGameParametersHandler

setDefaultGameParametersHandler

getHttpRequestConfigTimeout

setHttpRequestConfigTimeout

getHttpRequestConfigRetryDelayFactor

setHttpRequestConfigRetryDelayFactor

getHttpRequestConfigMaxRetries

setHttpRequestConfigMaxRetries