Package-level declarations

Types

Link copied to clipboard
@Serializable
@SerialName(value = "CheckForReceivedData")
data class CheckForReceivedDataEventSchema(val id: String, val trigger: EventTrigger, val events: SerializableImmutableList<EventSchema>?, val dataKey: String) : EventSchema

Reads a one-shot value from the client's DataMailer under dataKey and branches on whether it was there.

Link copied to clipboard
@Serializable
@SerialName(value = "EvaluateData")
data class EvaluateDataEventSchema(val id: String, val trigger: EventTrigger, val events: SerializableImmutableList<EventSchema>?, val expression: EvaluateDataEventSchema.Expression) : EventSchema

Evaluates the boolean expression and branches on its result. Runs on the IO dispatcher.

Link copied to clipboard
@Serializable
@SerialName(value = "GetData")
data class GetDataEventSchema(val id: String, val trigger: EventTrigger, val events: SerializableImmutableList<EventSchema>?, val readings: SerializableImmutableList<GetDataEventSchema.Reading>) : EventSchema

Reads one or more values from data sources and emits them downstream. Runs on the IO dispatcher.

Link copied to clipboard
@Serializable
@SerialName(value = "ProcessData")
data class ProcessDataEventSchema(val id: String, val trigger: EventTrigger, val events: SerializableImmutableList<EventSchema>?, val processWith: String) : EventSchema

Hands the event's incomingData to the DataProcessor registered by the client under the id processWith. Processors are supplied by the host application, so what the processing does is opaque to the framework.

Link copied to clipboard
@Serializable
@SerialName(value = "RemoveData")
data class RemoveDataEventSchema(val id: String, val trigger: EventTrigger, val events: SerializableImmutableList<EventSchema>?, val deletions: SerializableImmutableList<RemoveDataEventSchema.Deletion>) : EventSchema

Deletes values from data sources. Runs on the IO dispatcher.

Link copied to clipboard
@Serializable
@SerialName(value = "SendData")
data class SendDataEventSchema(val id: String, val trigger: EventTrigger, val events: SerializableImmutableList<EventSchema>?, val dataKey: String, val data: AnySerializable?) : EventSchema

Posts a value into the client's DataMailer under dataKey, where a later CheckForReceivedData can pick it up. The mailer is a one-shot channel, so this is the way to hand a value to another screen.

Link copied to clipboard
@Serializable
@SerialName(value = "TransformData")
data class TransformDataEventSchema(val id: String, val trigger: EventTrigger, val events: SerializableImmutableList<EventSchema>?, val template: AnySerializable) : EventSchema

Reshapes the event's incomingData into a new value by applying template through the client's TemplateProcessor, letting a payload be rewritten mid-chain without a round trip.

Link copied to clipboard
@Serializable
@SerialName(value = "UpdateData")
data class UpdateDataEventSchema(val id: String, val trigger: EventTrigger, val events: SerializableImmutableList<EventSchema>?, val updates: SerializableImmutableList<UpdateDataEventSchema.Update>) : EventSchema

Writes values into data sources. Runs on the IO dispatcher.