ContentCardUIEventListener

Interface to handle different callback events which can occur for a displayed content card.

Interface Definition

Kotlin

interface ContentCardUIEventListener {
    fun onDisplay(aepUI: AepUI<*, *>,)
    fun onDismiss(aepUI: AepUI<*, *>,)
    fun onInteract(aepUI: AepUI<*, *>, interactionId: String?, actionUrl: String?): Boolean
}
Copied to your clipboard
interface ContentCardUIEventListener {
    fun onDisplay(aepUI: AepUI<*, *>,)
    fun onDismiss(aepUI: AepUI<*, *>,)
    fun onInteract(aepUI: AepUI<*, *>, interactionId: String?, actionUrl: String?): Boolean
}

Methods

onDisplay

Callback to invoke when a content card is displayed.

Parameters

aepUI - The AepUI instance that was displayed.

Syntax

Kotlin

fun onDisplay(aepUI: AepUI<*, *>,)
Copied to your clipboard
fun onDisplay(aepUI: AepUI<*, *>,)

onDismiss

Callback to invoke when a content card is dismissed.

Parameters

aepUI - The AepUI instance that was dismissed.

Syntax

Kotlin

fun onDismiss(aepUI: AepUI<*, *>,)
Copied to your clipboard
fun onDismiss(aepUI: AepUI<*, *>,)

onInteract

Callback to invoke when a content card is interacted with.

Parameters

aepUI - The AepUI instance that was interacted with.
interactionId - An optional string identifier for the interaction event.
actionUrl - An optional URL associated with the interaction.

Returns

A boolean value indicating whether the interaction event was handled. Returns true if the client app has handled the actionUrl associated with the interaction. Returns false if the SDK should handle the actionUrl.

Syntax

Kotlin

fun onInteract(aepUI: AepUI<*, *>, interactionId: String?, actionUrl: String?): Boolean
Copied to your clipboard
fun onInteract(aepUI: AepUI<*, *>, interactionId: String?, actionUrl: String?): Boolean