A2uiCreateSurfaceMessage

class A2uiCreateSurfaceMessage : A2uiServerToClientMessage

Creates a new surface instance on the client.

Summary

Public constructors
A2uiCreateSurfaceMessage(
    surfaceId: String,
    catalogId: String,
    theme: Map<String, Any?>,
    shouldSendDataModel: Boolean
)

Public functions
open operator Boolean
equals(other: Any?)
open Int
open String

Public properties
String

The ID of the component catalog to use for this surface.
Boolean

If true, the client will append its active UI data model state tree as metadata to subsequent outgoing messages.
open String

The unique ID to assign to the new surface.
Map<String, Any?>

An optional map of theme-specific property overrides (e.g., colors, spacing).

Public constructors

A2uiCreateSurfaceMessage

A2uiCreateSurfaceMessage(
    surfaceId: String,
    catalogId: String,
    theme: Map<String, Any?> = emptyMap(),
    shouldSendDataModel: Boolean = false
)

Public functions

equals

open operator fun equals(other: Any?): Boolean

hashCode

open fun hashCode(): Int

toString

open fun toString(): String

Public properties

catalogId

Added in 1.0.0-alpha01
val catalogId: String

The ID of the component catalog to use for this surface.

shouldSendDataModel

Added in 1.0.0-alpha01
val shouldSendDataModel: Boolean

If true, the client will append its active UI data model state tree as metadata to subsequent outgoing messages. Defaults to false.

surfaceId

open val surfaceId: String

The unique ID to assign to the new surface.

theme

Added in 1.0.0-alpha01
val theme: Map<String, Any?>

An optional map of theme-specific property overrides (e.g., colors, spacing).