mosaic-core/dev.catbit.mosaic.core.data.schemas.event.events.navigation/NavigateUpEventSchema

NavigateUpEventSchema

@Serializable

@SerialName(value = "NavigateUp")

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

Pops the back stack of the graph registered under navigatorId, going back one entry.

incomingData consumed: not used.

Triggers fired:

OnSuccessEventTrigger — when an entry was popped. No data is passed downstream.
OnFailureEventTrigger — when no navigator is registered under navigatorId, or there was nothing to pop; no data is passed and the error is logged.

Constructors

NavigateUpEventSchema

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

navigatorId

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