A2uiCompositeSchema

abstract class A2uiCompositeSchema : A2uiSchema

kotlin.Any
   ↳ androidx.a2ui.model.schema.A2uiSchema
     ↳ androidx.a2ui.model.schema.A2uiCompositeSchema
Known direct subclasses
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.

Schema node that is defined by using other schema nodes.

Subclasses of this abstract class define a schema using A2uiSchema components returned by getDefinition. Supports reusable definitions in the $defs section of the generated JSON Schema when definitionName is specified.

Summary

Public constructors

Public functions
open operator Boolean
equals(other: Any?)
abstract A2uiSchema

Returns the underlying schema definition.
open Int
open JsonElement

Serializes this schema to a JSON Schema string representation.

Public properties
open String?

Name of this schema within the $defs section of the generated JSON Schema.
open List<A2uiSchemaKeyword<Any>>

List of JSON Schema keywords applied to this schema node.
open String?

Root schema ID used to reference this sub-schema.

Inherited functions
From androidx.a2ui.model.schema.A2uiSchema
String

Serializes this schema to a JSON Schema string representation.

Inherited properties
From androidx.a2ui.model.schema.A2uiSchema
abstract String?

Semantic description of the schema.

Public constructors

A2uiCompositeSchema

Added in 1.0.0-alpha01
A2uiCompositeSchema()

Public functions

equals

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

getDefinition

Added in 1.0.0-alpha01
abstract fun getDefinition(): A2uiSchema

Returns the underlying schema definition.

Concrete subclasses must implement this to return the actual schema details that this schema wraps.

Returns
A2uiSchema

the underlying schema definition

hashCode

open fun hashCode(): Int

toJsonElement

Added in 1.0.0-alpha01
open fun toJsonElement(): JsonElement

Serializes this schema to a JSON Schema string representation.

If definitionName is non-null, this generates a $ref schema pointing to the definition instead of the full schema. Otherwise, it delegates to getDefinitionJsonSchema.

Returns
JsonElement

the serialized JSON Schema string

Public properties

definitionName

Added in 1.0.0-alpha01
open val definitionName: String?

Name of this schema within the $defs section of the generated JSON Schema.

If non-null, nested references to this schema will generate a $ref pointing to this definition name instead of inlining the full schema. Use this to avoid duplicating complex schemas in components.

keywords

open val keywords: List<A2uiSchemaKeyword<Any>>

List of JSON Schema keywords applied to this schema node.

schemaId

Added in 1.0.0-alpha01
open val schemaId: String?

Root schema ID used to reference this sub-schema.

Non-null values prepend this ID to the $ref path when serializing this schema.

  • Format when non-null: "$schemaId#/$defs/$definitionName"

  • Format when null: "#/$defs/$definitionName"

Note: This has no effect if definitionName is null.