mosaic-core/dev.catbit.mosaic.core.data.schemas.event.events.data/SendDataEventSchema

SendDataEventSchema

@Serializable

@SerialName(value = "SendData")

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

Posts a value into the client's DataMailer under dataKey, where a later CheckForReceivedData can pick it up. The mailer is a one-shot channel, so this is the way to hand a value to another screen.

The value sent is data when it is non-null, otherwise the event's incomingData.

incomingData consumed: used as the value to send whenever data is null.

Triggers fired:

OnSuccessEventTrigger — after the value was posted. No data is passed downstream.
OnFailureEventTrigger — when both data and incomingData are null, so there is nothing to send; the error is logged and no data is passed.

Constructors

SendDataEventSchema

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

Properties

data

@SerialName(value = "data")

val data: AnySerializable?

dataKey

@SerialName(value = "dataKey")

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

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.