From Bright Pattern Documentation
(Created page with "<translate> = terminateInteraction = Terminates the interaction. == Request == === Syntax === window.bpspat.api.terminateInteraction(item_id) === Parameters === {|border="1...") |
(Updated via BpDeleteTranslateTags script) |
||
| (3 intermediate revisions by one other user not shown) | |||
| Line 1: | Line 1: | ||
| − | + | ||
= terminateInteraction = | = terminateInteraction = | ||
| − | + | Ends the interaction immediately. | |
| + | |||
| + | See the Embedded Agent Desktop Specification's [[Embedded-agent-desktop-sdk-specification/UseCases/EndDispositionComplete | Use Cases]] section for ways to use this method. | ||
== Request == | == Request == | ||
| Line 13: | Line 15: | ||
| '''Optional/Required''' | | '''Optional/Required''' | ||
| '''Description''' | | '''Description''' | ||
| + | | '''Example''' | ||
|- | |- | ||
| item_id | | item_id | ||
| string | | string | ||
| required | | required | ||
| − | | | + | | The interaction ID of the interaction |
| + | | "EE55D97E-2705-49D1-A36D-34B3381DD416" | ||
|} | |} | ||
== Response == | == Response == | ||
| − | Empty. | + | Empty. In response to the request, the interaction ends. |
| − | |||
| − | In response to the request, the interaction ends. | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
Latest revision as of 04:02, 29 May 2024
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.