From Bright Pattern Documentation
< 5.19:Embedded-agent-desktop-api-specification‎ | Methods
Revision as of 04:02, 29 May 2024 by BpDeeplTranslateMaintenance (talk | contribs) (Updated via BpDeleteTranslateTags script)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search
• 5.19 • 5.3 • 5.8


terminateInteraction

Ends the interaction immediately.

See the Embedded Agent Desktop Specification's Use Cases section for ways to use this method.

Request

Syntax

window.bpspat.api.terminateInteraction(item_id)

Parameters

Parameter Type Optional/Required Description Example
item_id string required The interaction ID of the interaction "EE55D97E-2705-49D1-A36D-34B3381DD416"

Response

Empty. In response to the request, the interaction ends.

< Previous | Next >