AepUI

The AepUI interface represents a UI component that can be rendered using the Adobe Experience Platform compose UI library. The Experience Platform compose UI library currently supports rendering the following UI template:

SmallImageUI which renders Small Image template
LargeImageUI which renders Large Image template
ImageOnlyUI which renders Image Only template

Interface Definition

Kotlin

sealed interface AepUI<T : AepUITemplate, S : AepCardUIState> {
    fun getTemplate(): T
    fun getState(): S
    fun updateState(newState: S)
}
Copied to your clipboard
sealed interface AepUI<T : AepUITemplate, S : AepCardUIState> {
    fun getTemplate(): T
    fun getState(): S
    fun updateState(newState: S)
}

Methods

getTemplate

Retrieves the template associated with this UI component.

Returns

A template of type T which is an implementation of the AepUITemplate interface.

Syntax

Kotlin

fun getTemplate(): T
Copied to your clipboard
fun getTemplate(): T

getState

Retrieves the current state of the UI component.

Returns

A state of type S which is a subclass of the AepCardUIState class.

Syntax

Kotlin

fun getState(): S
Copied to your clipboard
fun getState(): S

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.

Syntax

Kotlin

fun updateState(newState: S)
Copied to your clipboard
fun updateState(newState: S)

Implementing Classes

ImageOnlyUI

Implementation of the AepUI interface used in rendering a UI for a ImageOnlyTemplate.

Class Definition

Kotlin

class ImageOnlyUI(
    private val template: ImageOnlyTemplate,
    state: ImageOnlyCardUIState
) : AepUI<ImageOnlyTemplate, ImageOnlyCardUIState>
Copied to your clipboard
class ImageOnlyUI(
    private val template: ImageOnlyTemplate,
    state: ImageOnlyCardUIState
) : AepUI<ImageOnlyTemplate, ImageOnlyCardUIState>

LargeImageUI

Implementation of the AepUI interface used in rendering a UI for a LargeImageTemplate.

Class Definition

Kotlin

class LargeImageUI(
    private val template: LargeImageTemplate,
    state: LargeImageCardUIState
) : AepUI<LargeImageTemplate, LargeImageCardUIState>
Copied to your clipboard
class LargeImageUI(
    private val template: LargeImageTemplate,
    state: LargeImageCardUIState
) : AepUI<LargeImageTemplate, LargeImageCardUIState>

SmallImageUI

Implementation of the AepUI interface used in rendering a UI for a SmallImageTemplate.

Class Definition

Kotlin

class SmallImageUI(
    private val template: SmallImageTemplate,
    state: SmallImageCardUIState
) : AepUI<SmallImageTemplate, SmallImageCardUIState>
Copied to your clipboard
class SmallImageUI(
    private val template: SmallImageTemplate,
    state: SmallImageCardUIState
) : AepUI<SmallImageTemplate, SmallImageCardUIState>