Package-level declarations

Types

Link copied to clipboard
@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.

Link copied to clipboard
@Serializable
@SerialName(value = "DownloadFileToDisk")
data class DownloadFileToDiskEventSchema(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) : EventSchema

Downloads url into the client's own file storage under targetFileName, where GetFile and DeleteFile can reach it afterwards. method, headers and body shape the request.

Link copied to clipboard
@Serializable
@SerialName(value = "DownloadFileToMemory")
data class DownloadFileToMemoryEventSchema(val id: String, val trigger: EventTrigger, val events: SerializableImmutableList<EventSchema>?, val url: String, val method: HttpMethod, val body: AnySerializable?, val headers: Map<String, String>?) : EventSchema

Downloads url without touching the filesystem, keeping the content in memory. method, headers and body shape the request.

Link copied to clipboard
@Serializable
@SerialName(value = "SendNetworkRequest")
data class SendNetworkRequestEventSchema(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 timeoutMillis: Long? = null) : EventSchema

Sends an HTTP request to url with method, headers, body and an optional timeoutMillis, and emits the response downstream. This is the general-purpose way to talk to a backend from inside an event chain.

@Serializable
@SerialName(value = "SetIncomingDataToNetworkParamsHolderBody")
data class SetIncomingDataToNetworkParamsHolderBodyEventSchema(val id: String, val trigger: EventTrigger, val events: SerializableImmutableList<EventSchema>?) : EventSchema

Stores the event's incomingData as the request body in the client's NetworkParametersHolder, so a later request in the chain picks it up instead of carrying the body on its own schema.

@Serializable
@SerialName(value = "SetIncomingDataToNetworkParamsHolderHeaders")
data class SetIncomingDataToNetworkParamsHolderHeadersEventSchema(val id: String, val trigger: EventTrigger, val events: SerializableImmutableList<EventSchema>?) : EventSchema

Stores the event's incomingData as the request headers in the client's NetworkParametersHolder, so a later request in the chain picks them up instead of carrying the headers on its own schema.

@Serializable
@SerialName(value = "SetIncomingDataToNetworkParamsHolderQueryParameters")
data class SetIncomingDataToNetworkParamsHolderQueryParametersEventSchema(val id: String, val trigger: EventTrigger, val events: SerializableImmutableList<EventSchema>?) : EventSchema

Stores the event's incomingData as the query parameters in the client's NetworkParametersHolder, so a later request in the chain picks them up instead of carrying the parameters on its own schema.

@Serializable
@SerialName(value = "SetIncomingDataToNetworkParamsHolderUrl")
data class SetIncomingDataToNetworkParamsHolderUrlEventSchema(val id: String, val trigger: EventTrigger, val events: SerializableImmutableList<EventSchema>?) : EventSchema

Stores the event's incomingData as the URL in the client's NetworkParametersHolder, so a later request in the chain picks it up instead of carrying the URL on its own schema.

Link copied to clipboard
@Serializable
@SerialName(value = "UploadFile")
data class UploadFileEventSchema(val id: String, val trigger: EventTrigger, val events: SerializableImmutableList<EventSchema>?, val url: String?, val method: HttpMethod, val headers: Map<String, String>?, val contentType: String?) : EventSchema

Uploads the file carried in the event's incomingData to url with method, headers and contentType, reporting progress as it goes. Pair it with OpenFilePicker or GetFile using their PlatformFile output.