mosaic-core/dev.catbit.mosaic.core.data.schemas.event.events.overlays.snackbar/DisplaySnackbarEventSchema

DisplaySnackbarEventSchema

@Serializable

@SerialName(value = "DisplaySnackbar")

data class DisplaySnackbarEventSchema(val id: String, val trigger: EventTrigger, val events: SerializableImmutableList<EventSchema>?, val message: String, val duration: DisplaySnackbarEventSchema.SnackbarDuration = SnackbarDuration.Short, val actionLabel: String? = null) : EventSchema

Shows a snackbar with message, by broadcasting a display command on the screen channel. duration maps onto Material's Short, Long and Indefinite, and actionLabel adds an action button when non-null.

incomingData consumed: not used.

Triggers fired:

OnSuccessEventTrigger — right after the command was broadcast, before the snackbar has resolved. The broadcast is fire-and-forget, so this fires regardless of what the snackbar does next. No data is passed downstream.
OnSnackbarActionEventTrigger — later, when the user presses the action button. No data is passed downstream.
OnSnackbarDismissedEventTrigger — later, when the snackbar goes away without its action being pressed. No data is passed downstream.

Constructors

DisplaySnackbarEventSchema

constructor(id: String, trigger: EventTrigger, events: SerializableImmutableList<EventSchema>?, message: String, duration: DisplaySnackbarEventSchema.SnackbarDuration = SnackbarDuration.Short, actionLabel: String? = null)

Types

SnackbarDuration

@Serializable

enum SnackbarDuration : Enum<DisplaySnackbarEventSchema.SnackbarDuration>

Properties

actionLabel

val actionLabel: String?

duration

val duration: DisplaySnackbarEventSchema.SnackbarDuration

events

@SerialName(value = "events")

open override val events: SerializableImmutableList<EventSchema>?

This event's own children — each declaring, via its own trigger, which of this event's outgoing triggers runs it. null when this event declares no children.

@SerialName(value = "id")

open override val id: String

Unique identifier — how TriggerEvent/UpdateEvents address this event by id. Defaults to a random id when omitted from the DSL.

message

val message: String

trigger

@SerialName(value = "trigger")

open override val trigger: EventTrigger

The condition that must occur for this event to run — matched by structural equality (data class/data object equality) against whatever trigger value fired, never by any kind of subscription or listener registry.