A2uiCoreComponentDefinition
public interface A2uiCoreComponentDefinition
Defines a single UI component and its schema.
Summary
Public methods |
|
|---|---|
abstract @NonNull String |
Describes the component behavior so the AI agent knows when to use it. |
abstract @NonNull String |
getName()Component name that would be provided to the AI agent. |
abstract @NonNull A2uiSchema |
The schema of the properties of the component. |
Extension functions |
|
|---|---|
default final @NonNull A2uiSchema |
Converts this component definition into an |
Public methods
getDescription
Added in 1.0.0-alpha01
abstract @NonNull String getDescription()
Describes the component behavior so the AI agent knows when to use it.
getName
Added in 1.0.0-alpha01
abstract @NonNull String getName()
Component name that would be provided to the AI agent.
getPropertySchema
Added in 1.0.0-alpha01
abstract @NonNull A2uiSchema getPropertySchema()
The schema of the properties of the component.
Extension functions
A2uiCoreComponentDefinitionKt.toSchema
Artifact: androidx.a2ui:a2ui-engine
default final @NonNull A2uiSchema A2uiCoreComponentDefinitionKt.toSchema(
@NonNull A2uiCoreComponentDefinition receiver
)
Converts this component definition into an A2uiSchema.
| Returns | |
|---|---|
@NonNull A2uiSchema |
the |