Events that a host website can listen to. This is kept separate from WidgetEvents definitions in order to avoid any coupling of internal types to what we expose to the host.
- on-agent-assigned
- on-agent-unassigned
- on-conversation-ended
- on-conversation-started
- on-message-added
- on-user-identity-changed
- on-user-purged
- on-view-changed
- on-widget-focus-changed
- on-widget-open-changed
- on-shutdown-completed
- on-backend-error
- on-api-ready
• on-agent-assigned: Agent
• on-agent-unassigned: Agent
• on-conversation-ended: Object
| Name | Type |
|---|---|
conversationId | string |
• on-conversation-started: Object
| Name | Type |
|---|---|
conversationId | string |
• on-message-added: ReceivableMessages | SendableMessages
• on-user-identity-changed: 'anonymous' | 'claim' | 'verified'
For more details see Actors
• on-user-purged: void
• on-view-changed:
'MainView' |
'CreateNewConversation' |
'Conversation' |
'PreviousConversations' |
'BulletinItemModal' |
'KnowledgeBase' |
'KnowledgeBaseArticle' |
'IdentityClaimModal' |
'EndConversationModal';• on-widget-focus-changed: "focused" | "blurred"
• on-widget-open-changed: boolean
true represents the widget getting open, false represents the widget getting closed.
• on-shutdown-completed: void
Needed for when you need to restart the widget after it has been shutdown.
• on-backend-error: BackendError
Used to listen to errors that are returned from the backend in response to a command.
• on-api-ready: void
Used to listen to when the _dixa_.api is ready to be used. You can use this event to start using the promise-based API.