InteractiveCanvas (Dialogflow)

interactiveCanvas 物件是對話動作的介面 這些 API 功能

注意： interactiveCanvas 物件會附加至 window 物件。如果您是 使用前端架構開發網頁應用程式，您必須確保 您能夠透過 window 設定 API。

方法

準備好了

ready(callbacks) returns undefined

在載入回呼後，互動式畫布網頁應用程式會呼叫此方法。

參數
callbacks	InteractiveCanvasCallbacks 包含方法回呼的物件。

注意： 您須盡快在網頁應用程式叫用 ready API 就會引發這個事件。否則「動作」就會關閉。

sendTextQuery

sendTextQuery(textQuery) returns Promise<state>

傳送文字查詢到對話動作。

參數
textQuery	string 要傳送至對話式動作的查詢。
state	string 系統會顯示以下其中一個值： READY:平台可接受要求。 BLOCKED: 有一個進行中的查詢，將捨棄新查詢。 UNKNOWN: 無法判斷目前的查詢狀態。

注意： textQuery 不得超過 640 個字元。

getHeaderHeightPx

getHeaderHeightPx() returns Promise<height>

決定螢幕頂端標題的高度。

參數
height	number 高度 (以像素為單位)。

InteractiveCanvasCallbacks

這些回呼可讓您回應資訊或要求 透過對話方式傳送資料 接收相關資訊或要求

onUpdate

onUpdate(data) returns undefined

從對話動作傳送 HtmlResponse 時呼叫。更新後 函式呼叫結束之後， TTS 將會立即啟動。

參數
data	Object Webhook 傳送的更新資料。

onTtsMark

onTtsMark(markName) returns undefined

在 TTS 播放期間叫用的回呼。

一律會觸發的特殊標記：

• START 表示 TTS 的起始值。
• END 表示 TTS 的結尾。
• ERROR 表示播放 TTS 時發生錯誤。

您也可以使用 SSML 和 <mark> 標記，例如 <mark name="custom"/>。

注意：下列情況不會叫用 SSML 標記：

• 在 TTS 開始前，使用者輕觸麥克風或互動式畫布 用戶端叫用 sendTextQuery。已取消 TTS，且 系統將忽略 TTS。
• 在 TTS 期間，使用者輕觸麥克風或互動畫布用戶端叫用 sendTextQuery。TTS 中斷及任何剩餘的 SSML 時 則會忽略 TTS 中的符號。

參數
markName	string 標記在 TTS 播放期間叫用的名稱。