a2ui-core/dev.ynagai.a2ui.core.surface/RendererEffect

RendererEffect

sealed interface RendererEffect

Something the renderer must act on that applying a message did not, and could not, do itself.

Two of the six agent-to-renderer messages do not change surface state at all — they ask the renderer to run a function, or hand back the result of one the renderer asked for. Folding them into state would lose them; dropping them would lose the response the specification says the renderer MUST send. So the fold returns them alongside the new state.

The state-changing messages report an effect too, so that a UI layer can tell what moved without diffing two whole RendererStates.

Inheritors

ComponentsUpdated

DataModelUpdated

RendererFunctionRequested

AgentFunctionResponded

Types

AgentFunctionResponded

data class AgentFunctionResponded(val response: FunctionResponse) : RendererEffect

The agent answered a callAgentFunction the renderer had sent.

ComponentsUpdated

data class ComponentsUpdated(val surfaceId: String, val ids: List<String>) : RendererEffect

Components were added to or replaced in a surface.

DataModelUpdated

data class DataModelUpdated(val surfaceId: String, val path: JsonPointer) : RendererEffect

A surface's data model changed at path.

RendererFunctionRequested

data class RendererFunctionRequested(val functionCallId: CallId, val call: FunctionCall) : RendererEffect

The agent asked the renderer to run call.

data class SurfaceCreated(val surfaceId: String) : RendererEffect

A surface was created. It is not renderable until its root component arrives.

data class SurfaceDeleted(val surfaceId: String) : RendererEffect

A surface was deleted along with its components and data.

Properties

open val surfaceId: String?

The surface this effect concerns, or null for effects that name no surface.