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

DeleteFileEventSchema

@Serializable

@SerialName(value = "DeleteFile")

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

Deletes the file stored under fileName in the client's own file storage.

incomingData consumed: not used.

Triggers fired:

OnSuccessEventTrigger — when the deletion completed. No data is passed downstream.
OnFailureEventTrigger — when the deletion failed; the Throwable is passed as incomingData and the error is logged.

Constructors

DeleteFileEventSchema

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

fileName

@SerialName(value = "fileName")

val fileName: String

@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.