core/com.moengage.core.config

Package-level declarations

Types

Link copied to clipboard
@Serializable
data class CardConfig @JvmOverloads constructor(@DrawableRes val cardPlaceHolderImage: Int = CARD_CONFIG_DEFAULT_PLACE_HOLDER_IMAGE_RESOURCE_ID, @DrawableRes val inboxEmptyImage: Int = CARD_CONFIG_DEFAULT_EMPTY_INBOX_IMAGE_RESOURCE_ID, val cardsDateFormat: String = CARD_CONFIG_DEFAULT_DATE_FORMAT, val isSwipeRefreshEnabled: Boolean = CARD_CONFIG_DEFAULT_SWIPE_REFRESH_STATE)

Card Configuration.

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

Data Sync configuration

Link copied to clipboard
@Serializable
data class DomainConfig(val customBaseDomain: String)

Configuration class for defining custom network domains.

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

Create an instance of Firebase Messaging Config.

Link copied to clipboard
@Serializable
data class InAppConfig @JvmOverloads constructor(val optOutActivities: List<String> = INAPP_CONFIG_DEFAULT_INAPP_OPT_OUT_ACTIVITIES, val isShowInAppInNewActivityEnabled: Boolean = INAPP_CONFIG_DEFAULT_ADDITIONAL_ACTIVITY_STATE)
Link copied to clipboard
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)

Log Configuration Object.

Link copied to clipboard
@Serializable
data class MoEngageEnvironmentConfig(val environment: MoEngageEnvironment)
Link copied to clipboard
@Serializable
data class NetworkAuthorizationConfig @JvmOverloads constructor(val isJwtEnabled: Boolean, val shouldEnableForAllUsers: Boolean = NETWORK_AUTHORIZATION_CONFIG_DEFAULT_ALL_USER_ENABLED_STATE)

Create an instance of Network Authorization Config.

Link copied to clipboard
@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 @JvmOverloads constructor(var networkDataSecurityConfig: NetworkDataSecurityConfig = NetworkDataSecurityConfig.defaultConfig(), val networkAuthorizationConfig: NetworkAuthorizationConfig = NetworkAuthorizationConfig.defaultConfig(), val shouldCacheConnection: Boolean = NETWORK_REQUEST_DEFAULT_CONNECTION_CACHE_CONFIG, val domainConfig: DomainConfig = DomainConfig.defaultConfig())

Create an instance of Network Request Config.

Link copied to clipboard
@Serializable
data class NotificationConfig(@DrawableRes val smallIcon: Int = NOTIFICATION_CONFIG_DEFAULT_SMALL_ICON_RESOURCE_ID, @DrawableRes val largeIcon: Int = NOTIFICATION_CONFIG_DEFAULT_LARGE_ICON_RESOURCE_ID, @ColorRes val notificationColor: Int = NOTIFICATION_CONFIG_DEFAULT_COLOR_RESOURCE_ID, val isMultipleNotificationInDrawerEnabled: Boolean = NOTIFICATION_CONFIG_DEFAULT_MULTIPLE_NOTIFICATION_STATE, val isBuildingBackStackEnabled: Boolean = NOTIFICATION_CONFIG_DEFAULT_BACK_STACK_STATE, val isLargeIconDisplayEnabled: Boolean = NOTIFICATION_CONFIG_DEFAULT_LARGE_ICON_STATE, val isDirectPostingForHeadsUpEnabled: Boolean = NOTIFICATION_CONFIG_DEFAULT_DIRECT_POSTING)

Notification Configuration object.

Link copied to clipboard
@Serializable
data class ProjectConfig(val projectId: String)
Link copied to clipboard
@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)

Create an instance of PushKit Messaging Config.

Link copied to clipboard
@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>)

Configuration for Screen Name Tracking

Link copied to clipboard
@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)

Storage security configuration

Link copied to clipboard
@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)

Create an instance of UserRegistrationConfig

Properties

Link copied to clipboard
const val CARD_CONFIG_DEFAULT_DATE_FORMAT: String

Default date format for any card.

const val CARD_CONFIG_DEFAULT_EMPTY_INBOX_IMAGE_RESOURCE_ID: Int

Default resource id for the empty inbox.

const val CARD_CONFIG_DEFAULT_PLACE_HOLDER_IMAGE_RESOURCE_ID: Int

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.

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_INTERVAL: Long

Default value for periodic flush time interval.

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 DEFAULT_FILE_BASED_INITIALISATION_STATE: Boolean = true

Default value for file based initialisation

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.

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: List<String>

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

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

const val JAVASCRIPT_CONFIG_DEFAULT_STATE_JAVASCRIPT_USAGE: Boolean = true

Default state of Javascript usage in WebView.

Link copied to clipboard
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

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

const val NETWORK_AUTHORIZATION_CONFIG_DEFAULT_ALL_USER_ENABLED_STATE: Boolean = false

Default value for Network API Authorization for all users.

const val NETWORK_AUTHORIZATION_CONFIG_DEFAULT_JWT_STATE: Boolean = false

Default value for Network API Jwt Authorization.

const val NETWORK_DATA_SECURITY_CONFIG_DEFAULT_DATA_ENCRYPTION_STATE: Boolean = false

Default value for Network API Data Encryption.

const val NETWORK_REQUEST_DEFAULT_CONNECTION_CACHE_CONFIG: Boolean = true

Default Value for Connection Cache Config

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_COLOR_RESOURCE_ID: Int

Default resource id for notification color.

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_RESOURCE_ID: Int

Default resource id for notification large icon.

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

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

const val NOTIFICATION_CONFIG_DEFAULT_SMALL_ICON_RESOURCE_ID: Int

Default resource id for notification small icon.

Link copied to clipboard
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

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

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

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

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: List<String>

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

Default value for Package Name Filtering for Screen Name Tracking

Link copied to clipboard
val TRACKING_CONFIG_WHITE_LISTED_PACKAGES: Set<String>

Default value for Whitelisted PackageNames for Screen Name Tracking

const val USER_REGISTRATION_CONFIG_DEFAULT_USER_REGISTRATION_STATE: Boolean = false

Default value for User Registration State.