From Bright Pattern Documentation
Jump to: navigation, search
(Created page with "<translate> = Completing and Terminating an Interaction = This method is used for completing and terminating interactions. There are four types of requests. == Requests == ==...")
 
(Updated via BpDeleteTranslateTags script)
 
(7 intermediate revisions by one other user not shown)
Line 1: Line 1:
<translate>
 
= Completing and Terminating an Interaction =
 
This method is used for completing and terminating interactions. There are four types of requests.
 
  
== Requests ==
+
= setDisposition =
=== Set Disposition ===  
+
Sets the disposition of the interaction.
 +
 
 +
== Request ==
 +
=== Syntax ===
 
  window.bpspat.api.setDisposition(item_id, disposition)
 
  window.bpspat.api.setDisposition(item_id, disposition)
  
=== Terminate Interaction ===
+
=== Parameters ===
window.bpspat.api.terminateInteraction(item_id)
+
{|border="1" style="border-collapse:collapse" cellpadding="5"
 
+
| '''Parameter'''
=== Complete Interaction ===
+
| '''Type'''
window.bpspat.api.completeInteraction(item_id)
+
| '''Optional/Required'''
 
+
| '''Description'''
=== Complete Interaction with Disposition ===
+
|-
window.bpspat.api.completeInteractionWithDisp(item_id, disposition, notes)
+
| item_id
 
+
| string
 +
| required
 +
| Specifies the interaction ID of the interaction
 +
|-
 +
| disposition
 +
| string
 +
| required
 +
| Specifies the disposition to be set for the interaction
 +
|}
  
 +
== Response ==
 +
Empty.
  
</translate>
+
In response to the request, the disposition to changed to the specified disposition.

Latest revision as of 04:02, 29 May 2024

• 5.19 • 5.3 • 5.8


setDisposition

Sets the disposition of the interaction.

Request

Syntax

window.bpspat.api.setDisposition(item_id, disposition)

Parameters

Parameter Type Optional/Required Description
item_id string required Specifies the interaction ID of the interaction
disposition string required Specifies the disposition to be set for the interaction

Response

Empty.

In response to the request, the disposition to changed to the specified disposition.

< Previous | Next >