mosaic-client/dev.catbit.mosaic.client.platform/Platform

Platform

actual object Platform

Read-only snapshot of platform/device information, resolved once per platform target (expect/actual). Every field here is sent as an x-mosaic-* header (x-mosaic-platform-name, x-mosaic-device, etc.) on every outgoing HTTP request, via MosaicHeadersPlugin — so a backend can branch on client platform/device/locale/theme without the DSL author having to declare that data explicitly on each request. It's a plain object, not Koin-injected, so a custom EventRunner/TileRenderer can also read it directly for its own purposes.

expect object Platform

Read-only snapshot of platform/device information, resolved once per platform target (expect/actual). Every field here is sent as an x-mosaic-* header (x-mosaic-platform-name, x-mosaic-device, etc.) on every outgoing HTTP request, via MosaicHeadersPlugin — so a backend can branch on client platform/device/locale/theme without the DSL author having to declare that data explicitly on each request. It's a plain object, not Koin-injected, so a custom EventRunner/TileRenderer can also read it directly for its own purposes.

actual object Platform

Read-only snapshot of platform/device information, resolved once per platform target (expect/actual). Every field here is sent as an x-mosaic-* header (x-mosaic-platform-name, x-mosaic-device, etc.) on every outgoing HTTP request, via MosaicHeadersPlugin — so a backend can branch on client platform/device/locale/theme without the DSL author having to declare that data explicitly on each request. It's a plain object, not Koin-injected, so a custom EventRunner/TileRenderer can also read it directly for its own purposes.

actual object Platform

Read-only snapshot of platform/device information, resolved once per platform target (expect/actual). Every field here is sent as an x-mosaic-* header (x-mosaic-platform-name, x-mosaic-device, etc.) on every outgoing HTTP request, via MosaicHeadersPlugin — so a backend can branch on client platform/device/locale/theme without the DSL author having to declare that data explicitly on each request. It's a plain object, not Koin-injected, so a custom EventRunner/TileRenderer can also read it directly for its own purposes.

actual object Platform

Read-only snapshot of platform/device information, resolved once per platform target (expect/actual). Every field here is sent as an x-mosaic-* header (x-mosaic-platform-name, x-mosaic-device, etc.) on every outgoing HTTP request, via MosaicHeadersPlugin — so a backend can branch on client platform/device/locale/theme without the DSL author having to declare that data explicitly on each request. It's a plain object, not Koin-injected, so a custom EventRunner/TileRenderer can also read it directly for its own purposes.

Properties

Link copied to clipboard
actual val darkMode: String

Whether dark mode is currently active, as the string "true"/"false".

expect val darkMode: String

Whether dark mode is currently active, as the string "true"/"false".

actual val darkMode: String

Whether dark mode is currently active, as the string "true"/"false".

actual val darkMode: String

Whether dark mode is currently active, as the string "true"/"false".

actual val darkMode: String

Whether dark mode is currently active, as the string "true"/"false".

Link copied to clipboard
actual val device: String

Device model identifier — platform-specific format.

expect val device: String

Device model identifier — platform-specific format.

actual val device: String

Device model identifier — platform-specific format.

actual val device: String

Device model identifier — platform-specific format.

actual val device: String

Device model identifier — platform-specific format.

Link copied to clipboard
actual val extraInfo: Map<String, String>

Extra platform-specific key-value pairs not covered by the other properties.

expect val extraInfo: Map<String, String>

Extra platform-specific key-value pairs not covered by the other properties.

actual val extraInfo: Map<String, String>

Extra platform-specific key-value pairs not covered by the other properties.

actual val extraInfo: Map<String, String>

Extra platform-specific key-value pairs not covered by the other properties.

actual val extraInfo: Map<String, String>

Extra platform-specific key-value pairs not covered by the other properties.

Link copied to clipboard
actual val locale: String

Current locale, e.g. "pt-BR".

expect val locale: String

Current locale, e.g. "pt-BR".

actual val locale: String

Current locale, e.g. "pt-BR".

actual val locale: String

Current locale, e.g. "pt-BR".

actual val locale: String

Current locale, e.g. "pt-BR".

Link copied to clipboard
actual val name: String

The platform name, e.g. "Android", "iOS", "JVM", "WasmJS".

expect val name: String

The platform name, e.g. "Android", "iOS", "JVM", "WasmJS".

actual val name: String

The platform name, e.g. "Android", "iOS", "JVM", "WasmJS".

actual val name: String

The platform name, e.g. "Android", "iOS", "JVM", "WasmJS".

actual val name: String

The platform name, e.g. "Android", "iOS", "JVM", "WasmJS".

Link copied to clipboard
actual val osVersion: String

Operating system version string.

expect val osVersion: String

Operating system version string.

actual val osVersion: String

Operating system version string.

actual val osVersion: String

Operating system version string.

actual val osVersion: String

Operating system version string.

Link copied to clipboard
actual val screenDensity: String

Screen density as a decimal string, e.g. "1.0".

expect val screenDensity: String

Screen density as a decimal string, e.g. "1.0".

actual val screenDensity: String

Screen density as a decimal string, e.g. "1.0".

actual val screenDensity: String

Screen density as a decimal string, e.g. "1.0".

actual val screenDensity: String

Screen density as a decimal string, e.g. "1.0".

Link copied to clipboard
actual val screenSize: String

Screen size as "WIDTHxHEIGHT", e.g. "1920x1080".

expect val screenSize: String

Screen size as "WIDTHxHEIGHT", e.g. "1920x1080".

actual val screenSize: String

Screen size as "WIDTHxHEIGHT", e.g. "1920x1080".

actual val screenSize: String

Screen size as "WIDTHxHEIGHT", e.g. "1920x1080".

actual val screenSize: String

Screen size as "WIDTHxHEIGHT", e.g. "1920x1080".

Link copied to clipboard
actual val timezone: String

Current timezone as "offset|timezoneId", e.g. "GMT+09:30|Australia/Darwin".

expect val timezone: String

Current timezone as "offset|timezoneId", e.g. "GMT+09:30|Australia/Darwin".

actual val timezone: String

Current timezone as "offset|timezoneId", e.g. "GMT+09:30|Australia/Darwin".

actual val timezone: String

Current timezone as "offset|timezoneId", e.g. "GMT+09:30|Australia/Darwin".

actual val timezone: String

Current timezone as "offset|timezoneId", e.g. "GMT+09:30|Australia/Darwin".

Generated by Dokka
© 2026 Copyright