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

SaveFileEventSchema

@Serializable

@SerialName(value = "SaveFile")

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

Writes the event's incomingData to fileName in the client's own file storage.

When overrideIfExists is false the runner first reads fileName and refuses to write if something is already there.

incomingData consumed: required, and must be a ByteArray — it is the content written.

Triggers fired:

OnSuccessEventTrigger — when the file was written. No data is passed downstream.
OnFailureEventTrigger — when incomingData is missing or is not a ByteArray (an IllegalArgumentException is passed), when overrideIfExists is false and the file already exists (an IllegalStateException is passed), or when the write itself failed (the Throwable is passed). Every case is logged.

Constructors

SaveFileEventSchema

constructor(id: String, trigger: EventTrigger, events: SerializableImmutableList<EventSchema>?, fileName: String, overrideIfExists: Boolean)

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.

overrideIfExists

@SerialName(value = "overrideIfExists")

val overrideIfExists: Boolean

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.