mosaic-core/dev.catbit.mosaic.core.data.schemas.event.events.menu/ToggleMenuEventSchema

ToggleMenuEventSchema

@Serializable

@SerialName(value = "ToggleMenu")

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

Flips the open/closed state of the Menu tile identified by menuId, by dispatching a MenuTileEvents.OnToggleMenu to it. Since the tile itself only closes on dismissal, this is how a menu is opened from the server side — and, wired onto a menu item's click, how it is closed after acting on the selection.

incomingData consumed: not used.

Triggers fired:

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

Constructors

ToggleMenuEventSchema

constructor(id: String, trigger: EventTrigger, events: SerializableImmutableList<EventSchema>?, menuId: 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.

menuId

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