Introduction
Customize Text Message Bubbles
Create a Custom Pre-Chat Form
Send a Message as the End User
Custom Lightning Type APIs for Enhanced Chat v2
Messaging Header Events
Event Listeners
Enhanced Chat API Developer Guide
These are the available actions in the messaging conversation window header.
1/**
2 * Event name for notifying the Embedded Messaging application about
3 * a header's back button click.
4 * @type {string}
5 */
6MESSAGING_EVENT.BACK_BUTTON_CLICK
7
8/**
9 * Event name for minimizing the conversation client.
10 * @type {string}
11 */
12MESSAGING_EVENT.MINIMIZE_BUTTON_CLICK
13
14/**
15 * Event name for closing the conversation.
16 * @type {string}
17 */
18MESSAGING_EVENT.CLOSE_CONVERSATION
19
20/**
21 * Event name for closing the container.
22 * @type {String}
23 */
24MESSAGING_EVENT.CLOSE_CONTAINER
25
26/**
27 * Event name for toggling the display of the back button in the header.
28 * @type {string}
29 */
30MESSAGING_EVENT.TOGGLE_BACK_BUTTON
31
32/**
33 * Event name for notifying the Embedded Messaging application that a
34 * menu item has been selected from the header menu.
35 * @type {string}
36 */
37MESSAGING_EVENT.MENU_ITEM_SELECTED
38
39/**
40 * Event name for indicating that a participant joined.
41 * @type {string}
42 */
43MESSAGING_EVENT.PARTICIPANT_JOINED
44
45/**
46 * Event name for indicating that a participant left.
47 * @type {string}
48 */
49MESSAGING_EVENT.PARTICIPANT_LEFT
50
51/**
52 * Event name for indicating an update to the header text.
53 * @type {string}
54 */
55MESSAGING_EVENT.UPDATE_HEADER_TEXT
56
57/**
58 * Event name for notifying the Embedded Messaging application that the
59 * request transcript has been selected from the header menu.
60 */
61MESSAGING_EVENT.REQUEST_TRANSCRIPT
62
63/**
64 * Event name for indicating that the transfer request is successfully initiated.
65 * @type {string}
66 */
67MESSAGING_EVENT.TRANSFER_INITIATED
68
69/**
70 * Event name for indicating that the transfer request failed or was canceled.
71 * @type {string}
72 */
73MESSAGING_EVENT.TRANSFER_TERMINATED
74
75/**
76 * Event name for indicating that the transfer request is successfully resolved.
77 * @type {string}
78 */
79MESSAGING_EVENT.TRANSFER_COMPLETED
80
81/**
82 * Event name for indicating that a reconnection event is in progress.
83 * @type {string}
84 */
85MESSAGING_EVENT.RECONNECT_IN_PROGRESS
86
87/**
88 * Event name for indicating that a reconnection event ended.
89 * @type {string}
90 */
91MESSAGING_EVENT.RECONNECT_ENDED
92
93/**
94 * Event name for notifying the Embedded Messaging application when the initial SSE ping was missed.
95 * @type {string}
96 */
97MESSAGING_EVENT.SSE_INITIAL_PING_TIMEOUT
98
99/**
100 * Event name for notifying the Embedded Messaging application when the SSE ping at regular intervals was missed.
101 * @type {string}
102 */
103MESSAGING_EVENT.SSE_PING_TIMEOUT
104
105/**
106 * Event name for shifting focus to the first focusable element in the chat header when navigating with the tab key.
107 * @type {string}
108 */
109MESSAGING_EVENT.TAB_FOCUS_ON_FIRST_FOCUSABLE_ELEMENT