ly.count.sdk.java

Class Config

java.lang.Object

ly.count.sdk.java.ConfigCore

ly.count.sdk.java.Config

public class Config
extends ConfigCore

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Config.DeviceIdRealm What this device id is for
static class	Config.DeviceIdStrategy Strategy for device id generation
static class	Config.Feature Enumeration of Countly SDK features

Nested classes/interfaces inherited from class ly.count.sdk.java.ConfigCore

ConfigCore.DID, ConfigCore.LoggingLevel

Field Summary

Fields inherited from class ly.count.sdk.java.ConfigCore

applicationName, applicationVersion, automaticStarRatingShouldBeShown, autoSessionsTracking, autoViewsTracking, certificatePins, crashProcessorClass, crashReportingANRCheckingPeriod, customDeviceId, deviceIdFallbackAllowed, deviceIdStrategy, enableAutomaticRemoteConfig, eventsBufferSize, features, loggingLevel, loggingTag, moduleOverrides, networkConnectionTimeout, networkImportantRequestCooldown, networkReadTimeout, networkRequestCooldown, persistentParams, publicKeyPins, ratingWidgetTimeout, remoteConfigUpdateRequestTimeout, requiresConsent, salt, sdkName, sdkVersion, sendUpdateEachSeconds, serverAppKey, serverURL, sessionAutoCloseAfter, sessionCooldownPeriod, starRatingDisabledAutomaticForNewVersions, starRatingIsDialogCancelable, starRatingSessionLimit, starRatingTextDismiss, starRatingTextMessage, starRatingTextTitle, testMode, usePOST

Constructor Summary

Constructors

Constructor and Description
Config(java.lang.String serverURL, java.lang.String serverAppKey) The only Config constructor.

Method Summary

Modifier and Type	Method and Description
Config	disableANRCrashReporting() !!! Not available for Java SDK !!!
Config	disableFeatures(Config.Feature... features) Disable one or many features of Countly SDK instead of setFeatures(Feature...).
Config	disableTestMode() Disable test mode, so SDK will silently avoid raising exceptions whenever possible.
Config	disableUpdateRequests() Disable update requests completely.
Config	enableFeatures(Config.Feature... features) Enable one or many features of Countly SDK instead of setFeatures(Feature...).
Config	enableParameterTamperingProtection(java.lang.String salt) Enable parameter tampering protection
Config	enableTestMode() Enable test mode: Raise exceptions when SDK is in inconsistent state as opposed to silently trying to ignore them when testMode is off Put Firebase token under test devices if Feature.Push is enabled. Note: this method automatically sets ConfigCore.loggingLevel to ConfigCore.LoggingLevel.INFO in case it was ConfigCore.LoggingLevel.OFF (default).
Config	enableUsePOST() Force usage of POST method for all requests
Config.DeviceIdStrategy	getDeviceIdStrategyEnum() Getter for ConfigCore.deviceIdStrategy
java.util.Set<Config.Feature>	getFeatures() Getter for ConfigCore.features
int	getFeaturesMap()
java.lang.Class<? extends Module>	getModuleOverride(Config.Feature feature) Getter for ConfigCore.moduleOverrides
boolean	isFeatureEnabled(Config.Feature feature) Whether a feature is enabled in this config, that is exists in ConfigCore.features
Config	overrideModule(Config.Feature feature, java.lang.Class<? extends Module> cls) Override some Module functionality with your own class.
protected Config	overrideModule(java.lang.Integer feature, java.lang.Class<? extends Module> cls) Override some Module functionality with your own class.
Config	setAutoSessionsTracking(boolean autoSessionsTracking) !!! Not available for Java SDK !!!
Config	setAutoViewsTracking(boolean autoViewsTracking) !!! Not available for Java SDK !!!
Config	setCrashProcessorClass(java.lang.Class<? extends CrashProcessor> crashProcessorClass) Set crash processor class responsible .
Config	setCrashReportingANRCheckingPeriod(int periodInSeconds) !!! Not available for Java SDK !!!
Config	setCustomDeviceId(java.lang.String customDeviceId) Set device id to specific string and set generation strategy to Config.DeviceIdStrategy.CUSTOM_ID.
Config	setDeviceIdFallbackAllowed(boolean deviceIdFallbackAllowed) Whether to allow fallback from unavailable device id strategy to Countly OpenUDID derivative.
Config	setDeviceIdStrategy(Config.DeviceIdStrategy strategy) Shorthand method for setDeviceIdStrategy(DeviceIdStrategy, String)
Config	setDeviceIdStrategy(Config.DeviceIdStrategy strategy, java.lang.String customDeviceId) Set device id generation strategy: - Config.DeviceIdStrategy.UUID to use standard java random UUID.
Config	setEventsBufferSize(int eventsBufferSize) Sets maximum number of events to hold until forcing update request to be sent to the server
Config	setFeatures(Config.Feature... features) Set enabled features all at once instead of enableFeatures(Feature...).
Config	setLoggingLevel(ConfigCore.LoggingLevel loggingLevel) Logging level for Countly SDK
Config	setLoggingTag(java.lang.String loggingTag) Tag used for logging
Config	setRequiresConsent(boolean requiresConsent) Enable GDPR compliance by disallowing SDK to record any data until corresponding consent calls are made.
Config	setSendUpdateEachSeconds(int sendUpdateEachSeconds) Set maximum amount of time in seconds between two update requests to the server reporting session duration and other parameters if any added between update requests.
Config	setSessionAutoCloseAfter(int sessionAutoCloseAfter) !!! Not available for Java SDK !!!
Config	setUsePOST(boolean usePOST) Force usage of POST method for all requests.

