RunCancellableEventsEventSchema

@Serializable
@SerialName(value = "RunCancellableEvents")
data class RunCancellableEventsEventSchema(val id: String, val trigger: EventTrigger, val events: SerializableImmutableList<EventSchema>?, val cancellableEventId: String) : EventSchema

Runs this event's own events list inside a cancellable job registered in the client's CancellableEventsHolder under cancellableEventId. A later CancelEvents carrying the same id stops the job mid-flight.

Unlike most events, events here is the payload to execute: the whole list is run inline, in order, receiving this event's incomingData. The job is launched in its own coroutine scope, so this event returns as soon as the job is registered rather than waiting for the events to finish.

incomingData consumed: forwarded to the events being run.

Triggers fired:

  • OnSuccessEventTrigger — as soon as the job was registered, not when the events finish. No data is passed downstream.

  • OnFailureEventTrigger — when events is null, so there is nothing to run.

Constructors

Link copied to clipboard
constructor(id: String, trigger: EventTrigger, events: SerializableImmutableList<EventSchema>?, cancellableEventId: String)

Properties

Link copied to clipboard
@SerialName(value = "cancellableEventId")
val cancellableEventId: String
Link copied to clipboard
@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.

Link copied to clipboard
@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.

Link copied to clipboard
@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.