ask

nanorep.floatingWidget.on('ask', function(query) {})

Called after user asked something inside the widget (search and conversational modes)

Arguments

query: String Search query

noResults

nanorep.floatingWidget.on('noResults', function(query) {})

Called when there are no search results (search mode only)

Arguments

query: String Search query

searchResults

nanorep.floatingWidget.on('searchResults', function(results, query) {})

Called on incoming search results and when there's no search results as well (search mode only)

Arguments

results: Array Array of results
query: String Search query

escalate

nanorep.floatingWidget.on('escalate', function(channel, answer) {})

Called when user initiated escalation using channeling buttons (search mode only)

Arguments

channel: Object Channel that was escalated
answer: Object Answer of channel

feedback

nanorep.floatingWidget.on('feedback', function(feedbackInfo, answer) {})

Called after user feedback action. Feedback info object contains something like: { positive: false, type: 4, text: '' }. (search mode only)

Arguments

feedbackInfo: Object Object with feedback information
answer: Object Answer object

showAnswer

nanorep.floatingWidget.on('showAnswer', function(answer) {})

Called when answer becomes visible (search mode only)

Arguments

answer: Object

toggleAnswer

nanorep.floatingWidget.on('toggleAnswer', function(answer, isOpened) {})

Called when answer becomes visible or invisible (search mode only)

Arguments

answer: Object Answer object
isOpened: Boolean New answer state

activateBlockquote

nanorep.floatingWidget.on('activateBlockquote', function(blockQuoteText, answerId, searchQuery) {})

Called when user clicks on "<blockquote>" tag inside the article. Will be emitted only if "Touchpoints → Advanced → Actionable block quotes in answer text" is checked. (search mode only)

Arguments

blockQuoteText: String Quoted text
answerId: String Answer id
searchQuery: String Search query string

share

nanorep.floatingWidget.on('share', function(sharingType, answer) {})

Called when visitor is sharing article (search mode only)

Arguments

sharingType: String Type of sharing
answer: Object Answer object

activateWidget

nanorep.floatingWidget.on('activateWidget', function() {})

Called when widget is activated by visitor (search and conversational modes)

closeWidget

nanorep.floatingWidget.on('closeWidget', function() {})

Called when widget is closed by visitor (conversational mode only and "Minimized Widget Mode: Minimized" setting)

collapseWidget

nanorep.floatingWidget.on('collapseWidget', function() {})

Called when widget expanded (conversational mode only and "Minimized Widget Mode: Minimized" setting)

expandWidget

nanorep.floatingWidget.on('expandWidget', function() {})

Called when widget expanded (conversational mode only and "Minimized Widget Mode: Minimized" setting)

chatSessionStarted

nanorep.floatingWidget.on('chatSessionStarted', function() {})

Called when live chat session within AI widget started (search and conversational modes)

chatSessionEnded

nanorep.floatingWidget.on('chatSessionEnded', function() {})

Called when live chat session within AI widget ended (search and conversational modes)

userAction

nanorep.floatingWidget.on('userAction', function() {})

Called when user makes any activity within the widget. For example: send message, select suggestion, press the button, etc. (conversational mode only)

cnfReceive

nanorep.floatingWidget.on('cnfReceive', function(cnf) {})

Called when widget get config. This is the place, where cnf can be patched

ticketSent

nanorep.floatingWidget.on('ticketSent', function() {})

Called when contact form sent

ProviderName:preChat

nanorep.floatingWidget.on('BoldChat:preChat', function() {})

Called when preChat form has been shown in a chat

ProviderName:postChat

nanorep.floatingWidget.on('BoldChat:postChat', function() {})

Called when postChat form has been shown in a chat

ProviderName:chatStarted

nanorep.floatingWidget.on('BoldChat:chatStarted', function() {})

Called when chat with agent starts (after preChat if it exists)

ProviderName:chatFormSent

nanorep.floatingWidget.on('BoldChat:chatFormSent', function(params) {})

Called when postChat or transcript form submit

Arguments

params.type: String transcript | postChat

ProviderName:chatEnded

nanorep.floatingWidget.on('BoldChat:chatEnded', function() {})

Called when chat ended

ProviderName:newMessage

nanorep.floatingWidget.on('BoldChat:newMessage', function(entryModel, entryElement) {})

Called when any new message appears in the chat log

Arguments

entryModel: Object Entry model object, like { type: 1, text: 'Entry text', avatar... }
entryElement: DOM element Entry DOM element. Could be used to update entry

ProviderName:unavailableForm

nanorep.floatingWidget.on('BoldChat:unavailableForm', function(formKey) {})

Called when user get unavailableForm

Arguments

formKey: String One of these:
  • api#unavailable#intro
  • api#unavailable#no_operators
  • api#unavailable#unavailable
  • api#unavailable#unavailable_blocked
  • api#unavailable#unavailable_hours_operators
  • api#unavailable#unavailable_invite
  • api#unavailable#unavailable_limit
  • api#unavailable#unavailable_max_queue