mosaic-client/dev.catbit.mosaic.client.ui.sdui.implementations.tile.tiles.internal.screen/ScreenTileSchema

ScreenTileSchema

@Serializable

data class ScreenTileSchema(val id: String, val tiles: SerializableImmutableList<TileSchema>, val events: SerializableImmutableList<EventSchema>?, val style: StyleSchema = StyleSchema.default(), val searchableTerms: SerializableImmutableList<String>? = null, val visibility: TileSchema.Visibility = TileSchema.Visibility.VISIBLE, val navigationDrawerTiles: SerializableImmutableList<TileSchema>?, val state: ScreenTileSchema.State, val stackableOverlays: SerializableImmutableMap<String, ScreenTileSchema.StackableOverlay> = persistentMapOf()) : TileSchema

Constructors

ScreenTileSchema

constructor(id: String, tiles: SerializableImmutableList<TileSchema>, events: SerializableImmutableList<EventSchema>?, style: StyleSchema = StyleSchema.default(), searchableTerms: SerializableImmutableList<String>? = null, visibility: TileSchema.Visibility = TileSchema.Visibility.VISIBLE, navigationDrawerTiles: SerializableImmutableList<TileSchema>?, state: ScreenTileSchema.State, stackableOverlays: SerializableImmutableMap<String, ScreenTileSchema.StackableOverlay> = persistentMapOf())

Types

StackableOverlay

@Serializable

sealed interface StackableOverlay

enum State : Enum<ScreenTileSchema.State>

Properties

@SerialName(value = "events")

open override val events: SerializableImmutableList<EventSchema>?

@SerialName(value = "id")

open override val id: String

navigationDrawerTiles

@SerialName(value = "navigationDrawerTiles")

val navigationDrawerTiles: SerializableImmutableList<TileSchema>?

searchableTerms

@SerialName(value = "searchableTerms")

open override val searchableTerms: SerializableImmutableList<String>?

stackableOverlays

@SerialName(value = "stackableOverlays")

val stackableOverlays: SerializableImmutableMap<String, ScreenTileSchema.StackableOverlay>

@SerialName(value = "state")

val state: ScreenTileSchema.State

@SerialName(value = "style")

open override val style: StyleSchema

@SerialName(value = "tiles")

val tiles: SerializableImmutableList<TileSchema>

@SerialName(value = "visibility")

open override val visibility: TileSchema.Visibility

Functions

open fun isGone(): Boolean

open fun isVisible(): Boolean

observeScreenTileBroadcastChannel

inline fun <T : ScreenTilesBroadcastData> TileSchema.observeScreenTileBroadcastChannel(filterByTileId: Boolean = true, crossinline action: suspend (value: T) -> Unit)

Subscribes this tile to its screen's own broadcast channel (reached via LocalScreenTilesBroadcastChannel), running action for every emitted ScreenTilesBroadcastData of type T — the composable-side counterpart of EventRunningScope.broadcastData, and the mechanism a tile's own renderer uses to react to a screen-scoped command addressed to it (scroll commands, overlay open/close, etc.).