api-usage.md

APIs Usage

This document provides information on how to use the Messaging APIs to receive and display content card views in your application.

Importing Messaging

To use the Messaging APIs, you need to import the Messaging extension in your Kotlin file.

import com.adobe.marketing.mobile.Messaging

APIs

getContentCardUI

The getContentCardUI method retrieves a flow of AepUI objects for the provided surface. These AepUI objects represent templated content cards whose UI can be rendered using provided card composables.

Note - Calling this API will not download content cards from Adobe Journey Optimizer; it will only retrieve the content cards that are 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

suspend fun getContentCardUI(): Flow<List<AepUI<*, *>>>

Example

// Download the content cards for homepage surface using Messaging extension
val surfaces = mutableListOf<Surface>()
val surface = Surface("homepage")
surfaces.add(surface)
Messaging.updatePropositionsForSurfaces(surfaces)

// Initialize the ContentCardUIProvider
val contentCardUIProvider = ContentCardUIProvider(surface)

// get the content cards within a view model
class MyScreenViewModel : ViewModel {
  private val contentCardUIProvider = MessagingContentCardProvider(...)
  private val _aepUIList = MutableStateFlow<List<AepUI<*, *>>>(emptyList())
  val aepUIList: StateFlow<List<AepUI<*, *>>> = _aepUIList.asStateFlow()

  // fetch the list of cards when necessary 
  viewModelScope.launch {
    contentCardUIProvider.getContentCardUI().collect { 
      aepUi ->
      _aepUIList.value = aepUi
    }
  }
}