A2uiDynamicStringSchema

class A2uiDynamicStringSchema : A2uiCompositeSchema

kotlin.Any
   ↳ androidx.a2ui.model.schema.A2uiSchema
     ↳ androidx.a2ui.model.schema.A2uiCompositeSchema
       ↳ androidx.a2ui.model.schema.commontypes.A2uiDynamicStringSchema

Represents string values from literals, data bindings, or function calls.

Summary

Public companion properties
A2uiDynamicStringSchema

Public constructors

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

Returns the underlying schema definition.
open Int
open String

Public properties
open String

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

semantic description of the schema
open String

Root schema ID used to reference this sub-schema.

Inherited functions
From androidx.a2ui.model.schema.A2uiCompositeSchema
open JsonElement

Serializes this schema to a JSON Schema string representation.
From androidx.a2ui.model.schema.A2uiSchema
String

Serializes this schema to a JSON Schema string representation.

Inherited properties
From androidx.a2ui.model.schema.A2uiCompositeSchema
open List<A2uiSchemaKeyword<Any>>

List of JSON Schema keywords applied to this schema node.

Public companion properties

DEFAULT_INSTANCE

val DEFAULT_INSTANCE: A2uiDynamicStringSchema

Public constructors

A2uiDynamicStringSchema

Added in 1.0.0-alpha01
A2uiDynamicStringSchema(description: String? = null)

Public functions

equals

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

getDefinition

open 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

toString

open fun toString(): String

Public properties

definitionName

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.

description

open val description: String?

semantic description of the schema

schemaId

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.