Methods inherited from class ly.count.sdk.java.ConfigCore

addCertificatePin, addPublicKeyPin, getApplicationName, getApplicationVersion, getCertificatePins, getCrashProcessorClass, getCrashReportingANRCheckingPeriod, getCustomDeviceId, getDeviceIdStrategy, getEventsBufferSize, getLoggingLevel, getLoggingTag, getModuleOverride, getNetworkConnectionTimeout, getNetworkImportantRequestCooldown, getNetworkReadTimeout, getNetworkRequestCooldown, getParameterTamperingProtectionSalt, getPublicKeyPins, getSdkName, getSdkVersion, getSendUpdateEachSeconds, getServerAppKey, getServerURL, getSessionAutoCloseAfter, getSessionCooldownPeriod, isAutoSessionsTrackingEnabled, isAutoViewsTrackingEnabled, isDeviceIdFallbackAllowed, isFeatureEnabled, isTestModeEnabled, isUsePOST, requiresConsent, setApplicationName, setApplicationVersion, setNetworkConnectTimeout, setNetworkImportantRequestCooldown, setNetworkReadTimeout, setNetworkRequestCooldown, setSdkName, setSdkVersion, setSessionCooldownPeriod

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Config

public Config(java.lang.String serverURL,
              java.lang.String serverAppKey)

The only Config constructor.

Parameters:

serverURL - valid URL of Countly server

serverAppKey - App Key from Management -> Applications section of your Countly Dashboard

Method Detail

setDeviceIdStrategy

public Config setDeviceIdStrategy(Config.DeviceIdStrategy strategy,
                                  java.lang.String customDeviceId)

Set device id generation strategy: - Config.DeviceIdStrategy.UUID to use standard java random UUID. Default. - Config.DeviceIdStrategy.CUSTOM_ID to use your own device id for Countly.

Parameters:

strategy - strategy to use instead of default OpenUDID

customDeviceId - device id for use with Config.DeviceIdStrategy.CUSTOM_ID

Returns:

this instance for method chaining

setDeviceIdStrategy

public Config setDeviceIdStrategy(Config.DeviceIdStrategy strategy)

Shorthand method for setDeviceIdStrategy(DeviceIdStrategy, String)

Parameters:

strategy - strategy to use instead of default OpenUDID

Returns:

this instance for method chaining

setCustomDeviceId

public Config setCustomDeviceId(java.lang.String customDeviceId)

Set device id to specific string and set generation strategy to Config.DeviceIdStrategy.CUSTOM_ID.

Parameters:

customDeviceId - device id for use with Config.DeviceIdStrategy.CUSTOM_ID

