InboxEvent

Represents different types of inbox-level events triggered by lifecycle changes or user interactions with the inbox container. All inbox events include the current InboxUIState when the event occurred.

InboxEvent represents events on the inbox as a whole, as opposed to UIEvent which represents events on individual cards (display, dismiss, interact).

Class Definition

data-slots=heading, code
data-repeat=1
data-languages=Kotlin

Kotlin

sealed class InboxEvent(open val inboxUIState: InboxUIState)

Display

Event indicating that the inbox has been displayed to the user.

data-slots=heading, code
data-repeat=1
data-languages=Kotlin

Kotlin

data class Display(override val inboxUIState: InboxUIState.Success) : InboxEvent(inboxUIState)

Properties

Property
Type
Description
inboxUIState
InboxUIState.Success
The success state of the inbox UI when the display event occurred.