arcgis-assistant-interrupt | References | ArcGIS Maps SDK for JavaScript

ESM

import "@arcgis/ai-components/components/arcgis-assistant-interrupt";

Inheritance: ArcgisAssistantInterrupt→HTMLElement

Renders interrupt prompts for extra user input. Use it when an agent pauses for confirmation, choice, or text input. Offers interrupt-specific input modes and submit or cancel event handling.

Properties

Property	Attribute	Type
message	message	string \| undefined
options		string[] \| undefined
type	type	"boolean-choice" \| "multi-select" \| "single-select" \| "text-input"

message

Property

Type: string | undefined

Attribute: message

options

Property

Type: string[] | undefined

type

Property

Type: "boolean-choice" | "multi-select" | "single-select" | "text-input"

Attribute: type

Methods

Method	Signature
componentOnReady inherited	componentOnReady(): Promise<this>

componentOnReady

inherited Method

Signature: componentOnReady (): Promise<this>

Inherited from: this

Creates a promise that resolves once the component is fully loaded.

Returns: Promise<this>

Example

const arcgisAssistantInterrupt = document.createElement("arcgis-assistant-interrupt");
document.body.append(arcgisAssistantInterrupt);
await arcgisAssistantInterrupt.componentOnReady();
console.log("arcgis-assistant-interrupt is ready to go!");

Events

Name	Type
arcgisCancel	CustomEvent<void>
arcgisSubmit	CustomEvent<string[] \| boolean \| string>

arcgisCancel

Event

arcgisCancel: CustomEvent<void>

arcgisSubmit

Event

arcgisSubmit: CustomEvent<string[] | boolean | string>