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

RemoveDataEventSchema

@Serializable

@SerialName(value = "RemoveData")

data class RemoveDataEventSchema(val id: String, val trigger: EventTrigger, val events: SerializableImmutableList<EventSchema>?, val deletions: SerializableImmutableList<RemoveDataEventSchema.Deletion>) : EventSchema

Deletes values from data sources. Runs on the IO dispatcher.

Each Deletion pairs a data source with an access mode: Single removes one id, Batch removes a list of ids, and Full wipes the source. Supported sources are the application and screen data holders (plain and segmented) and the plain and segmented local databases. Deletions targeting navigation data, a tile or an inline source are silently ignored.

All deletions are attempted; a failure in one does not stop the others.

incomingData consumed: not used.

Triggers fired:

OnSuccessEventTrigger — when every deletion completed without error. No data is passed downstream.
OnFailureEventTrigger — when at least one database deletion failed. Fired once at the end, after all deletions were attempted, with no data attached.

Constructors

RemoveDataEventSchema

constructor(id: String, trigger: EventTrigger, events: SerializableImmutableList<EventSchema>?, deletions: SerializableImmutableList<RemoveDataEventSchema.Deletion>)

Types

Deletion

@Serializable

data class Deletion(val dataSource: DataSourceSchema, val accessMode: AccessModeSchema)

Properties

deletions

@SerialName(value = "deletions")

val deletions: SerializableImmutableList<RemoveDataEventSchema.Deletion>

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.