core/com.moengage.core.config

Package-level declarations

Types

Link copied to clipboard
@Serializable
class CardConfig(@DrawableRes val cardPlaceHolderImage: Int = -1, @DrawableRes val inboxEmptyImage: Int = -1, val cardsDateFormat: String, val isSwipeRefreshEnabled: Boolean)
@Serializable
class CardConfig(@DrawableRes val cardPlaceHolderImage: Int = -1, @DrawableRes val inboxEmptyImage: Int = -1, val cardsDateFormat: String, val isSwipeRefreshEnabled: Boolean)
@Serializable
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
class DataSyncConfig(val isPeriodicSyncEnabled: Boolean, val periodicSyncInterval: Long, val isBackgroundSyncEnabled: Boolean)
@Serializable
class DataSyncConfig(val isPeriodicSyncEnabled: Boolean, val periodicSyncInterval: Long, val isBackgroundSyncEnabled: Boolean)
@Serializable
class DataSyncConfig(val isPeriodicSyncEnabled: Boolean, val periodicSyncInterval: Long, val isBackgroundSyncEnabled: Boolean)

Data Sync configuration

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

Create an instance of Firebase Messaging Config.

Link copied to clipboard
@Serializable(with = InAppConfigSerializer::class)
class InAppConfig(val optOutActivities: Set<Class<*>>?, val isShowInAppInNewActivityEnabled: Boolean)
@Serializable(with = InAppConfigSerializer::class)
class InAppConfig(val optOutActivities: Set<Class<*>>?, val isShowInAppInNewActivityEnabled: Boolean)
@Serializable(with = InAppConfigSerializer::class)
class InAppConfig(val optOutActivities: Set<Class<*>>?, 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
class LogConfig(val level: Int = LOG_CONFIG_DEFAULT_LOG_LEVEL, val isEnabledForReleaseBuild: Boolean = LOG_CONFIG_DEFAULT_STATE_FOR_RELEASE_BUILD)
@Serializable
class LogConfig(val level: Int = LOG_CONFIG_DEFAULT_LOG_LEVEL, val isEnabledForReleaseBuild: Boolean = LOG_CONFIG_DEFAULT_STATE_FOR_RELEASE_BUILD)
@Serializable
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
class MoEngageEnvironmentConfig(val environment: MoEngageEnvironment)
@Serializable
class MoEngageEnvironmentConfig(val environment: MoEngageEnvironment)
@Serializable
class MoEngageEnvironmentConfig(val environment: MoEngageEnvironment)
Link copied to clipboard
@Serializable
class NetworkAuthorizationConfig(var isJwtEnabled: Boolean)
@Serializable
class NetworkAuthorizationConfig(var isJwtEnabled: Boolean)
@Serializable
class NetworkAuthorizationConfig(var isJwtEnabled: Boolean)

Create an instance of Network Authorization Config.

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

Create an instance of Network Data Security Config.

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

Create an instance of Network Request Config.

Link copied to clipboard
@Serializable
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
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
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
class PushConfig(var tokenRetryInterval: Long, var meta: NotificationConfig, var fcm: FcmConfig, var pushKit: PushKitConfig)
@Serializable
class PushConfig(var tokenRetryInterval: Long, var meta: NotificationConfig, var fcm: FcmConfig, var pushKit: PushKitConfig)
@Serializable
class PushConfig(var tokenRetryInterval: Long, var meta: NotificationConfig, var fcm: FcmConfig, var pushKit: PushKitConfig)
Link copied to clipboard
@Serializable
class PushKitConfig(val isRegistrationEnabled: Boolean)
@Serializable
class PushKitConfig(val isRegistrationEnabled: Boolean)
@Serializable
class PushKitConfig(val isRegistrationEnabled: Boolean)

Create an instance of PushKit Messaging Config.

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

Create an instance of Real Time trigger configuration.

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

Configuration for Screen Name Tracking

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

Configuration for how data would be stored on the SDK.

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

Storage security configuration

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

Create an instance of UserRegistrationConfig

Properties

Link copied to clipboard
Link copied to clipboard
const val CARD_CONFIG_DEFAULT_SWIPE_REFRESH_STATE: Boolean = true
const val CARD_CONFIG_DEFAULT_SWIPE_REFRESH_STATE: Boolean = true
const val CARD_CONFIG_DEFAULT_SWIPE_REFRESH_STATE: Boolean = true

Default state of whether swipe refresh layout.

const val DATA_SYNC_CONFIG_DEFAULT_BACKGROUND_SYNC_STATE: Boolean = true
const val DATA_SYNC_CONFIG_DEFAULT_BACKGROUND_SYNC_STATE: Boolean = true
const val DATA_SYNC_CONFIG_DEFAULT_BACKGROUND_SYNC_STATE: Boolean = true

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

const val DATA_SYNC_CONFIG_DEFAULT_PERIODIC_SYNC_STATE: Boolean = true
const val DATA_SYNC_CONFIG_DEFAULT_PERIODIC_SYNC_STATE: Boolean = true
const val DATA_SYNC_CONFIG_DEFAULT_PERIODIC_SYNC_STATE: Boolean = true

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
const val FCM_CONFIG_DEFAULT_REGISTRATION_STATE: Boolean = true
const val FCM_CONFIG_DEFAULT_REGISTRATION_STATE: Boolean = true

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

const val INAPP_CONFIG_DEFAULT_ADDITIONAL_ACTIVITY_STATE: Boolean = false
const val INAPP_CONFIG_DEFAULT_ADDITIONAL_ACTIVITY_STATE: Boolean = false
const val INAPP_CONFIG_DEFAULT_ADDITIONAL_ACTIVITY_STATE: Boolean = false

Default value for whether additional activity should be used.

val INAPP_CONFIG_DEFAULT_INAPP_OPT_OUT_ACTIVITIES: Set<Class<*>>
val INAPP_CONFIG_DEFAULT_INAPP_OPT_OUT_ACTIVITIES: Set<Class<*>>
val INAPP_CONFIG_DEFAULT_INAPP_OPT_OUT_ACTIVITIES: Set<Class<*>>

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

const val INAPP_CONFIG_DEFAULT_JAVASCRIPT_ENABLED_STATE: Boolean = true
const val INAPP_CONFIG_DEFAULT_JAVASCRIPT_ENABLED_STATE: Boolean = true
const val INAPP_CONFIG_DEFAULT_JAVASCRIPT_ENABLED_STATE: Boolean = true

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

Link copied to clipboard
const val LOG_CONFIG_DEFAULT_LOG_LEVEL: Int
const val LOG_CONFIG_DEFAULT_LOG_LEVEL: Int
const val LOG_CONFIG_DEFAULT_LOG_LEVEL: Int

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

const val LOG_CONFIG_DEFAULT_STATE_FOR_RELEASE_BUILD: Boolean = false
const val LOG_CONFIG_DEFAULT_STATE_FOR_RELEASE_BUILD: Boolean = false
const val LOG_CONFIG_DEFAULT_STATE_FOR_RELEASE_BUILD: Boolean = false

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

const val NETWORK_AUTHORIZATION_CONFIG_DEFAULT_JWT_STATE: Boolean = false
const val NETWORK_AUTHORIZATION_CONFIG_DEFAULT_JWT_STATE: Boolean = false
const val NETWORK_AUTHORIZATION_CONFIG_DEFAULT_JWT_STATE: Boolean = false

Default value for Network API Jwt Authorization.

const val NOTIFICATION_CONFIG_DEFAULT_BACK_STACK_STATE: Boolean = true
const val NOTIFICATION_CONFIG_DEFAULT_BACK_STACK_STATE: Boolean = true
const val NOTIFICATION_CONFIG_DEFAULT_BACK_STACK_STATE: Boolean = true

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

const val NOTIFICATION_CONFIG_DEFAULT_DIRECT_POSTING: Boolean = false
const val NOTIFICATION_CONFIG_DEFAULT_DIRECT_POSTING: Boolean = false
const val NOTIFICATION_CONFIG_DEFAULT_DIRECT_POSTING: Boolean = false

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

const val NOTIFICATION_CONFIG_DEFAULT_LARGE_ICON_STATE: Boolean = true
const val NOTIFICATION_CONFIG_DEFAULT_LARGE_ICON_STATE: Boolean = true
const val NOTIFICATION_CONFIG_DEFAULT_LARGE_ICON_STATE: Boolean = true

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

const val NOTIFICATION_CONFIG_DEFAULT_MULTIPLE_NOTIFICATION_STATE: Boolean = false
const val NOTIFICATION_CONFIG_DEFAULT_MULTIPLE_NOTIFICATION_STATE: Boolean = false
const val NOTIFICATION_CONFIG_DEFAULT_MULTIPLE_NOTIFICATION_STATE: Boolean = false

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

Link copied to clipboard
const val PUSH_CONFIG_DEFAULT_TOKEN_RETRY_INTERVAL: Long = 20
const val PUSH_CONFIG_DEFAULT_TOKEN_RETRY_INTERVAL: Long = 20
const val PUSH_CONFIG_DEFAULT_TOKEN_RETRY_INTERVAL: Long = 20

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

const val PUSH_KIT_CONFIG_DEFAULT_REGISTRATION_STATE: Boolean = false
const val PUSH_KIT_CONFIG_DEFAULT_REGISTRATION_STATE: Boolean = false
const val PUSH_KIT_CONFIG_DEFAULT_REGISTRATION_STATE: Boolean = false

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

const val RTT_CONFIG_DEFAULT_BACKGROUND_SYNC_STATUS: Boolean = true
const val RTT_CONFIG_DEFAULT_BACKGROUND_SYNC_STATUS: Boolean = true
const val RTT_CONFIG_DEFAULT_BACKGROUND_SYNC_STATUS: Boolean = true

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

const val TRACKING_CONFIG_DEFAULT_CARRIER_TRACKING_STATE: Boolean = true
const val TRACKING_CONFIG_DEFAULT_CARRIER_TRACKING_STATE: Boolean = true
const val TRACKING_CONFIG_DEFAULT_CARRIER_TRACKING_STATE: Boolean = true

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

const val TRACKING_CONFIG_DEFAULT_DEVICE_ATTRIBUTE_TRACKING_STATE: Boolean = true
const val TRACKING_CONFIG_DEFAULT_DEVICE_ATTRIBUTE_TRACKING_STATE: Boolean = true
const val TRACKING_CONFIG_DEFAULT_DEVICE_ATTRIBUTE_TRACKING_STATE: Boolean = true

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

val TRACKING_CONFIG_DEFAULT_OPTED_OUT_ACTIVITIES: Set<Class<*>>
val TRACKING_CONFIG_DEFAULT_OPTED_OUT_ACTIVITIES: Set<Class<*>>
val TRACKING_CONFIG_DEFAULT_OPTED_OUT_ACTIVITIES: Set<Class<*>>

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

const val TRACKING_CONFIG_DEFAULT_PACKAGE_NAME_FILTERING_STATE: Boolean = false
const val TRACKING_CONFIG_DEFAULT_PACKAGE_NAME_FILTERING_STATE: Boolean = false
const val TRACKING_CONFIG_DEFAULT_PACKAGE_NAME_FILTERING_STATE: Boolean = false

Default value for Package Name Filtering for Screen Name Tracking

Link copied to clipboard
val TRACKING_CONFIG_WHITE_LISTED_PACKAGES: Set<String>
val TRACKING_CONFIG_WHITE_LISTED_PACKAGES: Set<String>
val TRACKING_CONFIG_WHITE_LISTED_PACKAGES: Set<String>

Default value for Whitelisted PackageNames for Screen Name Tracking