Returns:

this instance for method chaining

getDeviceIdStrategyEnum

public Config.DeviceIdStrategy getDeviceIdStrategyEnum()

Getter for ConfigCore.deviceIdStrategy

Returns:

ConfigCore.deviceIdStrategy value as enum

enableFeatures

public Config enableFeatures(Config.Feature... features)

Enable one or many features of Countly SDK instead of setFeatures(Feature...).

Parameters:

features - features to enable

Returns:

this instance for method chaining

disableFeatures

public Config disableFeatures(Config.Feature... features)

Disable one or many features of Countly SDK instead of setFeatures(Feature...).

Parameters:

features - features to disable

Returns:

this instance for method chaining

setFeatures

public Config setFeatures(Config.Feature... features)

Set enabled features all at once instead of enableFeatures(Feature...).

Parameters:

features - variable args of features to enable

Returns:

this instance for method chaining

overrideModule

public Config overrideModule(Config.Feature feature,
                             java.lang.Class<? extends Module> cls)

Override some Module functionality with your own class.

Parameters:

feature - Config.Feature to override

cls - Class to use instead of Countly SDK standard class

Returns:

this instance for method chaining

getFeatures

public java.util.Set<Config.Feature> getFeatures()

Getter for ConfigCore.features

Returns:

ConfigCore.features value

getFeaturesMap

public int getFeaturesMap()

isFeatureEnabled

public boolean isFeatureEnabled(Config.Feature feature)

Whether a feature is enabled in this config, that is exists in ConfigCore.features

Returns:

true if ConfigCore.features contains supplied argument, false otherwise

getModuleOverride

public java.lang.Class<? extends Module> getModuleOverride(Config.Feature feature)

Getter for ConfigCore.moduleOverrides

Returns:

ConfigCore.moduleOverrides value for Feature specified

setDeviceIdFallbackAllowed

public Config setDeviceIdFallbackAllowed(boolean deviceIdFallbackAllowed)

Description copied from class: ConfigCore

Whether to allow fallback from unavailable device id strategy to Countly OpenUDID derivative.

Overrides:

setDeviceIdFallbackAllowed in class ConfigCore

Parameters:

deviceIdFallbackAllowed - true if fallback is allowed

Returns:

this instance for method chaining

enableUsePOST

public Config enableUsePOST()

Force usage of POST method for all requests

Overrides:

enableUsePOST in class ConfigCore

Returns:

this instance for method chaining

setUsePOST

public Config setUsePOST(boolean usePOST)

Force usage of POST method for all requests.

Overrides:

setUsePOST in class ConfigCore

Parameters:

usePOST - whether to force using POST method for all requests or not

Returns:

this instance for method chaining

enableParameterTamperingProtection

public Config enableParameterTamperingProtection(java.lang.String salt)

Enable parameter tampering protection

Overrides:

enableParameterTamperingProtection in class ConfigCore

Parameters:

salt - String to add to each request bebfore calculating checksum

Returns:

this instance for method chaining

setLoggingTag

public Config setLoggingTag(java.lang.String loggingTag)

Tag used for logging

Overrides:

setLoggingTag in class ConfigCore

Parameters:

loggingTag - tag string to use

Returns:

this instance for method chaining

setLoggingLevel

public Config setLoggingLevel(ConfigCore.LoggingLevel loggingLevel)

Logging level for Countly SDK

Overrides:

setLoggingLevel in class ConfigCore

Parameters:

loggingLevel - log level to use

Returns:

this instance for method chaining

enableTestMode

public Config enableTestMode()

Enable test mode:

• Raise exceptions when SDK is in inconsistent state as opposed to silently trying to ignore them when testMode is off
• Put Firebase token under test devices if Feature.Push is enabled.

Note: this method automatically sets ConfigCore.loggingLevel to ConfigCore.LoggingLevel.INFO in case it was ConfigCore.LoggingLevel.OFF (default).

Overrides:

enableTestMode in class ConfigCore

Returns:

this instance for method chaining

disableTestMode

public Config disableTestMode()

Disable test mode, so SDK will silently avoid raising exceptions whenever possible. Test mode is disabled by default.

