InitializationStatus

Represents the initialization status of the MarketingCloudSdk

Types

Link copied to clipboard

Represents the overall outcome of the SDK's initialization.

Properties

Link copied to clipboard
@get:JvmName(name = "encryptionChanged")
val encryptionChanged: Boolean

Indicates whether the encryption key has changed since the last call to MarketingCloudSdkinit. If true then all date previously stored has been cleared as we could not safely access it.

Link copied to clipboard
@get:JvmName(name = "initializedComponents")
val initializedComponents: List<String>

List of component names that were initialized in the SDK. This will be useful information for debugging any issues with SDK initialization.

Link copied to clipboard
@get:JvmName(name = "isUsable")
val isUsable: Boolean

Indicates whether the SDK was able to initialize itself enough to be 'usable'. status will return Status.SUCCESS or Status.COMPLETED_WITH_DEGRADED_FUNCTIONALITY.

Link copied to clipboard
@get:JvmName(name = "locationsError")
val locationsError: Boolean

If geofencing or proximity have been enabled then this method will return whether an error was encountered while trying to initialize the location manager.

Link copied to clipboard
@get:JvmName(name = "messagingPermissionError")
val messagingPermissionError: Boolean

Indicates that region messaging was unable to be turned on after a restart due to the android.Manifest.permission.ACCESS_FINE_LOCATION or android.Manifest.permission.ACCESS_BACKGROUND_LOCATION no longer being granted.

Link copied to clipboard
@get:JvmName(name = "playServicesMessage")
val playServicesMessage: String?

The message from the encountered error represented by playServicesStatus

Link copied to clipboard
@get:JvmName(name = "playServicesStatus")
val playServicesStatus: Int

This will be the availability status returned by GoogleApiAvailability.

Link copied to clipboard
@get:JvmName(name = "proximityError")
val proximityError: Boolean

Indicates whether there was an error trying to initialize the SDK's proximity manager. For information on what might have gone wrong use {@link MarketingCloudSdk#getSdkState()}.

Link copied to clipboard
@get:JvmName(name = "sslProviderEnablementError")
val sslProviderEnablementError: Boolean

The Salesforce Marketing Cloud SDK will call Google Play Services com.google.android.gms.security.ProviderInstaller.installIfNeeded(android.content.Context) to ensure you have the required providers to communicate with the Marketing Cloud servers.

Link copied to clipboard
@get:JvmName(name = "status")
val status: InitializationStatus.Status

Initialization status of the SDK.

Link copied to clipboard
@get:JvmName(name = "storageError")
val storageError: Boolean

Indicates whether there was an error trying to initialize the SDK's storage. If there was an error that means the SDK is unable to store any information and you should expect Status.FAILED as the initialization status.

Link copied to clipboard
@get:JvmName(name = "unrecoverableException")
val unrecoverableException: Throwable?

If an unrecoverable exception was encountered during initialization then it can be accessed here.