sdk/com.nagra.opentvsdk.a2a/A2aEvent

A2aEvent

sealed class A2aEvent

A typed piece of a server response. A response envelope can produce several events; they arrive in the order the server sent them. Every event carries the ids of its task and conversation (empty when the envelope had none).

Artifact events come from the action in Artifact.metadata["action"]; see ArtifactAction. DeviceActionEvent marks the events after which the server pauses the task until the client reports the outcome.

Inheritors

Types

ChatText

data class ChatText(val taskId: String, val contextId: String, val artifactId: String, val text: String, val append: Boolean, val lastChunk: Boolean) : A2aEvent

A piece of the agent's prose (PRESENT_MESSAGE). See ChatTextAssembler to join chunks.

DeviceActionEvent

sealed class DeviceActionEvent : A2aEvent

Events for actions the client carries out on the device. The server pauses the task after them and waits for A2aSession.sendActionResult.

DisplayContentDetails

data class DisplayContentDetails(val taskId: String, val contextId: String, val details: ContentDetails, val artifactId: String = "") : A2aEvent.DeviceActionEvent

DISPLAY_CONTENT_DETAILS: show the details of one title. Report DISPLAYED (or ERROR when it cannot be shown) with A2aSession.sendActionResult; the acknowledgement must not dismiss the details.

Favourited

data class Favourited(val taskId: String, val contextId: String) : A2aEvent

FAVOURITED: signal only. The server does not emit it yet.

PausePlayback

data class PausePlayback(val taskId: String, val contextId: String, val artifactId: String = "") : A2aEvent.DeviceActionEvent

PAUSE: pause the current playback.

PowerOff

data class PowerOff(val taskId: String, val contextId: String, val artifactId: String = "") : A2aEvent.DeviceActionEvent

POWER_OFF: power the device off.

PowerOn

data class PowerOn(val taskId: String, val contextId: String, val artifactId: String = "") : A2aEvent.DeviceActionEvent

POWER_ON: power the device on.

Recording

data class Recording(val taskId: String, val contextId: String) : A2aEvent

RECORDING: signal only. The server does not emit it yet.

RenderContent

data class RenderContent(val taskId: String, val contextId: String, val artifactId: String, val artifactName: String, val rail: ContentRail) : A2aEvent

A rail of content to render (DISPLAY_CONTENT).

ResumePlayback

data class ResumePlayback(val taskId: String, val contextId: String, val artifactId: String = "") : A2aEvent.DeviceActionEvent

RESUME: resume the paused playback.

StartPlayback

data class StartPlayback(val taskId: String, val contextId: String, val contentId: String, val artifactId: String = "") : A2aEvent.DeviceActionEvent

PLAYBACK: play contentId on the device.

TaskStatus

data class TaskStatus(val taskId: String, val contextId: String, val state: A2aTaskState, val timestampMillis: Long?) : A2aEvent

Lifecycle change. INPUT_REQUIRED follows an action that awaits the client.

Unknown

data class Unknown(val taskId: String, val contextId: String, val reason: String, val data: Any?) : A2aEvent

A payload that could not be understood (no action, or a required field missing).

VolumeDown

data class VolumeDown(val taskId: String, val contextId: String, val artifactId: String = "") : A2aEvent.DeviceActionEvent

VOLUME_DOWN: lower the volume.

VolumeUp

data class VolumeUp(val taskId: String, val contextId: String, val artifactId: String = "") : A2aEvent.DeviceActionEvent

VOLUME_UP: raise the volume.

Properties

contextId

abstract val contextId: String

taskId

abstract val taskId: String