androidx.a2ui.model.protocol


Interfaces

A2uiClientToServerMessage

The unified interface for all messages sent from the A2UI client to the A2A server.

A2uiExecutionContext

Provides environment access, dynamic payload evaluation, and function execution capabilities within the scope of a specific component.

A2uiInlineCatalog

Represents an inline catalog that can be advertised inside A2uiClientCapabilities.

A2uiServerToClientMessage

The unified interface for all messages sent from the A2A server to the A2UI client.

A2uiUserAction

Defines an A2UI component user interaction.

Classes

A2uiClientCapabilities

Represents the client capabilities advertisement sent to the agent during system initialization.

A2uiClientDataModel

Represents the client data model synchronization payload sent to the agent.

A2uiClientErrorMessage

Represents a client-side execution or validation error reported to the server.

A2uiClientEventMessage

Represents a client event message to be sent to the server.

A2uiComponentPayload

Represents a single UI component's payload.

A2uiCreateSurfaceMessage

Creates a new surface instance on the client.

A2uiDataPath

Parses JSON pointer strings (RFC 6901) into segments.

A2uiDeleteSurfaceMessage

Destroys an existing surface and frees its associated resources.

A2uiEventAction

Defines an event action triggered by a user interaction to be sent to the server.

A2uiFunctionCallAction

Defines a local component function execution action triggered by a user interaction.

A2uiUpdateComponentsMessage

Updates or replaces components in the surface's registry, which can include modifying static component properties (e.g., text, colors) or changing structural layout templates.

A2uiUpdateDataModelMessage

Updates the data model of a surface.

A2uiProtocolConstants

Common constants used across the A2UI protocol data models.

Exceptions

A2uiException

Base class for all A2UI protocol and execution errors.

A2uiException.A2uiRuntimeException

Thrown for any client-side runtime or execution failures (such as dynamic binding or function evaluation failures) that should be reported to the agent and are not structural validation errors

A2uiException.A2uiValidationException

Thrown when an incoming JSON payload from the server structurally violates its defined A2uiSchema.