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

DismissSnackbarEventSchema

@Serializable

@SerialName(value = "DismissSnackbar")

data class DismissSnackbarEventSchema(val id: String, val trigger: EventTrigger, val events: SerializableImmutableList<EventSchema>?) : EventSchema

Hides the snackbar currently showing on the screen, by broadcasting a dismiss command on the screen channel.

incomingData consumed: not used.

Triggers fired:

OnSuccessEventTrigger — always, right after the command was broadcast. The broadcast is fire-and-forget, so this fires even when no snackbar is showing. No data is passed downstream.

Constructors

DismissSnackbarEventSchema

constructor(id: String, trigger: EventTrigger, events: SerializableImmutableList<EventSchema>?)

Properties

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.

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.