Package-level declarations

Types

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

Card Configuration.

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

Data Sync configuration

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

Create an instance of Firebase Messaging Config.

Link copied to clipboard
@Serializable
data class InAppConfig(val optOutActivities: List<String>, val isShowInAppInNewActivityEnabled: Boolean)
@Serializable
data class InAppConfig(val optOutActivities: List<String>, val isShowInAppInNewActivityEnabled: Boolean)
@Serializable
data class InAppConfig(val optOutActivities: List<String>, val isShowInAppInNewActivityEnabled: Boolean)
Link copied to clipboard
class JavaScriptConfig(val isJavaScriptEnabled: Boolean)
class JavaScriptConfig(val isJavaScriptEnabled: Boolean)
class JavaScriptConfig(val isJavaScriptEnabled: Boolean)

Javascript configuration object.

Link copied to clipboard
@Serializable
data class LogConfig(val level: Int = LOG_CONFIG_DEFAULT_LOG_LEVEL, val isEnabledForReleaseBuild: Boolean = LOG_CONFIG_DEFAULT_STATE_FOR_RELEASE_BUILD)
@Serializable
data class LogConfig(val level: Int = LOG_CONFIG_DEFAULT_LOG_LEVEL, val isEnabledForReleaseBuild: Boolean = LOG_CONFIG_DEFAULT_STATE_FOR_RELEASE_BUILD)
@Serializable
data 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
@Serializable
data class MoEngageEnvironmentConfig(val environment: MoEngageEnvironment)
@Serializable
data class MoEngageEnvironmentConfig(val environment: MoEngageEnvironment)
@Serializable
data class MoEngageEnvironmentConfig(val environment: MoEngageEnvironment)
Link copied to clipboard
@Serializable
data class NetworkAuthorizationConfig(var isJwtEnabled: Boolean)
@Serializable
data class NetworkAuthorizationConfig(var isJwtEnabled: Boolean)
@Serializable
data class NetworkAuthorizationConfig(var isJwtEnabled: Boolean)

Create an instance of Network Authorization Config.

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

Create an instance of Network Data Security Config.

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

Create an instance of Network Request Config.

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

Notification Configuration object.

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

Create an instance of PushKit Messaging Config.

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

Create an instance of Real Time trigger configuration.

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

Configuration for Screen Name Tracking

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

Configuration for how data would be stored on the SDK.

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

Storage security configuration

Link copied to clipboard
@Serializable
data class TrackingOptOutConfig(val isCarrierTrackingEnabled: Boolean, val isDeviceAttributeTrackingEnabled: Boolean, val optOutActivities: List<String>, val screenNameTrackingConfig: ScreenNameTrackingConfig)
@Serializable
data class TrackingOptOutConfig(val isCarrierTrackingEnabled: Boolean, val isDeviceAttributeTrackingEnabled: Boolean, val optOutActivities: List<String>, val screenNameTrackingConfig: ScreenNameTrackingConfig)
@Serializable
data class TrackingOptOutConfig(val isCarrierTrackingEnabled: Boolean, val isDeviceAttributeTrackingEnabled: Boolean, val optOutActivities: List<String>, val screenNameTrackingConfig: ScreenNameTrackingConfig)

Create an instance of the tracking opt-out.

Link copied to clipboard
@Serializable
data class UserRegistrationConfig(val isRegistrationEnabled: Boolean)
@Serializable
data class UserRegistrationConfig(val isRegistrationEnabled: Boolean)
@Serializable
data class UserRegistrationConfig(val isRegistrationEnabled: Boolean)

Create an instance of UserRegistrationConfig

Properties

Link copied to clipboard
Link copied to clipboard

Default state of whether swipe refresh layout.

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

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

Link copied to clipboard

Default value for file based initialisation

Link copied to clipboard

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

Default value for whether additional activity should be used.

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.

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.

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

Default value for direct posting for notification with High Priority(Heads-Up Channel)

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.

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