diff --git a/src/pages/edge/adobe-journey-optimizer/content-card-ui/Android/api-usage.md b/src/pages/edge/adobe-journey-optimizer/content-card-ui/Android/api-usage.md index cba2f0a454..39cdc0d83d 100644 --- a/src/pages/edge/adobe-journey-optimizer/content-card-ui/Android/api-usage.md +++ b/src/pages/edge/adobe-journey-optimizer/content-card-ui/Android/api-usage.md @@ -23,7 +23,7 @@ The `getContentCardUI` method retrieves a flow of [AepUI](./public-classes/aepui -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`](../../code-based/api-reference.md#updatePropositionsForSurfaces) API from the AEPMessaging extension with the desired surfaces prior to calling this API. +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`](../../code-based/api-reference.md#updatePropositionsForSurfaces) API from the AEPMessaging extension with the desired surfaces prior to calling this API. #### Syntax diff --git a/src/pages/edge/adobe-journey-optimizer/content-card-ui/Android/index.md b/src/pages/edge/adobe-journey-optimizer/content-card-ui/Android/index.md index 4787abeca3..e6d77b48f3 100644 --- a/src/pages/edge/adobe-journey-optimizer/content-card-ui/Android/index.md +++ b/src/pages/edge/adobe-journey-optimizer/content-card-ui/Android/index.md @@ -17,7 +17,7 @@ keywords: ## Requirements -* Latest version of [Android Studio](https://developer.android.com/studio) +* Latest version of [Android Studio](https://developer.android.com/studio) * Android API 21 (or newer) * Kotlin 1.5.0 (or newer) * App with support for [Jetpack Compose](https://developer.android.com/develop/ui/compose/setup) @@ -28,37 +28,37 @@ keywords: ## Public Classes, Enums, and Interfaces -- [Interface - AepUI](./public-classes/aepui.md) -- [Class - ContentCardMapper](./public-classes/contentcardmapper.md) -- [Interface - ContentCardUIEventListener](./public-classes/contentcarduieventlistener.md) -- [Class - UIAction](./public-classes/uiaction.md) -- [Class - UIEvent](./public-classes/uievent.md) +* [Interface - AepUI](./public-classes/aepui.md) +* [Class - ContentCardMapper](./public-classes/contentcardmapper.md) +* [Interface - ContentCardUIEventListener](./public-classes/contentcarduieventlistener.md) +* [Class - UIAction](./public-classes/uiaction.md) +* [Class - UIEvent](./public-classes/uievent.md) ## Content Provider -- [AepUIContentProvider](./public-classes/content-provider/aepuicontentprovider.md) -- [ContentCardUIProvider](./public-classes/content-provider/contentcarduiprovider.md) +* [AepUIContentProvider](./public-classes/content-provider/aepuicontentprovider.md) +* [ContentCardUIProvider](./public-classes/content-provider/contentcarduiprovider.md) ## Observers -- [AepUIEventObserver](./public-classes/observers/aepuieventobserver.md) -- [ContentCardEventObserver](./public-classes/observers/contentcardeventobserver.md) +* [AepUIEventObserver](./public-classes/observers/aepuieventobserver.md) +* [ContentCardEventObserver](./public-classes/observers/contentcardeventobserver.md) ## State -- [AepCardUIState](./public-classes/state/aepcarduistate.md) -- [SmallImageCardUIState](./public-classes/state/smallimagecarduistate.md) +* [AepCardUIState](./public-classes/state/aepcarduistate.md) +* [SmallImageCardUIState](./public-classes/state/smallimagecarduistate.md) ## Styles -- [AepButtonStyle](./public-classes/styles/aepbuttonstyle.md) -- [AepCardStyle](./public-classes/styles/aepcardstyle.md) -- [AepColumnStyle](./public-classes/styles/aepcolumnstyle.md) -- [AepIconStyle](./public-classes/styles/aepiconstyle.md) -- [AepImageStyle](./public-classes/styles/aepimagestyle.md) -- [AepRowStyle](./public-classes/styles/aeprowstyle.md) -- [AepTextStyle](./public-classes/styles/aeptextstyle.md) -- [SmallImageUIStyle](./public-classes/styles/smallimageuistyle.md) +* [AepButtonStyle](./public-classes/styles/aepbuttonstyle.md) +* [AepCardStyle](./public-classes/styles/aepcardstyle.md) +* [AepColumnStyle](./public-classes/styles/aepcolumnstyle.md) +* [AepIconStyle](./public-classes/styles/aepiconstyle.md) +* [AepImageStyle](./public-classes/styles/aepimagestyle.md) +* [AepRowStyle](./public-classes/styles/aeprowstyle.md) +* [AepTextStyle](./public-classes/styles/aeptextstyle.md) +* [SmallImageUIStyle](./public-classes/styles/smallimageuistyle.md) ## UI Models diff --git a/src/pages/edge/adobe-journey-optimizer/content-card-ui/Android/public-classes/aepui.md b/src/pages/edge/adobe-journey-optimizer/content-card-ui/Android/public-classes/aepui.md index 076418e1c8..97afd452c1 100644 --- a/src/pages/edge/adobe-journey-optimizer/content-card-ui/Android/public-classes/aepui.md +++ b/src/pages/edge/adobe-journey-optimizer/content-card-ui/Android/public-classes/aepui.md @@ -17,7 +17,7 @@ keywords: The `AepUI` interface represents a UI component that can be rendered using the AEP compose UI library. The AEP compose UI currently supports rendering the following UI templates: -1. `SmallImageUI` which renders `Small Image template` +1. `SmallImageUI` which renders `Small Image template` ## Interface Definition @@ -35,7 +35,7 @@ sealed interface AepUI { ## Methods -### getTemplate +### getTemplate Retrieves the template associated with this UI component. @@ -53,7 +53,7 @@ A template of type `T` which is an implementation of the `AepUITemplate` interf fun getTemplate(): T ``` -### getState +### getState Retrieves the current state of the UI component. @@ -71,13 +71,13 @@ A state of type `S` which is a subclass of the `AepCardUIState` class. fun getState(): S ``` -### updateState +### updateState Updates the state of the UI component with a new state. #### Parameters -- _newState_ - The new state of type `S` to update within the UI component. +* _newState_ - The new state of type `S` to update within the UI component. #### Syntax @@ -110,7 +110,7 @@ class SmallImageUI( ## Methods -### getTemplate +### getTemplate Retrieves the template associated with the small image UI. @@ -128,7 +128,7 @@ The small image template. override fun getTemplate(): SmallImageTemplate ``` -### getState +### getState Retrieves the current state of the small image UI. @@ -146,13 +146,13 @@ The current SmallImageCardUIState. override fun getState(): SmallImageCardUIState ``` -### updateState +### updateState Updates the current state of the small image UI. #### Parameters -- _newState_ - The new state of type `SmallImageCardUIState` to update within the UI component. +* _newState_ - The new state of type `SmallImageCardUIState` to update within the UI component. #### Syntax diff --git a/src/pages/edge/adobe-journey-optimizer/content-card-ui/Android/public-classes/content-provider/aepuicontentprovider.md b/src/pages/edge/adobe-journey-optimizer/content-card-ui/Android/public-classes/content-provider/aepuicontentprovider.md index 5a8ba15ad8..f559823dcb 100644 --- a/src/pages/edge/adobe-journey-optimizer/content-card-ui/Android/public-classes/content-provider/aepuicontentprovider.md +++ b/src/pages/edge/adobe-journey-optimizer/content-card-ui/Android/public-classes/content-provider/aepuicontentprovider.md @@ -15,7 +15,7 @@ keywords: # AepUIContentProvider -Responsible for retrieving and refreshing data as required by the UI. +Responsible for retrieving and refreshing data as required by the UI. Classes implementing this interface will define a strategy to provide content for rendering the UI. @@ -64,4 +64,4 @@ Refreshes the content for the UI. Implementations should update the data into th ```kotlin suspend fun refreshContent() -``` \ No newline at end of file +``` diff --git a/src/pages/edge/adobe-journey-optimizer/content-card-ui/Android/public-classes/content-provider/contentcarduiprovider.md b/src/pages/edge/adobe-journey-optimizer/content-card-ui/Android/public-classes/content-provider/contentcarduiprovider.md index 7e0060931a..f81311b087 100644 --- a/src/pages/edge/adobe-journey-optimizer/content-card-ui/Android/public-classes/content-provider/contentcarduiprovider.md +++ b/src/pages/edge/adobe-journey-optimizer/content-card-ui/Android/public-classes/content-provider/contentcarduiprovider.md @@ -68,4 +68,3 @@ Updates the flow returned by [getContent](#getContent) with the latest cached co ```kotlin override suspend fun refreshContent() ``` - diff --git a/src/pages/edge/adobe-journey-optimizer/content-card-ui/Android/public-classes/contentcardmapper.md b/src/pages/edge/adobe-journey-optimizer/content-card-ui/Android/public-classes/contentcardmapper.md index 3e513b2954..346284fd16 100644 --- a/src/pages/edge/adobe-journey-optimizer/content-card-ui/Android/public-classes/contentcardmapper.md +++ b/src/pages/edge/adobe-journey-optimizer/content-card-ui/Android/public-classes/contentcardmapper.md @@ -42,7 +42,7 @@ Returns a `ContentCardSchemaData` object for the given proposition id. #### Parameters -- _propositionId_ - the proposition id to use as a key in the `ContentCardSchemaData` map. +* _propositionId_ - the proposition id to use as a key in the `ContentCardSchemaData` map. #### Returns diff --git a/src/pages/edge/adobe-journey-optimizer/content-card-ui/Android/public-classes/contentcarduieventlistener.md b/src/pages/edge/adobe-journey-optimizer/content-card-ui/Android/public-classes/contentcarduieventlistener.md index cea412d4c9..7096c5975b 100644 --- a/src/pages/edge/adobe-journey-optimizer/content-card-ui/Android/public-classes/contentcarduieventlistener.md +++ b/src/pages/edge/adobe-journey-optimizer/content-card-ui/Android/public-classes/contentcarduieventlistener.md @@ -39,7 +39,7 @@ Callback to invoke when a content card is displayed. #### Parameters -- _aepUI_ - The [AepUI](./aepui.md) instance that was displayed. +* _aepUI_ - The [AepUI](./aepui.md) instance that was displayed. #### Syntax @@ -57,7 +57,7 @@ Callback to invoke when a content card is dismissed. #### Parameters -- _aepUI_ - The [AepUI](./aepui.md) instance that was dismissed. +* _aepUI_ - The [AepUI](./aepui.md) instance that was dismissed. #### Syntax @@ -75,9 +75,9 @@ Callback to invoke when a content card is interacted with. #### Parameters -- _aepUI_ - The [AepUI](./aepui.md) instance that was interacted with. -- _interactionId_ - An optional string identifier for the interaction event. -- _actionUrl_ - An optional URL associated with the interaction. +* _aepUI_ - The [AepUI](./aepui.md) instance that was interacted with. +* _interactionId_ - An optional string identifier for the interaction event. +* _actionUrl_ - An optional URL associated with the interaction. #### Returns @@ -91,4 +91,4 @@ A boolean value indicating whether the interaction event was handled. Return `tr ```kotlin fun onInteract(aepUI: AepUI<*, *>, interactionId: String?, actionUrl: String?): Boolean -``` \ No newline at end of file +``` diff --git a/src/pages/edge/adobe-journey-optimizer/content-card-ui/Android/public-classes/observers/aepuieventobserver.md b/src/pages/edge/adobe-journey-optimizer/content-card-ui/Android/public-classes/observers/aepuieventobserver.md index f789d635fa..22d40c859c 100644 --- a/src/pages/edge/adobe-journey-optimizer/content-card-ui/Android/public-classes/observers/aepuieventobserver.md +++ b/src/pages/edge/adobe-journey-optimizer/content-card-ui/Android/public-classes/observers/aepuieventobserver.md @@ -16,6 +16,7 @@ keywords: # AepUIEventObserver Interface for observing events related to AEP UI components. This interface defines a mechanism for handling various types of events triggered by lifecycle changes or user interactions with UI elements, such as display, dismiss, or user interaction events. + ## Interface Definition @@ -36,7 +37,7 @@ Called when an event related to a UI template occurs. #### Parameters -- _event_ - The event to handle. Implementers can provide specific logic based on the type of UIEvent +* _event_ - The event to handle. Implementers can provide specific logic based on the type of UIEvent #### Syntax diff --git a/src/pages/edge/adobe-journey-optimizer/content-card-ui/Android/public-classes/observers/contentcardeventobserver.md b/src/pages/edge/adobe-journey-optimizer/content-card-ui/Android/public-classes/observers/contentcardeventobserver.md index b9e82aa10c..398d9c2ad7 100644 --- a/src/pages/edge/adobe-journey-optimizer/content-card-ui/Android/public-classes/observers/contentcardeventobserver.md +++ b/src/pages/edge/adobe-journey-optimizer/content-card-ui/Android/public-classes/observers/contentcardeventobserver.md @@ -19,7 +19,7 @@ Messaging implementation of [AepUIEventObserver](./aepuieventobserver.md) for ha #### Class Parameters -- _callback_ - An optional [ContentCardUIEventListener](../contentcarduieventlistener.md) to invoke when a content card event occurs. +* _callback_ - An optional [ContentCardUIEventListener](../contentcarduieventlistener.md) to invoke when a content card event occurs. ## Methods diff --git a/src/pages/edge/adobe-journey-optimizer/content-card-ui/Android/public-classes/state/aepcarduistate.md b/src/pages/edge/adobe-journey-optimizer/content-card-ui/Android/public-classes/state/aepcarduistate.md index af40357dd1..3ce6f71ce3 100644 --- a/src/pages/edge/adobe-journey-optimizer/content-card-ui/Android/public-classes/state/aepcarduistate.md +++ b/src/pages/edge/adobe-journey-optimizer/content-card-ui/Android/public-classes/state/aepcarduistate.md @@ -16,6 +16,7 @@ keywords: # AepCardUIState Class representing the state of an AEP card. This class includes the properties `dismissed` and `displayed` which are common across different card states. + ## Class Definition diff --git a/src/pages/edge/adobe-journey-optimizer/content-card-ui/Android/public-classes/state/smallimagecarduistate.md b/src/pages/edge/adobe-journey-optimizer/content-card-ui/Android/public-classes/state/smallimagecarduistate.md index 06002388d1..6f48b34f7e 100644 --- a/src/pages/edge/adobe-journey-optimizer/content-card-ui/Android/public-classes/state/smallimagecarduistate.md +++ b/src/pages/edge/adobe-journey-optimizer/content-card-ui/Android/public-classes/state/smallimagecarduistate.md @@ -16,6 +16,7 @@ keywords: # SmallImageCardUIState Class which implements [AepCardUIState](./aepcarduistate.md) and represents the UI state of a Small Image template card. + ## Class Definition diff --git a/src/pages/edge/adobe-journey-optimizer/content-card-ui/Android/public-classes/styles/aepcolumnstyle.md b/src/pages/edge/adobe-journey-optimizer/content-card-ui/Android/public-classes/styles/aepcolumnstyle.md index 3e1a646370..590cd8c829 100644 --- a/src/pages/edge/adobe-journey-optimizer/content-card-ui/Android/public-classes/styles/aepcolumnstyle.md +++ b/src/pages/edge/adobe-journey-optimizer/content-card-ui/Android/public-classes/styles/aepcolumnstyle.md @@ -24,4 +24,3 @@ Class representing the style for a column within an AEP UI composable. | modifier | [Modifier](https://developer.android.com/reference/kotlin/androidx/compose/ui/Modifier)? | The modifier for the column. | | verticalArrangement | [Arrangement.Vertical](https://developer.android.com/reference/kotlin/androidx/compose/foundation/layout/Arrangement.Vertical)? | The vertical arrangement for the column. | | horizontalAlignment | [Alignment.Horizontal](https://developer.android.com/reference/kotlin/androidx/compose/ui/Alignment.Horizontal?hl=en)? | The horizontal alignment for the column. | - diff --git a/src/pages/edge/adobe-journey-optimizer/content-card-ui/Android/public-classes/styles/smallimageuistyle.md b/src/pages/edge/adobe-journey-optimizer/content-card-ui/Android/public-classes/styles/smallimageuistyle.md index aa274aaeb2..f490c61916 100644 --- a/src/pages/edge/adobe-journey-optimizer/content-card-ui/Android/public-classes/styles/smallimageuistyle.md +++ b/src/pages/edge/adobe-journey-optimizer/content-card-ui/Android/public-classes/styles/smallimageuistyle.md @@ -52,4 +52,4 @@ val smallImageCardStyleRow = SmallImageUIStyle.Builder() ) .titleAepTextStyle(AepTextStyle(textStyle = TextStyle(Color.Green))) .build() -``` \ No newline at end of file +``` diff --git a/src/pages/edge/adobe-journey-optimizer/content-card-ui/Android/public-classes/ui-models/aepuitemplate.md b/src/pages/edge/adobe-journey-optimizer/content-card-ui/Android/public-classes/ui-models/aepuitemplate.md index e2348671cc..247aca69d7 100644 --- a/src/pages/edge/adobe-journey-optimizer/content-card-ui/Android/public-classes/ui-models/aepuitemplate.md +++ b/src/pages/edge/adobe-journey-optimizer/content-card-ui/Android/public-classes/ui-models/aepuitemplate.md @@ -19,7 +19,7 @@ Interface representing a generic UI template in AEP. ## Methods -### getType +### getType Gets the type of the UI template. @@ -31,4 +31,4 @@ Gets the type of the UI template. ``` kotlin fun getType(): AepUITemplateType -``` \ No newline at end of file +``` diff --git a/src/pages/edge/adobe-journey-optimizer/content-card-ui/Android/public-classes/ui-models/aepuitemplatetype.md b/src/pages/edge/adobe-journey-optimizer/content-card-ui/Android/public-classes/ui-models/aepuitemplatetype.md index 7e1f429e70..508dc4abbb 100644 --- a/src/pages/edge/adobe-journey-optimizer/content-card-ui/Android/public-classes/ui-models/aepuitemplatetype.md +++ b/src/pages/edge/adobe-journey-optimizer/content-card-ui/Android/public-classes/ui-models/aepuitemplatetype.md @@ -15,7 +15,7 @@ keywords: # AepUITemplateType -An enumeration of the different types of content card templates supported by the Messaging framework. +An enumeration of the different types of content card templates supported by the Messaging framework. Each case corresponds to a specific template type, identified by its JSON string value. diff --git a/src/pages/edge/adobe-journey-optimizer/content-card-ui/Android/public-classes/ui-models/smallimagetemplate.md b/src/pages/edge/adobe-journey-optimizer/content-card-ui/Android/public-classes/ui-models/smallimagetemplate.md index 3ba739e4f6..6ad71849a0 100644 --- a/src/pages/edge/adobe-journey-optimizer/content-card-ui/Android/public-classes/ui-models/smallimagetemplate.md +++ b/src/pages/edge/adobe-journey-optimizer/content-card-ui/Android/public-classes/ui-models/smallimagetemplate.md @@ -31,7 +31,7 @@ Class which implements [AepUITemplateType](./aepuitemplatetype) and represents a ## Methods -### getType +### getType Returns the type of this template, which is `AepUITemplateType.SMALL_IMAGE`. @@ -43,4 +43,4 @@ Returns the type of this template, which is `AepUITemplateType.SMALL_IMAGE`. ``` kotlin override fun getType() = AepUITemplateType.SMALL_IMAGE -``` \ No newline at end of file +``` diff --git a/src/pages/edge/adobe-journey-optimizer/content-card-ui/Android/public-classes/uiaction.md b/src/pages/edge/adobe-journey-optimizer/content-card-ui/Android/public-classes/uiaction.md index 5aeb7daa5f..aca96d2647 100644 --- a/src/pages/edge/adobe-journey-optimizer/content-card-ui/Android/public-classes/uiaction.md +++ b/src/pages/edge/adobe-journey-optimizer/content-card-ui/Android/public-classes/uiaction.md @@ -47,4 +47,3 @@ Represents a click UIAction that can be performed on a UI component. ``` kotlin data class Click(val id: String, val actionUrl: String?) : UIAction() ``` - diff --git a/src/pages/edge/adobe-journey-optimizer/content-card-ui/Android/public-classes/uievent.md b/src/pages/edge/adobe-journey-optimizer/content-card-ui/Android/public-classes/uievent.md index 3543d41626..07f150a5cb 100644 --- a/src/pages/edge/adobe-journey-optimizer/content-card-ui/Android/public-classes/uievent.md +++ b/src/pages/edge/adobe-journey-optimizer/content-card-ui/Android/public-classes/uievent.md @@ -16,6 +16,7 @@ keywords: # UIEvent Represents different types of UI events that can be triggered by the user interaction on the UI templates. + #### Class Parameters | Parameter | Type | Description | diff --git a/src/pages/edge/adobe-journey-optimizer/content-card-ui/Android/tutorial/displaying-content-cards.md b/src/pages/edge/adobe-journey-optimizer/content-card-ui/Android/tutorial/displaying-content-cards.md index 96e2152b1f..592f7b5982 100644 --- a/src/pages/edge/adobe-journey-optimizer/content-card-ui/Android/tutorial/displaying-content-cards.md +++ b/src/pages/edge/adobe-journey-optimizer/content-card-ui/Android/tutorial/displaying-content-cards.md @@ -76,6 +76,7 @@ Note - only content cards for which the user has qualified are returned by the g ## Display Content Cards The Content Card user interface is implemented using Jetpack Compose, which is the recommended toolkit for Android development. To display content cards in your app, pass the `AepUI` objects returned by the `getContentCardUI` API to the appropriate Content Card composable. The currently supported composables are: + 1. SmallImageCard composable for SmallImageUI ### Display Content Cards in Compose UI application diff --git a/src/pages/edge/adobe-journey-optimizer/content-card-ui/Android/tutorial/listening-content-card-events.md b/src/pages/edge/adobe-journey-optimizer/content-card-ui/Android/tutorial/listening-content-card-events.md index 02f7fa09bd..360c5313e2 100644 --- a/src/pages/edge/adobe-journey-optimizer/content-card-ui/Android/tutorial/listening-content-card-events.md +++ b/src/pages/edge/adobe-journey-optimizer/content-card-ui/Android/tutorial/listening-content-card-events.md @@ -19,9 +19,9 @@ This tutorial explains how to listen to content card events in your application. The Messaging extension provides a way to listen to events from content cards displayed in your application. The following functions can be implemented in conformance with the `ContentCardUIEventListener` interface: -- `onDisplay` -- `onDismiss` -- `onInteract` +* `onDisplay` +* `onDismiss` +* `onInteract` ## Implement ContentCardUIEventListener @@ -94,9 +94,9 @@ private fun AepContentCardList(viewModel: AepContentCardViewModel) { The `onInteract` method provides an optional `actionURL` parameter associated with the interaction event. The return value of this method determines how the URL is handled. -- Return `true` if your application has successfully handled the URL. This indicates to the SDK that no further action is needed. +* Return `true` if your application has successfully handled the URL. This indicates to the SDK that no further action is needed. -- Return `false` to allow the SDK to process the URL. +* Return `false` to allow the SDK to process the URL.