API Reference

This document provides information on how to use the Messaging APIs to retrieve and display inbox views in your application.

getInboxUI

The getInboxUI method retrieves a flow of InboxUIState for the provided surface. The InboxUIState represents the current state of the inbox (Loading, Success, or Error) and includes the inbox template and content cards to be rendered using the AepInbox composable.

data-variant=info

data-slots=text
Calling this API will not download the inbox configuration or content cards from Adobe Journey Optimizer; it will only retrieve the data that is already downloaded and cached by the Messaging extension. You must call updatePropositionsForSurfaces API from the AEPMessaging extension with the desired surfaces prior to calling this API.

Syntax

data-slots=heading, code

data-repeat=1

data-languages=Kotlin

Kotlin

fun getInboxUI(): Flow<InboxUIState>

refresh

The refresh method refreshes the Inbox content by fetching new inbox and content cards propositions from the device cache and updating the flow returned by getInboxUI. This will cause all collectors of the flow to receive the updated inbox state.

data-variant=info

data-slots=text
getInboxUI automatically loads initial content when first collected, so this method is only needed for manual refresh operations (e.g., pull-to-refresh or refresh button).

Syntax

data-slots=heading, code

data-repeat=1

data-languages=Kotlin

Kotlin

suspend fun refresh()

Example

data-slots=heading, code

data-repeat=1

data-languages=Kotlin

Kotlin

import androidx.lifecycle.ViewModel
import androidx.lifecycle.viewModelScope
import com.adobe.marketing.mobile.Messaging
import com.adobe.marketing.mobile.aepcomposeui.components.AepInbox
import com.adobe.marketing.mobile.aepcomposeui.state.InboxUIState
import com.adobe.marketing.mobile.messaging.InboxEventObserver
import com.adobe.marketing.mobile.messaging.MessagingInboxProvider
import com.adobe.marketing.mobile.messaging.Surface
import kotlinx.coroutines.flow.SharingStarted
import kotlinx.coroutines.flow.StateFlow
import kotlinx.coroutines.flow.stateIn
import kotlinx.coroutines.launch

private val inboxSurface = Surface("inbox")

// Prefetch (e.g. on login or before opening the inbox screen)
Messaging.updatePropositionsForSurfaces(listOf(inboxSurface))

class InboxViewModel : ViewModel() {
    val inboxProvider = MessagingInboxProvider(inboxSurface)
    val observer = InboxEventObserver(inboxProvider)

    val inboxUIState: StateFlow<InboxUIState> = inboxProvider.getInboxUI()
        .stateIn(
            scope = viewModelScope,
            started = SharingStarted.WhileSubscribed(5000),
            initialValue = InboxUIState.Loading
        )

    fun refresh() {
        viewModelScope.launch {
            Messaging.updatePropositionsForSurfaces(listOf(inboxSurface))
            inboxProvider.refresh()
        }
    }
}

@Composable
fun InboxScreen(viewModel: InboxViewModel = viewModel()) {
    val inboxUIState by viewModel.inboxUIState.collectAsState()

    MaterialTheme {
        AepInbox(
            uiState = inboxUIState,
            observer = viewModel.observer
        )
    }
}