mosaic-core/dev.catbit.mosaic.core.data.schemas.event.events.networking/DownloadFileEventSchema

DownloadFileEventSchema

@Serializable

@SerialName(value = "DownloadFile")

data class DownloadFileEventSchema(val id: String, val trigger: EventTrigger, val events: SerializableImmutableList<EventSchema>?, val url: String, val method: HttpMethod, val body: AnySerializable?, val headers: Map<String, String>?, val targetFileName: String, val mimeType: String?) : EventSchema

Downloads url and hands the result to the platform's own download destination — the user's Downloads folder or equivalent — under targetFileName, with mimeType describing the content. method, headers and body shape the request.

incomingData consumed: not used.

Triggers fired:

OnStartEventTrigger — before the download begins.
OnDownloadProgressEventTrigger — repeatedly while downloading, with the progress passed as incomingData.
OnDownloadFinishEventTrigger then OnSuccessEventTrigger — when the download completed, both carrying targetFileName as incomingData.
OnDownloadFailureEventTrigger then OnFailureEventTrigger — when the download failed, both carrying the Throwable; the error is logged.
OnCancelledEventTrigger — when the user cancels the download. No data is passed downstream, and neither the download-failure nor the failure trigger fires in that case.

Constructors

DownloadFileEventSchema

constructor(id: String, trigger: EventTrigger, events: SerializableImmutableList<EventSchema>?, url: String, method: HttpMethod, body: AnySerializable?, headers: Map<String, String>?, targetFileName: String, mimeType: String?)

Properties

body

@SerialName(value = "body")

val body: AnySerializable?

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.

headers

@SerialName(value = "headers")

val headers: Map<String, 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.

method

@SerialName(value = "method")

val method: HttpMethod

mimeType

@SerialName(value = "mimeType")

val mimeType: String?

targetFileName

@SerialName(value = "targetFileName")

val targetFileName: String

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.

url

@SerialName(value = "url")

val url: String