mosaic-core/dev.catbit.mosaic.core.data.schemas.event.events.popup/TogglePopupEventSchema

TogglePopupEventSchema

@Serializable

@SerialName(value = "TogglePopup")

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

Flips the open/closed state of the Popup tile identified by popupId, by dispatching a PopupTileEvents.OnTogglePopup to it. Since the tile itself only closes on dismissal, this is how a popup is opened from the server side.

incomingData consumed: not used.

Triggers fired:

OnSuccessEventTrigger — when the signal reached the tile. No data is passed downstream.
OnFailureEventTrigger — when no tile with popupId is currently mounted; the Throwable is passed as incomingData and the error is logged.

Constructors

TogglePopupEventSchema

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

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.

popupId

val popupId: 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.