InteractiveCanvas (Dialogflow)

interactiveCanvas 物件是對話動作的介面，可在網頁應用程式中使用。

注意： interactiveCanvas 物件會附加至 window 物件。如果您使用前端架構開發網頁應用程式，則必須確保您有權存取 window 來設定 API。

方法

已就緒

ready(callbacks) returns undefined

載入互動式 Canvas 網頁應用程式後，會呼叫此方法來註冊回呼。

參數
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 中的所有 SSML 標記。
• 在 TTS 期間，使用者輕觸麥克風，或互動式 Canvas 用戶端會叫用 sendTextQuery。TTS 會中斷，並忽略 TTS 中剩餘的 SSML 標記。

參數
markName	string 播放 TTS 時叫用的標記名稱。