# A2uiProperty Artifact: [androidx.a2ui.compose:compose-runtime](https://developer.android.com/jetpack/androidx/releases/a2ui-compose) [View Source](https://cs.android.com/search?q=file:androidx/a2ui/compose/runtime/A2uiProperty.kt+class:androidx.a2ui.compose.runtime.A2uiProperty) Added in [1.0.0-alpha02](https://developer.android.com/jetpack/androidx/releases/a2ui-compose#1.0.0-alpha02) ``` sealed class A2uiProperty ```
Known direct subclasses [ChildListA2uiProperty](https://developer.android.com/reference/kotlin/androidx/a2ui/compose/runtime/ChildListA2uiProperty), [DynamicA2uiProperty](https://developer.android.com/reference/kotlin/androidx/a2ui/compose/runtime/DynamicA2uiProperty), [StaticA2uiProperty](https://developer.android.com/reference/kotlin/androidx/a2ui/compose/runtime/StaticA2uiProperty) |---|---| | `https://developer.android.com/reference/kotlin/androidx/a2ui/compose/runtime/ChildListA2uiProperty` | A property representing a structural list of child components. | | `https://developer.android.com/reference/kotlin/androidx/a2ui/compose/runtime/DynamicA2uiProperty` | A property that supports dynamic data-binding and requires reactive evaluation. | | `https://developer.android.com/reference/kotlin/androidx/a2ui/compose/runtime/StaticA2uiProperty` | A static configuration or structural property that should be read synchronously. | *** ** * ** *** A typed declaration of a property expected by an A2UI component. `A2uiProperty` serves two primary purposes: 1. **Schema Generation** : It automatically constructs the underlying `https://developer.android.com/reference/kotlin/androidx/a2ui/model/schema/A2uiSchema` used to communicate the component's structural requirements to the agent. 2. **Typed Resolution** : It acts as a token utilized by `https://developer.android.com/reference/kotlin/androidx/a2ui/compose/runtime/A2uiComponentProperties` and `https://developer.android.com/reference/kotlin/androidx/a2ui/compose/runtime/A2uiComponentScope` to safely extract, type-cast, and optionally evaluate dynamic bindings from incoming protocol payloads at runtime. Properties are divided into specific subtypes based on their runtime evaluation behavior: - `https://developer.android.com/reference/kotlin/androidx/a2ui/compose/runtime/StaticA2uiProperty`: Read synchronously directly from the component properties. - `https://developer.android.com/reference/kotlin/androidx/a2ui/compose/runtime/DynamicA2uiProperty`: Evaluated reactively against the surface's data model. - `https://developer.android.com/reference/kotlin/androidx/a2ui/compose/runtime/ChildListA2uiProperty`: Used to resolve structural hierarchies of nested components. The property subtypes listed above are used in the APIs provided by `https://developer.android.com/reference/kotlin/androidx/a2ui/compose/runtime/A2uiComponentScope` to ensure that only the allowed property types are used with each of the relevant APIs. | Parameters | |---|---| | `` | The expected type of the resolved property value at runtime. | ## Summary | ### Public companion functions | |---|---| | `https://developer.android.com/reference/kotlin/androidx/a2ui/compose/runtime/StaticA2uiProperty>` | `https://developer.android.com/reference/kotlin/androidx/a2ui/compose/runtime/A2uiProperty#action(kotlin.String,kotlin.Boolean,kotlin.String)(key: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html, required: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html, description: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html?)` Creates a static property describing an action to be executed when interacting with the component. | | `https://developer.android.com/reference/kotlin/androidx/a2ui/compose/runtime/StaticA2uiProperty` | `https://developer.android.com/reference/kotlin/androidx/a2ui/compose/runtime/A2uiProperty#any(kotlin.String,kotlin.Boolean,kotlin.String)(key: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html, required: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html, description: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html?)` Creates a static property accepting an arbitrary payload without strict type enforcement. | | `https://developer.android.com/reference/kotlin/androidx/a2ui/compose/runtime/StaticA2uiProperty>` | `https://developer.android.com/reference/kotlin/androidx/a2ui/compose/runtime/A2uiProperty#anyList(kotlin.String,kotlin.Boolean,kotlin.String,kotlin.Int,kotlin.Int)( key: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html, required: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html, description: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html?, minItems: @https://developer.android.com/reference/kotlin/androidx/annotation/IntRange(from = 0) https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html, maxItems: @https://developer.android.com/reference/kotlin/androidx/annotation/IntRange(from = 0) https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html )` Creates a static property expecting a list of any values. | | `https://developer.android.com/reference/kotlin/androidx/a2ui/compose/runtime/StaticA2uiProperty` | `https://developer.android.com/reference/kotlin/androidx/a2ui/compose/runtime/A2uiProperty#boolean(kotlin.String,kotlin.Boolean,kotlin.String)(key: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html, required: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html, description: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html?)` Creates a static property expecting a literal boolean value. | | `https://developer.android.com/reference/kotlin/androidx/a2ui/compose/runtime/StaticA2uiProperty>` | `https://developer.android.com/reference/kotlin/androidx/a2ui/compose/runtime/A2uiProperty#booleanList(kotlin.String,kotlin.Boolean,kotlin.String,kotlin.Int,kotlin.Int)( key: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html, required: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html, description: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html?, minItems: @https://developer.android.com/reference/kotlin/androidx/annotation/IntRange(from = 0) https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html, maxItems: @https://developer.android.com/reference/kotlin/androidx/annotation/IntRange(from = 0) https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html )` Creates a static property expecting a list of booleans. | | `https://developer.android.com/reference/kotlin/androidx/a2ui/compose/runtime/StaticA2uiProperty` | `https://developer.android.com/reference/kotlin/androidx/a2ui/compose/runtime/A2uiProperty#booleanWithDefault(kotlin.String,kotlin.Boolean,kotlin.String)(key: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html, defaultValue: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html, description: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html?)` Creates an optional static property expecting a literal boolean value with a default value. | | `https://developer.android.com/reference/kotlin/androidx/a2ui/compose/runtime/ChildListA2uiProperty` | `https://developer.android.com/reference/kotlin/androidx/a2ui/compose/runtime/A2uiProperty#childList(kotlin.String,kotlin.Boolean,kotlin.String)(key: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html, required: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html, description: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html?)` Creates a property representing a structural list of child component references. | | `https://developer.android.com/reference/kotlin/androidx/a2ui/compose/runtime/StaticA2uiProperty` | `https://developer.android.com/reference/kotlin/androidx/a2ui/compose/runtime/A2uiProperty#componentId(kotlin.String,kotlin.Boolean,kotlin.String)(key: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html, required: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html, description: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html?)` Creates a static property storing the string ID of another component within the same surface. | | `https://developer.android.com/reference/kotlin/androidx/a2ui/compose/runtime/StaticA2uiProperty` | ` https://developer.android.com/reference/kotlin/androidx/a2ui/compose/runtime/A2uiProperty#custom(kotlin.String,androidx.a2ui.model.schema.A2uiSchema,kotlin.Function1,kotlin.Boolean)( key: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html, schema: https://developer.android.com/reference/kotlin/androidx/a2ui/model/schema/A2uiSchema, safeCast: (https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html) -> T?, required: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html )` Creates a static property with a custom schema and type-casting logic. | | `https://developer.android.com/reference/kotlin/androidx/a2ui/compose/runtime/DynamicA2uiProperty` | `https://developer.android.com/reference/kotlin/androidx/a2ui/compose/runtime/A2uiProperty#dynamicBoolean(kotlin.String,kotlin.Boolean,kotlin.String)(key: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html, required: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html, description: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html?)` Creates a dynamic property representing a reactive data binding mapped to a `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html`. | | `https://developer.android.com/reference/kotlin/androidx/a2ui/compose/runtime/DynamicA2uiProperty` | ` https://developer.android.com/reference/kotlin/androidx/a2ui/compose/runtime/A2uiProperty#dynamicCustom(kotlin.String,androidx.a2ui.model.schema.A2uiSchema,kotlin.Function1,kotlin.Boolean)( key: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html, schema: https://developer.android.com/reference/kotlin/androidx/a2ui/model/schema/A2uiSchema, safeCast: (https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html) -> T?, required: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html )` Creates a dynamic property with a custom schema and type-casting logic. | | `https://developer.android.com/reference/kotlin/androidx/a2ui/compose/runtime/DynamicA2uiProperty` | `https://developer.android.com/reference/kotlin/androidx/a2ui/compose/runtime/A2uiProperty#dynamicNumber(kotlin.String,kotlin.Boolean,kotlin.String)(key: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html, required: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html, description: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html?)` Creates a dynamic property representing a reactive data binding mapped to a `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-number/index.html`. | | `https://developer.android.com/reference/kotlin/androidx/a2ui/compose/runtime/DynamicA2uiProperty` | `https://developer.android.com/reference/kotlin/androidx/a2ui/compose/runtime/A2uiProperty#dynamicString(kotlin.String,kotlin.Boolean,kotlin.String)(key: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html, required: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html, description: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html?)` Creates a dynamic property representing a reactive data binding mapped to a `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html`. | | `https://developer.android.com/reference/kotlin/androidx/a2ui/compose/runtime/DynamicA2uiProperty>` | `https://developer.android.com/reference/kotlin/androidx/a2ui/compose/runtime/A2uiProperty#dynamicStringList(kotlin.String,kotlin.Boolean,kotlin.String)(key: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html, required: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html, description: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html?)` Creates a dynamic property representing a reactive data binding mapped to a `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-list/index.html` of `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html`s. | | `https://developer.android.com/reference/kotlin/androidx/a2ui/compose/runtime/DynamicA2uiProperty` | `https://developer.android.com/reference/kotlin/androidx/a2ui/compose/runtime/A2uiProperty#dynamicValue(kotlin.String,kotlin.Boolean,kotlin.String)(key: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html, required: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html, description: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html?)` Creates a dynamic property representing a reactive data binding that can resolve to any type. | | `https://developer.android.com/reference/kotlin/androidx/a2ui/compose/runtime/StaticA2uiProperty` | `> https://developer.android.com/reference/kotlin/androidx/a2ui/compose/runtime/A2uiProperty#enum(kotlin.String,kotlin.collections.List,kotlin.Function1,kotlin.Function1,kotlin.Enum,kotlin.String)( key: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html, enumValues: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-list/index.html, mapToString: (T) -> https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html, convertFromString: (https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html) -> T?, defaultValue: T, description: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html? )` Creates an optional static property expecting an enum value strictly bounded to a predefined list of enum options with a default value. | | `https://developer.android.com/reference/kotlin/androidx/a2ui/compose/runtime/StaticA2uiProperty` | `> https://developer.android.com/reference/kotlin/androidx/a2ui/compose/runtime/A2uiProperty#enum(kotlin.String,kotlin.collections.List,kotlin.Function1,kotlin.Function1,kotlin.Boolean,kotlin.String)( key: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html, enumValues: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-list/index.html, mapToString: (T) -> https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html, convertFromString: (https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html) -> T?, required: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html, description: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html? )` Creates a static property expecting an enum value strictly bounded to a predefined list of enum options with the ability to map values to custom types to support statically typed enums. | | `https://developer.android.com/reference/kotlin/androidx/a2ui/compose/runtime/StaticA2uiProperty` | `https://developer.android.com/reference/kotlin/androidx/a2ui/compose/runtime/A2uiProperty#nested(kotlin.String,kotlin.collections.List,kotlin.Boolean,kotlin.String,kotlin.Boolean,androidx.a2ui.model.schema.A2uiSchema)( key: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html, properties: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-list/index.html>, required: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html, description: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html?, isAdditionalPropertiesAllowed: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html, additionalPropertiesSchema: https://developer.android.com/reference/kotlin/androidx/a2ui/model/schema/A2uiSchema? )` Creates a static property representing a nested property object. | | `https://developer.android.com/reference/kotlin/androidx/a2ui/compose/runtime/StaticA2uiProperty>` | `https://developer.android.com/reference/kotlin/androidx/a2ui/compose/runtime/A2uiProperty#nestedList(kotlin.String,kotlin.collections.List,kotlin.Boolean,kotlin.String,kotlin.Int,kotlin.Int,kotlin.Boolean,androidx.a2ui.model.schema.A2uiSchema)( key: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html, properties: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-list/index.html>, required: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html, description: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html?, minItems: @https://developer.android.com/reference/kotlin/androidx/annotation/IntRange(from = 0) https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html, maxItems: @https://developer.android.com/reference/kotlin/androidx/annotation/IntRange(from = 0) https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html, isAdditionalPropertiesAllowed: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html, additionalPropertiesSchema: https://developer.android.com/reference/kotlin/androidx/a2ui/model/schema/A2uiSchema? )` Creates a static property representing an list of nested property objects. | | `https://developer.android.com/reference/kotlin/androidx/a2ui/compose/runtime/StaticA2uiProperty` | `https://developer.android.com/reference/kotlin/androidx/a2ui/compose/runtime/A2uiProperty#number(kotlin.String,kotlin.Double,kotlin.String)(key: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html, defaultValue: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-double/index.html, description: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html?)` Creates an optional static property expecting a literal numeric value with a double default value. | | `https://developer.android.com/reference/kotlin/androidx/a2ui/compose/runtime/StaticA2uiProperty` | `https://developer.android.com/reference/kotlin/androidx/a2ui/compose/runtime/A2uiProperty#number(kotlin.String,kotlin.Float,kotlin.String)(key: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html, defaultValue: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html, description: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html?)` Creates an optional static property expecting a literal numeric value with a float default value. | | `https://developer.android.com/reference/kotlin/androidx/a2ui/compose/runtime/StaticA2uiProperty` | `https://developer.android.com/reference/kotlin/androidx/a2ui/compose/runtime/A2uiProperty#number(kotlin.String,kotlin.Int,kotlin.String)(key: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html, defaultValue: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html, description: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html?)` Creates an optional static property expecting a literal numeric value with an integer default value. | | `https://developer.android.com/reference/kotlin/androidx/a2ui/compose/runtime/StaticA2uiProperty` | `https://developer.android.com/reference/kotlin/androidx/a2ui/compose/runtime/A2uiProperty#number(kotlin.String,kotlin.Long,kotlin.String)(key: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html, defaultValue: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-long/index.html, description: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html?)` Creates an optional static property expecting a literal numeric value with a long default value. | | `https://developer.android.com/reference/kotlin/androidx/a2ui/compose/runtime/StaticA2uiProperty` | `https://developer.android.com/reference/kotlin/androidx/a2ui/compose/runtime/A2uiProperty#number(kotlin.String,kotlin.Boolean,kotlin.String)(key: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html, required: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html, description: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html?)` Creates a static property expecting a literal numeric value. | | `https://developer.android.com/reference/kotlin/androidx/a2ui/compose/runtime/StaticA2uiProperty` | `https://developer.android.com/reference/kotlin/androidx/a2ui/compose/runtime/A2uiProperty#numberEnum(kotlin.String,androidx.collection.DoubleList,kotlin.Double,kotlin.String)( key: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html, enumValues: https://developer.android.com/reference/kotlin/androidx/collection/DoubleList, defaultValue: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-double/index.html, description: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html? )` Creates an optional static property expecting a double value strictly bounded to a predefined list of options with a specified default value. | | `https://developer.android.com/reference/kotlin/androidx/a2ui/compose/runtime/StaticA2uiProperty` | `https://developer.android.com/reference/kotlin/androidx/a2ui/compose/runtime/A2uiProperty#numberEnum(kotlin.String,androidx.collection.FloatList,kotlin.Float,kotlin.String)( key: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html, enumValues: https://developer.android.com/reference/kotlin/androidx/collection/FloatList, defaultValue: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html, description: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html? )` Creates an optional static property expecting a float value strictly bounded to a predefined list of options with a specified default value. | | `https://developer.android.com/reference/kotlin/androidx/a2ui/compose/runtime/StaticA2uiProperty` | `https://developer.android.com/reference/kotlin/androidx/a2ui/compose/runtime/A2uiProperty#numberEnum(kotlin.String,androidx.collection.IntList,kotlin.Int,kotlin.String)( key: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html, enumValues: https://developer.android.com/reference/kotlin/androidx/collection/IntList, defaultValue: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html, description: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html? )` Creates an optional static property expecting an integer value strictly bounded to a predefined list of options with a specified default value. | | `https://developer.android.com/reference/kotlin/androidx/a2ui/compose/runtime/StaticA2uiProperty` | `https://developer.android.com/reference/kotlin/androidx/a2ui/compose/runtime/A2uiProperty#numberEnum(kotlin.String,kotlin.collections.List,kotlin.Boolean,kotlin.String)( key: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html, enumValues: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-list/index.html, required: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html, description: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html? )` Creates a static property expecting a number value strictly bounded to a predefined list of options. | | `https://developer.android.com/reference/kotlin/androidx/a2ui/compose/runtime/StaticA2uiProperty` | `https://developer.android.com/reference/kotlin/androidx/a2ui/compose/runtime/A2uiProperty#numberEnum(kotlin.String,androidx.collection.LongList,kotlin.Long,kotlin.String)( key: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html, enumValues: https://developer.android.com/reference/kotlin/androidx/collection/LongList, defaultValue: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-long/index.html, description: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html? )` Creates an optional static property expecting a long value strictly bounded to a predefined list of options with a specified default value. | | `https://developer.android.com/reference/kotlin/androidx/a2ui/compose/runtime/StaticA2uiProperty>` | `https://developer.android.com/reference/kotlin/androidx/a2ui/compose/runtime/A2uiProperty#numberList(kotlin.String,kotlin.Boolean,kotlin.String,kotlin.Int,kotlin.Int)( key: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html, required: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html, description: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html?, minItems: @https://developer.android.com/reference/kotlin/androidx/annotation/IntRange(from = 0) https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html, maxItems: @https://developer.android.com/reference/kotlin/androidx/annotation/IntRange(from = 0) https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html )` Creates a static property expecting a list of numbers. | | `https://developer.android.com/reference/kotlin/androidx/a2ui/compose/runtime/StaticA2uiProperty` | `https://developer.android.com/reference/kotlin/androidx/a2ui/compose/runtime/A2uiProperty#string(kotlin.String,kotlin.Boolean,kotlin.String)(key: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html, required: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html, description: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html?)` Creates a static property expecting a literal string value. | | `https://developer.android.com/reference/kotlin/androidx/a2ui/compose/runtime/StaticA2uiProperty` | `https://developer.android.com/reference/kotlin/androidx/a2ui/compose/runtime/A2uiProperty#stringEnum(kotlin.String,kotlin.collections.List,kotlin.String,kotlin.String)( key: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html, enumValues: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-list/index.html, defaultValue: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html, description: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html? )` Creates an optional static property expecting a string value strictly bounded to a predefined list of options with a default value. | | `https://developer.android.com/reference/kotlin/androidx/a2ui/compose/runtime/StaticA2uiProperty` | `https://developer.android.com/reference/kotlin/androidx/a2ui/compose/runtime/A2uiProperty#stringEnum(kotlin.String,kotlin.collections.List,kotlin.Boolean,kotlin.String)( key: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html, enumValues: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-list/index.html, required: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html, description: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html? )` Creates a static property expecting a string value strictly bounded to a predefined list of options. | | `https://developer.android.com/reference/kotlin/androidx/a2ui/compose/runtime/StaticA2uiProperty>` | `https://developer.android.com/reference/kotlin/androidx/a2ui/compose/runtime/A2uiProperty#stringList(kotlin.String,kotlin.Boolean,kotlin.String,kotlin.Int,kotlin.Int)( key: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html, required: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html, description: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html?, minItems: @https://developer.android.com/reference/kotlin/androidx/annotation/IntRange(from = 0) https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html, maxItems: @https://developer.android.com/reference/kotlin/androidx/annotation/IntRange(from = 0) https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html )` Creates a static property expecting a list of strings. | | ### Protected constructors | |---| | ` https://developer.android.com/reference/kotlin/androidx/a2ui/compose/runtime/A2uiProperty#A2uiProperty()()` | | ### Public properties | |---|---| | `abstract https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | `https://developer.android.com/reference/kotlin/androidx/a2ui/compose/runtime/A2uiProperty#isRequired()` Indicates whether the agent is strictly required to provide this property. | | `abstract https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` | `https://developer.android.com/reference/kotlin/androidx/a2ui/compose/runtime/A2uiProperty#key()` The key of the property as it appears in the A2UI protocol payload. | | `abstract https://developer.android.com/reference/kotlin/androidx/a2ui/model/schema/A2uiSchema` | `https://developer.android.com/reference/kotlin/androidx/a2ui/compose/runtime/A2uiProperty#schema()` The underlying `https://developer.android.com/reference/kotlin/androidx/a2ui/model/schema/A2uiSchema` definition describing this property to the agent. | ## Public companion functions ### action Added in [1.0.0-alpha02](https://developer.android.com/jetpack/androidx/releases/a2ui-compose#1.0.0-alpha02) ``` fun action(key: String, required: Boolean = false, description: String? = null): StaticA2uiProperty> ``` Creates a static property describing an action to be executed when interacting with the component. The payload dictates whether the action invokes a local UI function (e.g. `openUrl`) or queues an interaction event over the network to the server. | Parameters | |---|---| | `key: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` | The key for this property. | | `required: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html = false` | Whether the agent must provide this property to successfully render the component. | | `description: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html? = null` | An optional string explaining this property's purpose to the agent. | | Returns | |---|---| | `https://developer.android.com/reference/kotlin/androidx/a2ui/compose/runtime/StaticA2uiProperty>` | A `https://developer.android.com/reference/kotlin/androidx/a2ui/compose/runtime/StaticA2uiProperty` resolving to the action definition Map at runtime. | ### any Added in [1.0.0-alpha02](https://developer.android.com/jetpack/androidx/releases/a2ui-compose#1.0.0-alpha02) ``` fun any(key: String, required: Boolean = false, description: String? = null): StaticA2uiProperty ``` Creates a static property accepting an arbitrary payload without strict type enforcement. | Parameters | |---|---| | `key: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` | The key for this property. | | `required: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html = false` | Whether the agent must provide this property to successfully render the component. | | `description: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html? = null` | An optional string explaining this property's purpose to the agent. | | Returns | |---|---| | `https://developer.android.com/reference/kotlin/androidx/a2ui/compose/runtime/StaticA2uiProperty` | A `https://developer.android.com/reference/kotlin/androidx/a2ui/compose/runtime/StaticA2uiProperty` resolving to `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html` (usually a Map, List, or primitive) at runtime. | ### anyList Added in [1.0.0-alpha02](https://developer.android.com/jetpack/androidx/releases/a2ui-compose#1.0.0-alpha02) ``` fun anyList(     key: String,     required: Boolean = false,     description: String? = null,     minItems: @IntRange(from = 0) Int = 0,     maxItems: @IntRange(from = 0) Int = Int.MAX_VALUE ): StaticA2uiProperty> ``` Creates a static property expecting a list of any values. | Parameters | |---|---| | `key: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` | The key for this property. | | `required: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html = false` | Whether the agent must provide this property to successfully render the component. | | `description: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html? = null` | An optional string explaining this property's purpose to the agent. | | `minItems: @https://developer.android.com/reference/kotlin/androidx/annotation/IntRange(from = 0) https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html = 0` | The minimum number of items required in the list, defaults to 0. | | `maxItems: @https://developer.android.com/reference/kotlin/androidx/annotation/IntRange(from = 0) https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html = Int.MAX_VALUE` | The maximum number of items allowed in the list, defaults to `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/-companion/-m-a-x_-v-a-l-u-e.html` meaning no constraint. | | Returns | |---|---| | `https://developer.android.com/reference/kotlin/androidx/a2ui/compose/runtime/StaticA2uiProperty>` | A `https://developer.android.com/reference/kotlin/androidx/a2ui/compose/runtime/StaticA2uiProperty` that resolves to a `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-list/index.html` of `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html` at runtime. | | Throws | |---|---| | `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-illegal-argument-exception/index.html` | If `https://developer.android.com/reference/kotlin/androidx/a2ui/compose/runtime/A2uiProperty.Companion#anyList(kotlin.String,kotlin.Boolean,kotlin.String,kotlin.Int,kotlin.Int)` or `https://developer.android.com/reference/kotlin/androidx/a2ui/compose/runtime/A2uiProperty.Companion#anyList(kotlin.String,kotlin.Boolean,kotlin.String,kotlin.Int,kotlin.Int)` is negative, or if `https://developer.android.com/reference/kotlin/androidx/a2ui/compose/runtime/A2uiProperty.Companion#anyList(kotlin.String,kotlin.Boolean,kotlin.String,kotlin.Int,kotlin.Int)` is greater than `https://developer.android.com/reference/kotlin/androidx/a2ui/compose/runtime/A2uiProperty.Companion#anyList(kotlin.String,kotlin.Boolean,kotlin.String,kotlin.Int,kotlin.Int)`. | ### boolean Added in [1.0.0-alpha02](https://developer.android.com/jetpack/androidx/releases/a2ui-compose#1.0.0-alpha02) ``` fun boolean(key: String, required: Boolean = false, description: String? = null): StaticA2uiProperty ``` Creates a static property expecting a literal boolean value. | Parameters | |---|---| | `key: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` | The key for this property. | | `required: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html = false` | Whether the agent must provide this property to successfully render the component. | | `description: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html? = null` | An optional string explaining this property's purpose to the agent. | | Returns | |---|---| | `https://developer.android.com/reference/kotlin/androidx/a2ui/compose/runtime/StaticA2uiProperty` | A `https://developer.android.com/reference/kotlin/androidx/a2ui/compose/runtime/StaticA2uiProperty` that resolves to a `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` at runtime. | ### booleanList Added in [1.0.0-alpha02](https://developer.android.com/jetpack/androidx/releases/a2ui-compose#1.0.0-alpha02) ``` fun booleanList(     key: String,     required: Boolean = false,     description: String? = null,     minItems: @IntRange(from = 0) Int = 0,     maxItems: @IntRange(from = 0) Int = Int.MAX_VALUE ): StaticA2uiProperty> ``` Creates a static property expecting a list of booleans. | Parameters | |---|---| | `key: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` | The key for this property. | | `required: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html = false` | Whether the agent must provide this property to successfully render the component. | | `description: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html? = null` | An optional string explaining this property's purpose to the agent. | | `minItems: @https://developer.android.com/reference/kotlin/androidx/annotation/IntRange(from = 0) https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html = 0` | The minimum number of items required in the list, defaults to 0. | | `maxItems: @https://developer.android.com/reference/kotlin/androidx/annotation/IntRange(from = 0) https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html = Int.MAX_VALUE` | The maximum number of items allowed in the list, defaults to `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/-companion/-m-a-x_-v-a-l-u-e.html` meaning no constraint. | | Returns | |---|---| | `https://developer.android.com/reference/kotlin/androidx/a2ui/compose/runtime/StaticA2uiProperty>` | A `https://developer.android.com/reference/kotlin/androidx/a2ui/compose/runtime/StaticA2uiProperty` that resolves to a `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-list/index.html` of `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` at runtime. | | Throws | |---|---| | `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-illegal-argument-exception/index.html` | If `https://developer.android.com/reference/kotlin/androidx/a2ui/compose/runtime/A2uiProperty.Companion#booleanList(kotlin.String,kotlin.Boolean,kotlin.String,kotlin.Int,kotlin.Int)` or `https://developer.android.com/reference/kotlin/androidx/a2ui/compose/runtime/A2uiProperty.Companion#booleanList(kotlin.String,kotlin.Boolean,kotlin.String,kotlin.Int,kotlin.Int)` is negative, or if `https://developer.android.com/reference/kotlin/androidx/a2ui/compose/runtime/A2uiProperty.Companion#booleanList(kotlin.String,kotlin.Boolean,kotlin.String,kotlin.Int,kotlin.Int)` is greater than `https://developer.android.com/reference/kotlin/androidx/a2ui/compose/runtime/A2uiProperty.Companion#booleanList(kotlin.String,kotlin.Boolean,kotlin.String,kotlin.Int,kotlin.Int)`. | ### booleanWithDefault Added in [1.0.0-alpha02](https://developer.android.com/jetpack/androidx/releases/a2ui-compose#1.0.0-alpha02) ``` fun booleanWithDefault(     key: String,     defaultValue: Boolean,     description: String? = null ): StaticA2uiProperty ``` Creates an optional static property expecting a literal boolean value with a default value. | Parameters | |---|---| | `key: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` | The key for this property. | | `defaultValue: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | The default value for this property. | | `description: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html? = null` | An optional string explaining this property's purpose to the agent. | | Returns | |---|---| | `https://developer.android.com/reference/kotlin/androidx/a2ui/compose/runtime/StaticA2uiProperty` | A `https://developer.android.com/reference/kotlin/androidx/a2ui/compose/runtime/StaticA2uiProperty` that resolves to a `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` at runtime. | ### childList Added in [1.0.0-alpha02](https://developer.android.com/jetpack/androidx/releases/a2ui-compose#1.0.0-alpha02) ``` fun childList(key: String, required: Boolean = false, description: String? = null): ChildListA2uiProperty ``` Creates a property representing a structural list of child component references. This signals to the agent that it can provide either: 1. A static list of `ComponentId` string references. 2. An object describing a dynamic data-bound template (e.g., `{"path": "/users", "componentId": "user_card"}`). | Parameters | |---|---| | `key: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` | The key for this property. | | `required: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html = false` | Whether the agent must provide this property to successfully render the component. | | `description: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html? = null` | An optional string explaining this property's purpose to the agent. | | Returns | |---|---| | `https://developer.android.com/reference/kotlin/androidx/a2ui/compose/runtime/ChildListA2uiProperty` | A `https://developer.android.com/reference/kotlin/androidx/a2ui/compose/runtime/ChildListA2uiProperty` to be handled via `A2uiComponentProperties.bindChildReferences()`. | ### componentId Added in [1.0.0-alpha02](https://developer.android.com/jetpack/androidx/releases/a2ui-compose#1.0.0-alpha02) ``` fun componentId(key: String, required: Boolean = false, description: String? = null): StaticA2uiProperty ``` Creates a static property storing the string ID of another component within the same surface. Used to link container components to singular children (e.g. a `Button`'s child). | Parameters | |---|---| | `key: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` | The key for this property. | | `required: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html = false` | Whether the agent must provide this property to successfully render the component. | | `description: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html? = null` | An optional string explaining this property's purpose to the agent. | | Returns | |---|---| | `https://developer.android.com/reference/kotlin/androidx/a2ui/compose/runtime/StaticA2uiProperty` | A `https://developer.android.com/reference/kotlin/androidx/a2ui/compose/runtime/StaticA2uiProperty` resolving to the target component's ID as a `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html`. | ### custom Added in [1.0.0-alpha02](https://developer.android.com/jetpack/androidx/releases/a2ui-compose#1.0.0-alpha02) ``` fun  custom(     key: String,     schema: A2uiSchema,     safeCast: (Any) -> T?,     required: Boolean = false ): StaticA2uiProperty ``` Creates a static property with a custom schema and type-casting logic. This allows defining a property that is constrained by a custom JSON schema (e.g., `oneOf` with specific literal schemas). | Parameters | |---|---| | `key: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` | The key for this property. | | `schema: https://developer.android.com/reference/kotlin/androidx/a2ui/model/schema/A2uiSchema` | The custom `https://developer.android.com/reference/kotlin/androidx/a2ui/model/schema/A2uiSchema` defining this property's structural requirements. | | `safeCast: (https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html) -> T?` | A function to safely cast the raw payload into the expected type `https://developer.android.com/reference/kotlin/androidx/a2ui/compose/runtime/A2uiProperty.Companion#custom(kotlin.String,androidx.a2ui.model.schema.A2uiSchema,kotlin.Function1,kotlin.Boolean)`. | | `required: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html = false` | Whether the agent must provide this property to successfully render the component. | | Returns | |---|---| | `https://developer.android.com/reference/kotlin/androidx/a2ui/compose/runtime/StaticA2uiProperty` | A `https://developer.android.com/reference/kotlin/androidx/a2ui/compose/runtime/StaticA2uiProperty` that resolves to `https://developer.android.com/reference/kotlin/androidx/a2ui/compose/runtime/A2uiProperty.Companion#custom(kotlin.String,androidx.a2ui.model.schema.A2uiSchema,kotlin.Function1,kotlin.Boolean)` at runtime. | ### dynamicBoolean Added in [1.0.0-alpha02](https://developer.android.com/jetpack/androidx/releases/a2ui-compose#1.0.0-alpha02) ``` fun dynamicBoolean(     key: String,     required: Boolean = false,     description: String? = null ): DynamicA2uiProperty ``` Creates a dynamic property representing a reactive data binding mapped to a `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html`. The resolved runtime value will safely attempt to coerce compliant `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html`s (e.g. `"true"`) or `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-number/index.html`s (`1` -\>`true`, `0` -\>`false`) into a `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html`. | Parameters | |---|---| | `key: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` | The key for this property. | | `required: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html = false` | Whether the agent must provide this property to successfully render the component. | | `description: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html? = null` | An optional string explaining this property's purpose to the agent. | | Returns | |---|---| | `https://developer.android.com/reference/kotlin/androidx/a2ui/compose/runtime/DynamicA2uiProperty` | A `https://developer.android.com/reference/kotlin/androidx/a2ui/compose/runtime/DynamicA2uiProperty` evaluated dynamically against the surface's data model at runtime. | ### dynamicCustom Added in [1.0.0-alpha02](https://developer.android.com/jetpack/androidx/releases/a2ui-compose#1.0.0-alpha02) ``` fun  dynamicCustom(     key: String,     schema: A2uiSchema,     safeCast: (Any) -> T?,     required: Boolean = false ): DynamicA2uiProperty ``` Creates a dynamic property with a custom schema and type-casting logic. This allows defining a property that is dynamically evaluated against the data model, but constrained by a custom JSON schema (e.g., `oneOf` with specific literal schemas). | Parameters | |---|---| | `key: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` | The key for this property. | | `schema: https://developer.android.com/reference/kotlin/androidx/a2ui/model/schema/A2uiSchema` | The custom `https://developer.android.com/reference/kotlin/androidx/a2ui/model/schema/A2uiSchema` defining this property's structural requirements. | | `safeCast: (https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html) -> T?` | A function to safely cast the evaluated payload into the expected type `https://developer.android.com/reference/kotlin/androidx/a2ui/compose/runtime/A2uiProperty.Companion#dynamicCustom(kotlin.String,androidx.a2ui.model.schema.A2uiSchema,kotlin.Function1,kotlin.Boolean)`. | | `required: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html = false` | Whether the agent must provide this property to successfully render the component. | | Returns | |---|---| | `https://developer.android.com/reference/kotlin/androidx/a2ui/compose/runtime/DynamicA2uiProperty` | A `https://developer.android.com/reference/kotlin/androidx/a2ui/compose/runtime/DynamicA2uiProperty` evaluated dynamically against the surface's data model at runtime. | ### dynamicNumber Added in [1.0.0-alpha02](https://developer.android.com/jetpack/androidx/releases/a2ui-compose#1.0.0-alpha02) ``` fun dynamicNumber(key: String, required: Boolean = false, description: String? = null): DynamicA2uiProperty ``` Creates a dynamic property representing a reactive data binding mapped to a `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-number/index.html`. The resolved runtime value will safely attempt to coerce compliant `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html`s (e.g. `"42"`) or `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html`s (`true` -\>`1`) into a `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-number/index.html`. | Parameters | |---|---| | `key: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` | The key for this property. | | `required: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html = false` | Whether the agent must provide this property to successfully render the component. | | `description: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html? = null` | An optional string explaining this property's purpose to the agent. | | Returns | |---|---| | `https://developer.android.com/reference/kotlin/androidx/a2ui/compose/runtime/DynamicA2uiProperty` | A `https://developer.android.com/reference/kotlin/androidx/a2ui/compose/runtime/DynamicA2uiProperty` evaluated dynamically against the surface's data model at runtime. | ### dynamicString Added in [1.0.0-alpha02](https://developer.android.com/jetpack/androidx/releases/a2ui-compose#1.0.0-alpha02) ``` fun dynamicString(key: String, required: Boolean = false, description: String? = null): DynamicA2uiProperty ``` Creates a dynamic property representing a reactive data binding mapped to a `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html`. The resolved runtime value will automatically be safely coerced or stringified if the bound path points to non-string primitives or complex objects. | Parameters | |---|---| | `key: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` | The key for this property. | | `required: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html = false` | Whether the agent must provide this property to successfully render the component. | | `description: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html? = null` | An optional string explaining this property's purpose to the agent. | | Returns | |---|---| | `https://developer.android.com/reference/kotlin/androidx/a2ui/compose/runtime/DynamicA2uiProperty` | A `https://developer.android.com/reference/kotlin/androidx/a2ui/compose/runtime/DynamicA2uiProperty` evaluated dynamically against the surface's data model at runtime. | ### dynamicStringList Added in [1.0.0-alpha02](https://developer.android.com/jetpack/androidx/releases/a2ui-compose#1.0.0-alpha02) ``` fun dynamicStringList(     key: String,     required: Boolean = false,     description: String? = null ): DynamicA2uiProperty> ``` Creates a dynamic property representing a reactive data binding mapped to a `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-list/index.html` of `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html`s. The resolved runtime value must be a list. Its children will automatically be coerced or stringified into `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` values. | Parameters | |---|---| | `key: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` | The key for this property. | | `required: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html = false` | Whether the agent must provide this property to successfully render the component. | | `description: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html? = null` | An optional string explaining this property's purpose to the agent. | | Returns | |---|---| | `https://developer.android.com/reference/kotlin/androidx/a2ui/compose/runtime/DynamicA2uiProperty>` | A `https://developer.android.com/reference/kotlin/androidx/a2ui/compose/runtime/DynamicA2uiProperty` evaluated dynamically against the surface's data model at runtime. | ### dynamicValue Added in [1.0.0-alpha02](https://developer.android.com/jetpack/androidx/releases/a2ui-compose#1.0.0-alpha02) ``` fun dynamicValue(key: String, required: Boolean = false, description: String? = null): DynamicA2uiProperty ``` Creates a dynamic property representing a reactive data binding that can resolve to any type. The payload provided by the agent can be a literal value, a data-model JSON pointer (e.g., `{"path": "/user"}`), or a function call execution tree. | Parameters | |---|---| | `key: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` | The key for this property. | | `required: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html = false` | Whether the agent must provide this property to successfully render the component. | | `description: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html? = null` | An optional string explaining this property's purpose to the agent. | | Returns | |---|---| | `https://developer.android.com/reference/kotlin/androidx/a2ui/compose/runtime/DynamicA2uiProperty` | A `https://developer.android.com/reference/kotlin/androidx/a2ui/compose/runtime/DynamicA2uiProperty` evaluated dynamically against the surface's data model at runtime. | ### enum ``` fun > enum(     key: String,     enumValues: List,     mapToString: (T) -> String,     convertFromString: (String) -> T?,     defaultValue: T,     description: String? = null ): StaticA2uiProperty ``` Creates an optional static property expecting an enum value strictly bounded to a predefined list of enum options with a default value. | Parameters | |---|---| | `key: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` | The key for this property. | | `enumValues: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-list/index.html` | A list of valid enum values the agent is allowed to supply for this property. | | `mapToString: (T) -> https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` | A mapping function to serialize an enum entry into its string schema value. | | `convertFromString: (https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html) -> T?` | A parsing function to convert a raw string value into an enum entry. | | `defaultValue: T` | The default value for this property. | | `description: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html? = null` | An optional string explaining this property's purpose to the agent. | | Returns | |---|---| | `https://developer.android.com/reference/kotlin/androidx/a2ui/compose/runtime/StaticA2uiProperty` | A `https://developer.android.com/reference/kotlin/androidx/a2ui/compose/runtime/StaticA2uiProperty` that resolves to `https://developer.android.com/reference/kotlin/androidx/a2ui/compose/runtime/A2uiProperty.Companion#enum(kotlin.String,kotlin.collections.List,kotlin.Function1,kotlin.Function1,kotlin.Enum,kotlin.String)` at runtime. | ### enum ``` fun > enum(     key: String,     enumValues: List,     mapToString: (T) -> String,     convertFromString: (String) -> T?,     required: Boolean = false,     description: String? = null ): StaticA2uiProperty ``` Creates a static property expecting an enum value strictly bounded to a predefined list of enum options with the ability to map values to custom types to support statically typed enums. | Parameters | |---|---| | `key: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` | The key for this property. | | `enumValues: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-list/index.html` | A list of valid enum values the agent is allowed to supply for this property. | | `mapToString: (T) -> https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` | A mapping function to serialize an enum entry into its string schema value. | | `convertFromString: (https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html) -> T?` | A parsing function to convert a raw string value into an enum entry. | | `required: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html = false` | Whether the agent must provide this property to successfully render the component. | | `description: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html? = null` | An optional string explaining this property's purpose to the agent. | | Returns | |---|---| | `https://developer.android.com/reference/kotlin/androidx/a2ui/compose/runtime/StaticA2uiProperty` | A `https://developer.android.com/reference/kotlin/androidx/a2ui/compose/runtime/StaticA2uiProperty` that resolves to `https://developer.android.com/reference/kotlin/androidx/a2ui/compose/runtime/A2uiProperty.Companion#enum(kotlin.String,kotlin.collections.List,kotlin.Function1,kotlin.Function1,kotlin.Boolean,kotlin.String)` at runtime. | ### nested ``` fun nested(     key: String,     properties: List>,     required: Boolean = false,     description: String? = null,     isAdditionalPropertiesAllowed: Boolean = true,     additionalPropertiesSchema: A2uiSchema? = null ): StaticA2uiProperty ``` Creates a static property representing a nested property object. | Parameters | |---|---| | `key: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` | The key for this property. | | `properties: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-list/index.html>` | A list of typed properties defining the nested object. | | `required: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html = false` | Whether the agent must provide this property. | | `description: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html? = null` | An optional string explaining this property's purpose. | | `isAdditionalPropertiesAllowed: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html = true` | Whether properties not explicitly listed in `https://developer.android.com/reference/kotlin/androidx/a2ui/compose/runtime/A2uiProperty.Companion#nested(kotlin.String,kotlin.collections.List,kotlin.Boolean,kotlin.String,kotlin.Boolean,androidx.a2ui.model.schema.A2uiSchema)` are allowed, defaults to true. | | `additionalPropertiesSchema: https://developer.android.com/reference/kotlin/androidx/a2ui/model/schema/A2uiSchema? = null` | Schema definition for additional dynamic properties, only applicable if `https://developer.android.com/reference/kotlin/androidx/a2ui/compose/runtime/A2uiProperty.Companion#nested(kotlin.String,kotlin.collections.List,kotlin.Boolean,kotlin.String,kotlin.Boolean,androidx.a2ui.model.schema.A2uiSchema)` is true. | | Returns | |---|---| | `https://developer.android.com/reference/kotlin/androidx/a2ui/compose/runtime/StaticA2uiProperty` | A `https://developer.android.com/reference/kotlin/androidx/a2ui/compose/runtime/StaticA2uiProperty` resolving to `https://developer.android.com/reference/kotlin/androidx/a2ui/compose/runtime/A2uiComponentProperties` at runtime. | ### nestedList ``` fun nestedList(     key: String,     properties: List>,     required: Boolean = false,     description: String? = null,     minItems: @IntRange(from = 0) Int = 0,     maxItems: @IntRange(from = 0) Int = Int.MAX_VALUE,     isAdditionalPropertiesAllowed: Boolean = true,     additionalPropertiesSchema: A2uiSchema? = null ): StaticA2uiProperty> ``` Creates a static property representing an list of nested property objects. | Parameters | |---|---| | `key: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` | The key for this property. | | `properties: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-list/index.html>` | A list of typed properties defining the structure of the list items. | | `required: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html = false` | Whether the agent must provide this property. | | `description: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html? = null` | An optional string explaining this property's purpose. | | `minItems: @https://developer.android.com/reference/kotlin/androidx/annotation/IntRange(from = 0) https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html = 0` | The minimum number of items required in the list, defaults to 0. | | `maxItems: @https://developer.android.com/reference/kotlin/androidx/annotation/IntRange(from = 0) https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html = Int.MAX_VALUE` | The maximum number of items allowed in the list, defaults to `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/-companion/-m-a-x_-v-a-l-u-e.html` meaning no constraint. | | `isAdditionalPropertiesAllowed: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html = true` | Whether properties not explicitly listed in `https://developer.android.com/reference/kotlin/androidx/a2ui/compose/runtime/A2uiProperty.Companion#nestedList(kotlin.String,kotlin.collections.List,kotlin.Boolean,kotlin.String,kotlin.Int,kotlin.Int,kotlin.Boolean,androidx.a2ui.model.schema.A2uiSchema)` are allowed, defaults to true. | | `additionalPropertiesSchema: https://developer.android.com/reference/kotlin/androidx/a2ui/model/schema/A2uiSchema? = null` | Schema definition for additional dynamic properties, only applicable if `https://developer.android.com/reference/kotlin/androidx/a2ui/compose/runtime/A2uiProperty.Companion#nestedList(kotlin.String,kotlin.collections.List,kotlin.Boolean,kotlin.String,kotlin.Int,kotlin.Int,kotlin.Boolean,androidx.a2ui.model.schema.A2uiSchema)` is true. | | Returns | |---|---| | `https://developer.android.com/reference/kotlin/androidx/a2ui/compose/runtime/StaticA2uiProperty>` | A `https://developer.android.com/reference/kotlin/androidx/a2ui/compose/runtime/StaticA2uiProperty` resolving to a List of `https://developer.android.com/reference/kotlin/androidx/a2ui/compose/runtime/A2uiComponentProperties` at runtime. | | Throws | |---|---| | `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-illegal-argument-exception/index.html` | If `https://developer.android.com/reference/kotlin/androidx/a2ui/compose/runtime/A2uiProperty.Companion#nestedList(kotlin.String,kotlin.collections.List,kotlin.Boolean,kotlin.String,kotlin.Int,kotlin.Int,kotlin.Boolean,androidx.a2ui.model.schema.A2uiSchema)` or `https://developer.android.com/reference/kotlin/androidx/a2ui/compose/runtime/A2uiProperty.Companion#nestedList(kotlin.String,kotlin.collections.List,kotlin.Boolean,kotlin.String,kotlin.Int,kotlin.Int,kotlin.Boolean,androidx.a2ui.model.schema.A2uiSchema)` is negative, or if `https://developer.android.com/reference/kotlin/androidx/a2ui/compose/runtime/A2uiProperty.Companion#nestedList(kotlin.String,kotlin.collections.List,kotlin.Boolean,kotlin.String,kotlin.Int,kotlin.Int,kotlin.Boolean,androidx.a2ui.model.schema.A2uiSchema)` is greater than `https://developer.android.com/reference/kotlin/androidx/a2ui/compose/runtime/A2uiProperty.Companion#nestedList(kotlin.String,kotlin.collections.List,kotlin.Boolean,kotlin.String,kotlin.Int,kotlin.Int,kotlin.Boolean,androidx.a2ui.model.schema.A2uiSchema)`. | ### number Added in [1.0.0-alpha02](https://developer.android.com/jetpack/androidx/releases/a2ui-compose#1.0.0-alpha02) ``` fun number(key: String, defaultValue: Double, description: String? = null): StaticA2uiProperty ``` Creates an optional static property expecting a literal numeric value with a double default value. | Parameters | |---|---| | `key: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` | The key for this property. | | `defaultValue: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-double/index.html` | The default value for this property. | | `description: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html? = null` | An optional string explaining this property's purpose to the agent. | | Returns | |---|---| | `https://developer.android.com/reference/kotlin/androidx/a2ui/compose/runtime/StaticA2uiProperty` | A `https://developer.android.com/reference/kotlin/androidx/a2ui/compose/runtime/StaticA2uiProperty` that resolves to a `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-number/index.html` at runtime. | ### number Added in [1.0.0-alpha02](https://developer.android.com/jetpack/androidx/releases/a2ui-compose#1.0.0-alpha02) ``` fun number(key: String, defaultValue: Float, description: String? = null): StaticA2uiProperty ``` Creates an optional static property expecting a literal numeric value with a float default value. | Parameters | |---|---| | `key: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` | The key for this property. | | `defaultValue: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html` | The default value for this property. | | `description: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html? = null` | An optional string explaining this property's purpose to the agent. | | Returns | |---|---| | `https://developer.android.com/reference/kotlin/androidx/a2ui/compose/runtime/StaticA2uiProperty` | A `https://developer.android.com/reference/kotlin/androidx/a2ui/compose/runtime/StaticA2uiProperty` that resolves to a `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-number/index.html` at runtime. | ### number Added in [1.0.0-alpha02](https://developer.android.com/jetpack/androidx/releases/a2ui-compose#1.0.0-alpha02) ``` fun number(key: String, defaultValue: Int, description: String? = null): StaticA2uiProperty ``` Creates an optional static property expecting a literal numeric value with an integer default value. | Parameters | |---|---| | `key: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` | The key for this property. | | `defaultValue: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | The default value for this property. | | `description: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html? = null` | An optional string explaining this property's purpose to the agent. | | Returns | |---|---| | `https://developer.android.com/reference/kotlin/androidx/a2ui/compose/runtime/StaticA2uiProperty` | A `https://developer.android.com/reference/kotlin/androidx/a2ui/compose/runtime/StaticA2uiProperty` that resolves to a `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-number/index.html` at runtime. | ### number Added in [1.0.0-alpha02](https://developer.android.com/jetpack/androidx/releases/a2ui-compose#1.0.0-alpha02) ``` fun number(key: String, defaultValue: Long, description: String? = null): StaticA2uiProperty ``` Creates an optional static property expecting a literal numeric value with a long default value. | Parameters | |---|---| | `key: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` | The key for this property. | | `defaultValue: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-long/index.html` | The default value for this property. | | `description: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html? = null` | An optional string explaining this property's purpose to the agent. | | Returns | |---|---| | `https://developer.android.com/reference/kotlin/androidx/a2ui/compose/runtime/StaticA2uiProperty` | A `https://developer.android.com/reference/kotlin/androidx/a2ui/compose/runtime/StaticA2uiProperty` that resolves to a `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-number/index.html` at runtime. | ### number Added in [1.0.0-alpha02](https://developer.android.com/jetpack/androidx/releases/a2ui-compose#1.0.0-alpha02) ``` fun number(key: String, required: Boolean = false, description: String? = null): StaticA2uiProperty ``` Creates a static property expecting a literal numeric value. | Parameters | |---|---| | `key: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` | The key for this property. | | `required: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html = false` | Whether the agent must provide this property to successfully render the component. | | `description: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html? = null` | An optional string explaining this property's purpose to the agent. | | Returns | |---|---| | `https://developer.android.com/reference/kotlin/androidx/a2ui/compose/runtime/StaticA2uiProperty` | A `https://developer.android.com/reference/kotlin/androidx/a2ui/compose/runtime/StaticA2uiProperty` that resolves to a `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-number/index.html` at runtime. | ### numberEnum Added in [1.0.0-alpha02](https://developer.android.com/jetpack/androidx/releases/a2ui-compose#1.0.0-alpha02) ``` fun numberEnum(     key: String,     enumValues: DoubleList,     defaultValue: Double,     description: String? = null ): StaticA2uiProperty ``` Creates an optional static property expecting a double value strictly bounded to a predefined list of options with a specified default value. | Parameters | |---|---| | `key: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` | The key for this property. | | `enumValues: https://developer.android.com/reference/kotlin/androidx/collection/DoubleList` | A list of valid double values the agent is allowed to supply for this property. | | `defaultValue: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-double/index.html` | The default value for this property. | | `description: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html? = null` | An optional string explaining this property's purpose to the agent. | | Returns | |---|---| | `https://developer.android.com/reference/kotlin/androidx/a2ui/compose/runtime/StaticA2uiProperty` | A `https://developer.android.com/reference/kotlin/androidx/a2ui/compose/runtime/StaticA2uiProperty` that resolves to a `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-number/index.html` at runtime. | ### numberEnum Added in [1.0.0-alpha02](https://developer.android.com/jetpack/androidx/releases/a2ui-compose#1.0.0-alpha02) ``` fun numberEnum(     key: String,     enumValues: FloatList,     defaultValue: Float,     description: String? = null ): StaticA2uiProperty ``` Creates an optional static property expecting a float value strictly bounded to a predefined list of options with a specified default value. | Parameters | |---|---| | `key: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` | The key for this property. | | `enumValues: https://developer.android.com/reference/kotlin/androidx/collection/FloatList` | A list of valid float values the agent is allowed to supply for this property. | | `defaultValue: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html` | The default value for this property. | | `description: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html? = null` | An optional string explaining this property's purpose to the agent. | | Returns | |---|---| | `https://developer.android.com/reference/kotlin/androidx/a2ui/compose/runtime/StaticA2uiProperty` | A `https://developer.android.com/reference/kotlin/androidx/a2ui/compose/runtime/StaticA2uiProperty` that resolves to a `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-number/index.html` at runtime. | ### numberEnum Added in [1.0.0-alpha02](https://developer.android.com/jetpack/androidx/releases/a2ui-compose#1.0.0-alpha02) ``` fun numberEnum(     key: String,     enumValues: IntList,     defaultValue: Int,     description: String? = null ): StaticA2uiProperty ``` Creates an optional static property expecting an integer value strictly bounded to a predefined list of options with a specified default value. | Parameters | |---|---| | `key: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` | The key for this property. | | `enumValues: https://developer.android.com/reference/kotlin/androidx/collection/IntList` | A list of valid integer values the agent is allowed to supply for this property. | | `defaultValue: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | The default value for this property. | | `description: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html? = null` | An optional string explaining this property's purpose to the agent. | | Returns | |---|---| | `https://developer.android.com/reference/kotlin/androidx/a2ui/compose/runtime/StaticA2uiProperty` | A `https://developer.android.com/reference/kotlin/androidx/a2ui/compose/runtime/StaticA2uiProperty` that resolves to a `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-number/index.html` at runtime. | ### numberEnum ``` fun numberEnum(     key: String,     enumValues: List,     required: Boolean = false,     description: String? = null ): StaticA2uiProperty ``` Creates a static property expecting a number value strictly bounded to a predefined list of options. | Parameters | |---|---| | `key: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` | The key for this property. | | `enumValues: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-list/index.html` | A list of valid number values the agent is allowed to supply for this property. | | `required: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html = false` | Whether the agent must provide this property to successfully render the component. | | `description: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html? = null` | An optional string explaining this property's purpose to the agent. | | Returns | |---|---| | `https://developer.android.com/reference/kotlin/androidx/a2ui/compose/runtime/StaticA2uiProperty` | A `https://developer.android.com/reference/kotlin/androidx/a2ui/compose/runtime/StaticA2uiProperty` that resolves to a `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-number/index.html` at runtime. | ### numberEnum Added in [1.0.0-alpha02](https://developer.android.com/jetpack/androidx/releases/a2ui-compose#1.0.0-alpha02) ``` fun numberEnum(     key: String,     enumValues: LongList,     defaultValue: Long,     description: String? = null ): StaticA2uiProperty ``` Creates an optional static property expecting a long value strictly bounded to a predefined list of options with a specified default value. | Parameters | |---|---| | `key: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` | The key for this property. | | `enumValues: https://developer.android.com/reference/kotlin/androidx/collection/LongList` | A list of valid long values the agent is allowed to supply for this property. | | `defaultValue: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-long/index.html` | The default value for this property. | | `description: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html? = null` | An optional string explaining this property's purpose to the agent. | | Returns | |---|---| | `https://developer.android.com/reference/kotlin/androidx/a2ui/compose/runtime/StaticA2uiProperty` | A `https://developer.android.com/reference/kotlin/androidx/a2ui/compose/runtime/StaticA2uiProperty` that resolves to a `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-number/index.html` at runtime. | ### numberList Added in [1.0.0-alpha02](https://developer.android.com/jetpack/androidx/releases/a2ui-compose#1.0.0-alpha02) ``` fun numberList(     key: String,     required: Boolean = false,     description: String? = null,     minItems: @IntRange(from = 0) Int = 0,     maxItems: @IntRange(from = 0) Int = Int.MAX_VALUE ): StaticA2uiProperty> ``` Creates a static property expecting a list of numbers. | Parameters | |---|---| | `key: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` | The key for this property. | | `required: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html = false` | Whether the agent must provide this property to successfully render the component. | | `description: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html? = null` | An optional string explaining this property's purpose to the agent. | | `minItems: @https://developer.android.com/reference/kotlin/androidx/annotation/IntRange(from = 0) https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html = 0` | The minimum number of items required in the list, defaults to 0. | | `maxItems: @https://developer.android.com/reference/kotlin/androidx/annotation/IntRange(from = 0) https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html = Int.MAX_VALUE` | The maximum number of items allowed in the list, defaults to `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/-companion/-m-a-x_-v-a-l-u-e.html` meaning no constraint. | | Returns | |---|---| | `https://developer.android.com/reference/kotlin/androidx/a2ui/compose/runtime/StaticA2uiProperty>` | A `https://developer.android.com/reference/kotlin/androidx/a2ui/compose/runtime/StaticA2uiProperty` that resolves to a `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-list/index.html` of `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-number/index.html` at runtime. | | Throws | |---|---| | `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-illegal-argument-exception/index.html` | If `https://developer.android.com/reference/kotlin/androidx/a2ui/compose/runtime/A2uiProperty.Companion#numberList(kotlin.String,kotlin.Boolean,kotlin.String,kotlin.Int,kotlin.Int)` or `https://developer.android.com/reference/kotlin/androidx/a2ui/compose/runtime/A2uiProperty.Companion#numberList(kotlin.String,kotlin.Boolean,kotlin.String,kotlin.Int,kotlin.Int)` is negative, or if `https://developer.android.com/reference/kotlin/androidx/a2ui/compose/runtime/A2uiProperty.Companion#numberList(kotlin.String,kotlin.Boolean,kotlin.String,kotlin.Int,kotlin.Int)` is greater than `https://developer.android.com/reference/kotlin/androidx/a2ui/compose/runtime/A2uiProperty.Companion#numberList(kotlin.String,kotlin.Boolean,kotlin.String,kotlin.Int,kotlin.Int)`. | ### string Added in [1.0.0-alpha02](https://developer.android.com/jetpack/androidx/releases/a2ui-compose#1.0.0-alpha02) ``` fun string(key: String, required: Boolean = false, description: String? = null): StaticA2uiProperty ``` Creates a static property expecting a literal string value. | Parameters | |---|---| | `key: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` | The key for this property. | | `required: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html = false` | Whether the agent must provide this property to successfully render the component. | | `description: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html? = null` | An optional string explaining this property's purpose to the agent. | | Returns | |---|---| | `https://developer.android.com/reference/kotlin/androidx/a2ui/compose/runtime/StaticA2uiProperty` | A `https://developer.android.com/reference/kotlin/androidx/a2ui/compose/runtime/StaticA2uiProperty` that resolves to a `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` at runtime. | ### stringEnum Added in [1.0.0-alpha02](https://developer.android.com/jetpack/androidx/releases/a2ui-compose#1.0.0-alpha02) ``` fun stringEnum(     key: String,     enumValues: List,     defaultValue: String,     description: String? = null ): StaticA2uiProperty ``` Creates an optional static property expecting a string value strictly bounded to a predefined list of options with a default value. | Parameters | |---|---| | `key: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` | The key for this property. | | `enumValues: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-list/index.html` | A list of valid string values the agent is allowed to supply for this property. | | `defaultValue: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` | The default value for this property. | | `description: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html? = null` | An optional string explaining this property's purpose to the agent. | | Returns | |---|---| | `https://developer.android.com/reference/kotlin/androidx/a2ui/compose/runtime/StaticA2uiProperty` | A `https://developer.android.com/reference/kotlin/androidx/a2ui/compose/runtime/StaticA2uiProperty` that resolves to a `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` at runtime. | ### stringEnum Added in [1.0.0-alpha02](https://developer.android.com/jetpack/androidx/releases/a2ui-compose#1.0.0-alpha02) ``` fun stringEnum(     key: String,     enumValues: List,     required: Boolean = false,     description: String? = null ): StaticA2uiProperty ``` Creates a static property expecting a string value strictly bounded to a predefined list of options. | Parameters | |---|---| | `key: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` | The key for this property. | | `enumValues: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-list/index.html` | A list of valid string values the agent is allowed to supply for this property. | | `required: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html = false` | Whether the agent must provide this property to successfully render the component. | | `description: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html? = null` | An optional string explaining this property's purpose to the agent. | | Returns | |---|---| | `https://developer.android.com/reference/kotlin/androidx/a2ui/compose/runtime/StaticA2uiProperty` | A `https://developer.android.com/reference/kotlin/androidx/a2ui/compose/runtime/StaticA2uiProperty` that resolves to a `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` at runtime. | ### stringList Added in [1.0.0-alpha02](https://developer.android.com/jetpack/androidx/releases/a2ui-compose#1.0.0-alpha02) ``` fun stringList(     key: String,     required: Boolean = false,     description: String? = null,     minItems: @IntRange(from = 0) Int = 0,     maxItems: @IntRange(from = 0) Int = Int.MAX_VALUE ): StaticA2uiProperty> ``` Creates a static property expecting a list of strings. | Parameters | |---|---| | `key: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` | The key for this property. | | `required: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html = false` | Whether the agent must provide this property to successfully render the component. | | `description: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html? = null` | An optional string explaining this property's purpose to the agent. | | `minItems: @https://developer.android.com/reference/kotlin/androidx/annotation/IntRange(from = 0) https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html = 0` | The minimum number of items required in the list, defaults to 0. | | `maxItems: @https://developer.android.com/reference/kotlin/androidx/annotation/IntRange(from = 0) https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html = Int.MAX_VALUE` | The maximum number of items allowed in the list, defaults to `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/-companion/-m-a-x_-v-a-l-u-e.html` meaning no constraint. | | Returns | |---|---| | `https://developer.android.com/reference/kotlin/androidx/a2ui/compose/runtime/StaticA2uiProperty>` | A `https://developer.android.com/reference/kotlin/androidx/a2ui/compose/runtime/StaticA2uiProperty` that resolves to a `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-list/index.html` of `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` at runtime. | | Throws | |---|---| | `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-illegal-argument-exception/index.html` | If `https://developer.android.com/reference/kotlin/androidx/a2ui/compose/runtime/A2uiProperty.Companion#stringList(kotlin.String,kotlin.Boolean,kotlin.String,kotlin.Int,kotlin.Int)` or `https://developer.android.com/reference/kotlin/androidx/a2ui/compose/runtime/A2uiProperty.Companion#stringList(kotlin.String,kotlin.Boolean,kotlin.String,kotlin.Int,kotlin.Int)` is negative, or if `https://developer.android.com/reference/kotlin/androidx/a2ui/compose/runtime/A2uiProperty.Companion#stringList(kotlin.String,kotlin.Boolean,kotlin.String,kotlin.Int,kotlin.Int)` is greater than `https://developer.android.com/reference/kotlin/androidx/a2ui/compose/runtime/A2uiProperty.Companion#stringList(kotlin.String,kotlin.Boolean,kotlin.String,kotlin.Int,kotlin.Int)`. | ## Protected constructors ### A2uiProperty ``` protected  A2uiProperty() ``` | Parameters | |---|---| | `` | The expected type of the resolved property value at runtime. | ## Public properties ### isRequired Added in [1.0.0-alpha02](https://developer.android.com/jetpack/androidx/releases/a2ui-compose#1.0.0-alpha02) ``` abstract val isRequired: Boolean ``` Indicates whether the agent is strictly required to provide this property. ### key Added in [1.0.0-alpha02](https://developer.android.com/jetpack/androidx/releases/a2ui-compose#1.0.0-alpha02) ``` abstract val key: String ``` The key of the property as it appears in the A2UI protocol payload. ### schema Added in [1.0.0-alpha02](https://developer.android.com/jetpack/androidx/releases/a2ui-compose#1.0.0-alpha02) ``` abstract val schema: A2uiSchema ``` The underlying `https://developer.android.com/reference/kotlin/androidx/a2ui/model/schema/A2uiSchema` definition describing this property to the agent.