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

CheckForReceivedDataEventSchema

@Serializable

@SerialName(value = "CheckForReceivedData")

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

Reads a one-shot value from the client's DataMailer under dataKey and branches on whether it was there.

incomingData consumed: not used.

Triggers fired:

OnDataReceivedEventTrigger — when a value exists for dataKey; the value is passed as incomingData.
OnSuccessEventTrigger — right after the trigger above, with the same value as incomingData.
OnFailureEventTrigger — when no value exists for dataKey; no incomingData is passed.

Constructors

CheckForReceivedDataEventSchema

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

Properties

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.