appcues/com.appcues/AppcuesConfig

AppcuesConfig

data class AppcuesConfig

A configuration object that defines the behavior and policies for Appcues.

Properties

activityStorageMaxAge

var activityStorageMaxAge: Int?

Sets the activity storage max age for the configuration, in seconds. This value determines how long an item can be stored on the local device and retried later, in the case of the device network connection being unavailable. Only requests that are more recent than the max age will be retried - or all, if not set.

activityStorageMaxSize

var activityStorageMaxSize: Int

Set the activity storage max size for the configuration - maximum 25, minimum 0. This value determines how many analytics requests can be stored on the local device and retried later, in the case of the device network connection being unavailable. Only the most recent requests, up to this count, are retained.

additionalAutoProperties

var additionalAutoProperties: Map<String, Any>

Define a set of additional properties that should be included in the auto properties sent on every analytics tracking call made by the SDK. The additional property names must be unique from those already captured in the SDK. If a property name conflicts with an existing auto property generated by the SDK, it is ignored.

analyticsListener

var analyticsListener: AnalyticsListener?

Sets the listener to be notified about published analytics.

anonymousIdFactory

var anonymousIdFactory: () -> String?

Set the factory responsible for generating anonymous user IDs.

apiBasePath

var apiBasePath: String?

Defines a custom api base path for the SDK. This path should consist of the scheme, host, and any additional path prefix required. If Not defined it will point to the default Appcues host: https://api.appcues.net/

apiSettingsPath

var apiSettingsPath: String?

Defines custom api settings path for the SDK. This path should consist of the scheme, host, and any additional path prefix required. If Not defined it will point to the default Appcues host: https://fast.appcues.com/

experienceListener

var experienceListener: ExperienceListener?

Set the listener to be notified about the display of Experience content.

interceptor

var interceptor: AppcuesInterceptor?

Set the interceptor for additional control over SDK runtime behaviors.

loggingLevel

var loggingLevel: LoggingLevel

Set the logging level for the SDK.

navigationHandler

var navigationHandler: NavigationHandler?

Sets the handler to use for link navigation.

packageNames

var packageNames: List<String>

Optional property that allows for setting custom package list for fonts, mostly used when your fonts are stored in a different package than your main app (multi-module apps)

sessionTimeout

var sessionTimeout: Int

Set the session timeout for the configuration, in seconds. This timeout value is used to determine if a new session is started after a period of inactivity, or upon the application returning to the foreground. The default value is 300 seconds (5 minutes).