A2uiArraySchema


class A2uiArraySchema : A2uiSchema


Schema representing an array where all items conform to a specific schema.

Summary

Public companion properties

A2uiArraySchema

Public constructors

A2uiArraySchema(
    items: A2uiSchema?,
    description: String?,
    minItems: Int,
    maxItems: Int,
    keywords: List<A2uiSchemaKeyword<List<Any>>>
)

Public functions

open operator Boolean
equals(other: Any?)
open Int
open JsonElement

Returns the JsonElement hierarchy representing this schema.

open String

Public properties

open String?

semantic description of the schema

A2uiSchema?

schema that every element in this array must conform to, or null if any schema is allowed.

open List<A2uiSchemaKeyword<List<Any>>>

JSON Schema keywords applied to this schema node

Int

maximum number of items allowed in the array (unconstrained if -1)

Int

minimum number of items required in the array (unconstrained if -1)

Inherited functions

From androidx.a2ui.model.schema.A2uiSchema
String

Serializes this schema to a JSON Schema string representation.

Public companion properties

INSTANCE

val INSTANCEA2uiArraySchema

Public constructors

A2uiArraySchema

A2uiArraySchema(
    items: A2uiSchema? = null,
    description: String? = null,
    minItems: Int = -1,
    maxItems: Int = -1,
    keywords: List<A2uiSchemaKeyword<List<Any>>> = emptyList()
)

Public functions

equals

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

hashCode

open fun hashCode(): Int

toJsonElement

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

Returns the JsonElement hierarchy representing this schema.

Returns
JsonElement

the JsonElement hierarchy representing this schema

toString

open fun toString(): String

Public properties

description

open val descriptionString?

semantic description of the schema

items

Added in 1.0.0-alpha01
val itemsA2uiSchema?

schema that every element in this array must conform to, or null if any schema is allowed.

keywords

open val keywordsList<A2uiSchemaKeyword<List<Any>>>

JSON Schema keywords applied to this schema node

maxItems

Added in 1.0.0-alpha01
val maxItemsInt

maximum number of items allowed in the array (unconstrained if -1)

minItems

Added in 1.0.0-alpha01
val minItemsInt

minimum number of items required in the array (unconstrained if -1)