messaging-inapp-core/com.salesforce.android.smi.core/CoreClient

CoreClient

interface CoreClient

A CoreClient instance serves as the entry point to all Messaging for In-App actions and events.

Types

Link copied to clipboard
object Companion : Core

Functions

Link copied to clipboard
abstract fun conversationClient(conversationId: UUID = UUID.randomUUID()): ConversationClient

ConversationClient client for interacting with a conversation.

Link copied to clipboard
abstract suspend fun deregisterDevice(): Result<Unit>

Deregister the device from receiving push notifications.

Link copied to clipboard
abstract fun destroy()

Destroys this instance.

Link copied to clipboard
abstract suspend fun markAsRead(conversationEntry: ConversationEntry): Result<ConversationEntry>

Sends a read acknowledgement for a ConversationEntry.

Link copied to clipboard
abstract fun registerHiddenPreChatValuesProvider(provider: PreChatValuesProvider)

Registers a provider for supplying hidden pre-chat values.

Link copied to clipboard
abstract fun registerTemplatedUrlValuesProvider(provider: TemplatedUrlValuesProvider)

Registers a provider for supplying templated URL values for an auto-response messaging component.

Link copied to clipboard
abstract fun registerUserVerificationProvider(provider: UserVerificationProvider)

Registers a provider for authorizing an already authenticated user using one of the supported UserVerificationTypes.

Link copied to clipboard
abstract suspend fun retrieveRemoteConfiguration(): Result<RemoteConfiguration>

Retrieves the RemoteConfiguration object from Core.

Link copied to clipboard
abstract suspend fun retryEntry(conversationEntry: ConversationEntry): Result<ConversationEntry>

Re-sends a conversation entry.

Link copied to clipboard
abstract suspend fun revokeToken(deregisterDevice: Boolean): Result<Unit>

Revokes the authorization token preventing any further operations until a new token is granted. If your UserVerificationProvider returns a new token, the user is re-authorized. No action occurs in this method if Configuration.isUserVerificationRequired is set to false.

Link copied to clipboard
abstract fun start(scope: CoroutineScope)

Starts listening to remote events.

Link copied to clipboard
abstract fun stop()

Stops listening to remote events.

Properties

Link copied to clipboard
abstract val configuration: Configuration

Gets the Configuration that this instance is configured with.

Link copied to clipboard
abstract val events: SharedFlow<CoreEvent>

A SharedFlow of CoreEvents

Link copied to clipboard
abstract val networkConnectivityState: StateFlow<NetworkConnectivityStatus>

Observes the current network connectivity status.