From Bright Pattern Documentation
< 5.3:Embedded-agent-desktop-api-specification‎ | Methods
Revision as of 04:09, 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


setDispositionByName

Sets the disposition of the interaction using the disposition name. (To set disposition by code, see method setDisposition).

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

Request

Syntax

window.bpspat.api.setDispositionByName(item_id, disposition_name)

Parameters

Parameter Type Optional/Required Description Example
item_id string required The interaction ID of the interaction "EE55D97E-2705-49D1-A36D-34B3381DD416"
disposition_name string required The disposition name to be set for the interaction "Offer rejected"

Response

Empty. In response to the request, the disposition is changed to the specified disposition name.

< Previous | Next >