mosaic-core/dev.catbit.mosaic.core.data.schemas.event.events.overlays.dialog/DisplayDialogEventSchema

DisplayDialogEventSchema

@Serializable

@SerialName(value = "DisplayDialog")

data class DisplayDialogEventSchema(val id: String, val trigger: EventTrigger, val events: SerializableImmutableList<EventSchema>?, val dialogId: String, val tiles: SerializableImmutableList<TileSchema>, val isCancellable: Boolean, val usePlatformDefaultWidth: Boolean) : EventSchema

Shows a dialog built from tiles, registered under dialogId so a later DismissDialog can close it.

isCancellable decides whether the user can dismiss it with the back gesture or a scrim tap, and usePlatformDefaultWidth whether the dialog keeps the platform's default width or is free to size itself from its content.

incomingData consumed: not used.

Triggers fired:

OnSuccessEventTrigger — when the dialog was added. No data is passed downstream.
OnFailureEventTrigger — when it could not be added, typically because dialogId is already in use; the Throwable is passed as incomingData.
OnDisplayEventTrigger — once, when the dialog actually enters composition on screen.

Constructors

DisplayDialogEventSchema

constructor(id: String, trigger: EventTrigger, events: SerializableImmutableList<EventSchema>?, dialogId: String, tiles: SerializableImmutableList<TileSchema>, isCancellable: Boolean, usePlatformDefaultWidth: Boolean)

Properties

dialogId

@SerialName(value = "dialogId")

val dialogId: String

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.

isCancellable

@SerialName(value = "isCancellable")

val isCancellable: Boolean

tiles

@SerialName(value = "tiles")

val tiles: SerializableImmutableList<TileSchema>

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.

usePlatformDefaultWidth

@SerialName(value = "usePlatformDefaultWidth")

val usePlatformDefaultWidth: Boolean