mosaic-core/dev.catbit.mosaic.core.data.schemas.event.events.system/BroadcastToSystemEventSchema

BroadcastToSystemEventSchema

@Serializable

@SerialName(value = "BroadcastToSystem")

data class BroadcastToSystemEventSchema(val id: String, val trigger: EventTrigger, val events: SerializableImmutableList<EventSchema>?, val broadcastId: String, val data: BroadcastToSystemEventSchema.BroadcastData) : EventSchema

Publishes a value on the client's system broadcast channel under broadcastId, where the host application and any mounted SystemBroadcastListener tile can pick it up. This is the outbound half of the bridge between server-declared flows and native app code.

data chooses the payload: Inline publishes a literal declared on the event, Incoming publishes the event's incomingData.

incomingData consumed: published as the payload when data is Incoming.

Triggers fired:

OnSuccessEventTrigger — after the value was published. No data is passed downstream.
OnFailureEventTrigger — only in the Incoming case, when incomingData is null so there is nothing to publish; no data is passed downstream.

Constructors

BroadcastToSystemEventSchema

constructor(id: String, trigger: EventTrigger, events: SerializableImmutableList<EventSchema>?, broadcastId: String, data: BroadcastToSystemEventSchema.BroadcastData)

Types

BroadcastData

@Serializable

sealed interface BroadcastData

Properties

broadcastId

@SerialName(value = "broadcastId")

val broadcastId: String

data

@SerialName(value = "data")

val data: BroadcastToSystemEventSchema.BroadcastData

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.

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