A2uiSchema

Artifact: androidx.a2ui:a2ui-model

View Source

Added in 1.0.0-alpha01

---

Kotlin |Java

sealed class A2uiSchema

Known direct subclasses

A2uiAnySchema, A2uiArraySchema, A2uiBooleanSchema, A2uiCompositeSchema, A2uiNumberSchema, A2uiObjectSchema, A2uiRefSchema, A2uiStringSchema

A2uiAnySchema	Schema representing an unstructured JSON payload or a keyword-only schema.
A2uiArraySchema	Schema representing an array where all items conform to a specific schema.
A2uiBooleanSchema	Schema representing a boolean literal.
A2uiCompositeSchema	Schema node that is defined by using other schema nodes.
A2uiNumberSchema	Schema representing a number literal.
A2uiObjectSchema	Schema representing an object with nested properties.
A2uiRefSchema	Schema representing a reference to another schema definition.
A2uiStringSchema	Schema representing a string literal.

Known indirect subclasses

A2uiAccessibilityAttributesSchema, A2uiActionSchema, A2uiCheckRuleSchema, A2uiCheckableSchema, A2uiChildListSchema, A2uiComponentCommonSchema, A2uiComponentIdSchema, A2uiDataBindingSchema, A2uiDynamicBooleanSchema, A2uiDynamicNumberSchema, A2uiDynamicStringListSchema, A2uiDynamicStringSchema, A2uiDynamicValueSchema, A2uiFunctionCallSchema

A2uiAccessibilityAttributesSchema	Holds accessibility properties for assistive technologies.
A2uiActionSchema	Standard interactions that dispatch events or call client functions.
A2uiCheckRuleSchema	Validates input components.
A2uiCheckableSchema	Enables client-side check validations.
A2uiChildListSchema	Specifies child component identifiers.
A2uiComponentCommonSchema	Defines shared attributes for all components.
A2uiComponentIdSchema	Represents unique identifiers for components within a surface.
A2uiDataBindingSchema	Points to values within the data model.
A2uiDynamicBooleanSchema	Represents boolean values from literals, data bindings, or function calls.
A2uiDynamicNumberSchema	Represents number values from literals, data bindings, or function calls.
A2uiDynamicStringListSchema	Represents string lists from literals, data bindings, or function calls.
A2uiDynamicStringSchema	Represents string values from literals, data bindings, or function calls.
A2uiDynamicValueSchema	Represents values from literals, data bindings, or function calls.
A2uiFunctionCallSchema	Configures client function invocations.

---

Base node for all schema of A2UI based on JSON Schema.

Summary

Protected constructors
A2uiSchema()

Public functions
open operator Boolean	equals(other: Any?)
open Int	hashCode()
String	toJsonSchema() Serializes this schema to a JSON Schema string representation.

Public properties
abstract String?	description Semantic description of the schema.
open List<A2uiSchemaKeyword<Any>>	keywords List of JSON Schema keywords applied to this schema node.

Protected constructors

A2uiSchema

protected A2uiSchema()

Public functions

equals

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

hashCode

open fun hashCode(): Int

toJsonSchema

Added in 1.0.0-alpha01

fun toJsonSchema(): String

Serializes this schema to a JSON Schema string representation.

Returns
String	the serialized JSON Schema string

Public properties

description

Added in 1.0.0-alpha01

abstract val description: String?

Semantic description of the schema.

keywords

Added in 1.0.0-alpha01

open val keywords: List<A2uiSchemaKeyword<Any>>

List of JSON Schema keywords applied to this schema node.