Marketing Cloud SDK / com.salesforce.marketingcloud / InitializationStatus

InitializationStatus

class InitializationStatus

Represents the initialization status of the MarketingCloudSdk

Types

Status

Represents the overall outcome of the SDK's initialization.

enum class Status

Properties

encryptionChanged

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.

val encryptionChanged: Boolean

initializedComponents

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

val initializedComponents: List<String>

isUsable

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

val isUsable: Boolean

locationsError

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

val locationsError: Boolean

messagingPermissionError

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.

val messagingPermissionError: Boolean

playServicesMessage

The message from the encountered error represented by playServicesStatus

val playServicesMessage: String?

playServicesStatus

This will be the availability status returned by GoogleApiAvailability.

val playServicesStatus: Int

proximityError

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()}.

val proximityError: Boolean

sslProviderEnablementError

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

val sslProviderEnablementError: Boolean

status

Initialization status of the SDK.

val status: Status

storageError

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.

val storageError: Boolean

unrecoverableException

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

val unrecoverableException: Throwable?

Functions

encryptionChanged

fun encryptionChanged(): Boolean

initializedComponents

fun initializedComponents(): List<String>

locationsError

fun locationsError(): Boolean

messagingPermissionError

fun messagingPermissionError(): Boolean

playServicesMessage

fun playServicesMessage(): String?

playServicesStatus

fun playServicesStatus(): Int

proximityError

fun proximityError(): Boolean

sslProviderEnablementError

fun sslProviderEnablementError(): Boolean

status

fun status(): Status

storageError

fun storageError(): Boolean

toString

fun toString(): String

unrecoverableException

fun unrecoverableException(): Throwable?