mosaic-core/dev.catbit.mosaic.core.data.schemas.event.events.file/DeleteFilesEventSchema

DeleteFilesEventSchema

@Serializable

@SerialName(value = "DeleteFiles")

data class DeleteFilesEventSchema(val id: String, val trigger: EventTrigger, val events: SerializableImmutableList<EventSchema>?, val target: DeleteFilesEventSchema.DeleteTarget) : EventSchema

Deletes the file or files selected by target from the client's own file storage. With a DeleteTarget.Multiple every file is attempted, even after one fails.

incomingData consumed: not used.

Triggers fired:

OnSuccessEventTrigger — when every deletion completed. No data is passed downstream.
OnFailureEventTrigger — when at least one deletion failed, fired once after all were attempted; the first Throwable is passed as incomingData and every error is logged.

Constructors

DeleteFilesEventSchema

constructor(id: String, trigger: EventTrigger, events: SerializableImmutableList<EventSchema>?, target: DeleteFilesEventSchema.DeleteTarget)

Types

DeleteTarget

@Serializable

sealed interface DeleteTarget

Which file or files DeleteFilesEventSchema deletes.

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.

target

@SerialName(value = "target")

val target: DeleteFilesEventSchema.DeleteTarget

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.