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

ProcessDataEventSchema

@Serializable

@SerialName(value = "ProcessData")

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

Hands the event's incomingData to the DataProcessor registered by the client under the id processWith. Processors are supplied by the host application, so what the processing does is opaque to the framework.

incomingData consumed: required — it is the value passed to the processor.

Triggers fired:

OnSuccessEventTrigger — when the processor returns successfully. No data is passed downstream.
OnFailureEventTrigger — when the processor returns a failure (the Throwable is passed as incomingData), when no processor is registered under processWith, or when incomingData is null (no data passed in those two cases).

Constructors

ProcessDataEventSchema

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

processWith

@SerialName(value = "processWith")

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