Skip to content

AssistantAction

AssistantAction = object

Defined in: packages/schema/src/assistant/protocol.ts:9

A button on a card. Clicking it posts { partId, actionId }; with confirm, only after the user confirms that text.

optional confirm?: string

Defined in: packages/schema/src/assistant/protocol.ts:21

A question the user confirms before the click is posted, such as Run this update?.


optional disabled?: boolean

Defined in: packages/schema/src/assistant/protocol.ts:17

Shown but not clickable.


optional hint?: string

Defined in: packages/schema/src/assistant/protocol.ts:19

A line under the buttons, such as why one is disabled.


id: string

Defined in: packages/schema/src/assistant/protocol.ts:11

What the click posts as actionId, unique on its card.


label: string

Defined in: packages/schema/src/assistant/protocol.ts:13

The button’s text.


optional style?: "primary" | "secondary" | "ghost" | "danger"

Defined in: packages/schema/src/assistant/protocol.ts:15

How the button looks; secondary when omitted.