ContentCardUIEventListening

A protocol that defines methods for listening to UI events related to content cards.

Protocol Definition

data-slots=heading, code

data-repeat=1

public protocol ContentCardUIEventListening {
    func onDisplay(_ card: ContentCardUI)
    func onDismiss(_ card: ContentCardUI)
    func onInteract(_ card: ContentCardUI, _ interactionId: String, actionURL: URL?) -> Bool
}

Methods

onDisplay

Called when the content card appears on the screen. Implementation of this method is optional.

Parameters

• card - The ContentCardUI that is displayed.

Syntax

data-slots=heading, code

data-repeat=1

func onDisplay(_ card: ContentCardUI)

onDismiss

Called when the content card is dismissed. Implementation of this method is optional.

Parameters

• card - The ContentCardUI that is dismissed.

Syntax

data-slots=heading, code

data-repeat=1

func onDismiss(_ card: ContentCardUI)

onInteract

Called when the user interacts with the content card. Implementation of this method is optional.

Parameters

• card - The ContentCardUI that is interacted with.
• interactionId - A string identifier for the interaction event.
• actionURL - The optional URL associated with the interaction.

Returns

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

Syntax

data-slots=heading, code

data-repeat=1

func onInteract(_ card: ContentCardUI, _ interactionId: String, actionURL: URL?) -> Bool