interactiveCanvas object is the interface to your conversational action
that is made available within your web app.
ready(callbacks) returns undefined
Called by the Interactive Canvas web app once it has loaded to register callbacks.
An object that contains method callbacks.
sendTextQuery(textQuery) returns undefined
Sends a text query to the conversational action.
The query to send to the conversational action.
getHeaderHeightPx() returns Promise<height>
Determines the height of the header at the top of a display.
The height in pixels.
These callbacks provide a way for you to respond to information or requests from your conversational action while the methods provide a way to send information or requests to your conversational action.
onUpdate(data) returns undefined
Called when an
HtmlResponse is sent from the conversational action. After
the end of the function call, the TTS will start immediately.
Updated data sent by the webhook.
onTtsMark(markName) returns undefined
Callback that is invoked during TTS playback.
Special marks that always are triggered:
STARTindicates the start of the TTS.
ENDindicates the end of the TTS.
ERRORindicates an error playing the TTS.
You can also define custom marks by using
<mark> tag, like
Mark name invoked during TTS playback.