Package-level declarations

Types

Link copied to clipboard
class CardConfig(@DrawableRes val cardPlaceHolderImage: Int = -1, @DrawableRes val inboxEmptyImage: Int = -1, val cardsDateFormat: String, val isSwipeRefreshEnabled: Boolean)

Card Configuration.

Link copied to clipboard
class DataSyncConfig(val isPeriodicSyncEnabled: Boolean, val periodicSyncInterval: Long, val isBackgroundSyncEnabled: Boolean)

Data Sync configuration

Link copied to clipboard
class FcmConfig(val isRegistrationEnabled: Boolean)

Create an instance of Firebase Messaging Config.

Link copied to clipboard
class GeofenceConfig(val isGeofenceEnabled: Boolean)

Geofence Configuration Object.

Link copied to clipboard
class InAppConfig(val optOutActivities: Set<Class<*>>?)

InApp Configuration Object.

Link copied to clipboard
class JavaScriptConfig(val isJavaScriptEnabled: Boolean)

Javascript configuration object.

Link copied to clipboard
class LogConfig(val level: Int = LOG_CONFIG_DEFAULT_LOG_LEVEL, val isEnabledForReleaseBuild: Boolean = LOG_CONFIG_DEFAULT_STATE_FOR_RELEASE_BUILD)

Log Configuration Object.

Link copied to clipboard
class MiPushConfig(val appId: String, val appKey: String, val isRegistrationEnabled: Boolean)

Mi Push Config Configuration

Link copied to clipboard
class NetworkAuthorizationConfig(var isJwtEnabled: Boolean)

Create an instance of Network Authorization Config.

Link copied to clipboard
class NetworkDataSecurityConfig(val isEncryptionEnabled: Boolean, encryptionEncodedDebugKey: String, encryptionEncodedReleaseKey: String)

Create an instance of Network Data Security Config.

Link copied to clipboard
class NetworkRequestConfig(var networkDataSecurityConfig: NetworkDataSecurityConfig, val networkAuthorizationConfig: NetworkAuthorizationConfig, val shouldCacheConnection: Boolean)

Create an instance of Network Request Config.

Link copied to clipboard
class NotificationConfig(@DrawableRes val smallIcon: Int, @DrawableRes val largeIcon: Int, @ColorRes val notificationColor: Int, val isMultipleNotificationInDrawerEnabled: Boolean, val isBuildingBackStackEnabled: Boolean, val isLargeIconDisplayEnabled: Boolean)

Notification Configuration object.

Link copied to clipboard
class PushConfig(var tokenRetryInterval: Long, var meta: NotificationConfig, var miPush: MiPushConfig, var fcm: FcmConfig, var pushKit: PushKitConfig)
Link copied to clipboard
class PushKitConfig(val isRegistrationEnabled: Boolean)

Create an instance of PushKit Messaging Config.

Link copied to clipboard
class RttConfig(val isBackgroundSyncEnabled: Boolean)

Create an instance of Real Time trigger configuration.

Link copied to clipboard
class ScreenNameTrackingConfig(val isPackageFilteringEnabled: Boolean, val whitelistedPackages: Set<String>)

Configuration for Screen Name Tracking

Link copied to clipboard
class StorageEncryptionConfig(val isEncryptionEnabled: Boolean)

Configuration for how data would be stored on the SDK.

Link copied to clipboard
class StorageSecurityConfig(val storageEncryptionConfig: StorageEncryptionConfig)

Storage security configuration

Link copied to clipboard
class TrackingOptOutConfig(val isCarrierTrackingEnabled: Boolean, val isDeviceAttributeTrackingEnabled: Boolean, val optOutActivities: Set<Class<*>>?, val screenNameTrackingConfig: ScreenNameTrackingConfig)
Link copied to clipboard
class UserRegistrationConfig(val isRegistrationEnabled: Boolean)

Create an instance of UserRegistrationConfig

Properties

Link copied to clipboard

Default date format for any card.

Default resource id for the empty inbox.

Default resource id for the placeholder image.

Link copied to clipboard
const val CARD_CONFIG_DEFAULT_SWIPE_REFRESH_STATE: Boolean = true

Default state of whether swipe refresh layout.

Default state of background data sync. By default, background data sync is enabled.

Default value for periodic flush time interval.

Default state for periodic flush of data when the application is in foreground. By default, periodic flush is enabled.

Link copied to clipboard
const val FCM_CONFIG_DEFAULT_REGISTRATION_STATE: Boolean = true

Default state of Firebase Cloud Messaging token registration. By default, token registration is enabled.

Link copied to clipboard
const val GEOFENCE_CONFIG_DEFAULT_STATE: Boolean = false

Default state of Geofence feature. By default, geofence feature is disabled.

Default activities on which in-app should not be shown. By default in-app can be shown on any activity.

Default state for Javascript enablement. By default, Javascript is enabled.

Default state of Javascript usage in WebView.

Link copied to clipboard

Default log level. By default, info logs are enabled.

Default state of logs for release build. By default, logs for release build is disabled.

Link copied to clipboard
const val MI_CONFIG_DEFAULT_APP_ID: String

Default value of Mi console's App-id.

Link copied to clipboard
const val MI_CONFIG_DEFAULT_APP_KEY: String

Default value for Mi console's App-key.

Link copied to clipboard
const val MI_CONFIG_DEFAULT_REGISTRATION_STATE: Boolean = false

Default state of token registration for Mi Push. By default, token registration is disabled.

Default value for Network API Jwt Authorization.

Default value for Network API Data Encryption.

Default Value for Connection Cache Config

Default state for back-stack generation of on notification click. By default, back stack generation is enabled.

Default resource id for notification color.

Default resource id for notification large icon.

Default state for notification large icon to be shown. By default, notification large icon will be shown.

Default state for multiple notifications in the notification drawer. By default multiple notifications are disabled in the notification drawer.

Default resource id for notification small icon.

Link copied to clipboard

Default interval for retrying push token registration. Default value is 20 seconds.

Default state for Push kit token registration. By default token registration is disabled.

Default state for background sync of Real-Time Trigger Campaigns. By default, background sync is enabled.

Default of carrier name tracking. By default, carrier name tracking is enabled.

Default state of device attribute tracking. By default, device attribute tracking is enabled.

Default list of activities that should not be tracked. By default, all activities are tracked.

Default value for Package Name Filtering for Screen Name Tracking

Link copied to clipboard

Default value for Whitelisted PackageNames for Screen Name Tracking

Default value for User Registration State.