Overrides:

disableTestMode in class ConfigCore

Returns:

this instance for method chaining

setSendUpdateEachSeconds

public Config setSendUpdateEachSeconds(int sendUpdateEachSeconds)

Set maximum amount of time in seconds between two update requests to the server reporting session duration and other parameters if any added between update requests.

Update request is also sent when number of unsent events reached setEventsBufferSize(int).

Overrides:

setSendUpdateEachSeconds in class ConfigCore

Parameters:

sendUpdateEachSeconds - max time interval between two update requests, set to 0 to disable update requests based on time.

Returns:

this instance for method chaining

setEventsBufferSize

public Config setEventsBufferSize(int eventsBufferSize)

Sets maximum number of events to hold until forcing update request to be sent to the server

Update request is also sent when last update request was sent more than setSendUpdateEachSeconds(int) seconds ago.

Overrides:

setEventsBufferSize in class ConfigCore

Parameters:

eventsBufferSize - max number of events between two update requests, set to 0 to disable update requests based on events.

Returns:

this instance for method chaining

disableUpdateRequests

public Config disableUpdateRequests()

Disable update requests completely. Only begin & end requests will be sent + some special cases if applicable like User Profile change or Push token updated.

Overrides:

disableUpdateRequests in class ConfigCore

Returns:

this instance for method chaining

See Also:

setSendUpdateEachSeconds(int), setEventsBufferSize(int)

setCrashReportingANRCheckingPeriod

public Config setCrashReportingANRCheckingPeriod(int periodInSeconds)

!!! Not available for Java SDK !!!

Overrides:

setCrashReportingANRCheckingPeriod in class ConfigCore

Parameters:

periodInSeconds - how much time the SDK waits between individual ANR checks

Returns:

this instance for method chaining

See Also:

ConfigCore.autoViewsTracking

disableANRCrashReporting

public Config disableANRCrashReporting()

!!! Not available for Java SDK !!!

Overrides:

disableANRCrashReporting in class ConfigCore

Returns:

this instance for method chaining

setCrashProcessorClass

public Config setCrashProcessorClass(java.lang.Class<? extends CrashProcessor> crashProcessorClass)

Set crash processor class responsible . Defaults automatically to main activity class.

Overrides:

setCrashProcessorClass in class ConfigCore

Parameters:

crashProcessorClass - CrashProcessor-implementing class

Returns:

this instance for method chaining

overrideModule

protected Config overrideModule(java.lang.Integer feature,
                                java.lang.Class<? extends Module> cls)

Override some Module functionality with your own class.

Overrides:

overrideModule in class ConfigCore

Parameters:

feature - feature index to override

cls - Class to use instead of Countly SDK standard class

Returns:

this instance for method chaining

setRequiresConsent

public Config setRequiresConsent(boolean requiresConsent)

Enable GDPR compliance by disallowing SDK to record any data until corresponding consent calls are made.

Overrides:

setRequiresConsent in class ConfigCore

Parameters:

requiresConsent - true to enable GDPR compliance

Returns:

this instance for method chaining

setAutoViewsTracking

public Config setAutoViewsTracking(boolean autoViewsTracking)

!!! Not available for Java SDK !!!

Overrides:

setAutoViewsTracking in class ConfigCore

Parameters:

autoViewsTracking - whether to enable it or disable

Returns:

this instance for method chaining

See Also:

ConfigCore.autoViewsTracking

setAutoSessionsTracking

public Config setAutoSessionsTracking(boolean autoSessionsTracking)

!!! Not available for Java SDK !!!

Overrides:

setAutoSessionsTracking in class ConfigCore

Parameters:

autoSessionsTracking - whether to enable it or disable

Returns:

this instance for method chaining

See Also:

ConfigCore.autoSessionsTracking

setSessionAutoCloseAfter

public Config setSessionAutoCloseAfter(int sessionAutoCloseAfter)

!!! Not available for Java SDK !!!

Overrides:

setSessionAutoCloseAfter in class ConfigCore

Parameters:

sessionAutoCloseAfter - time in seconds

Returns:

this instance for method chaining

See Also:

ConfigCore.autoSessionsTracking