InteractiveCanvas (Dialogflow)

interactiveCanvas 对象是对话操作的接口 提供的所有资源

注意 ：interactiveCanvas 对象会附加到 window 对象。如果您 使用前端框架来开发 Web 应用，则需要确保 您有权访问 window 以设置 API。

方法

准备好了

ready(callbacks) returns undefined

在 Interactive Canvas Web 应用加载后调用此方法，以便注册回调。

参数
callbacks	InteractiveCanvasCallbacks 包含方法回调的对象。

注意 ：在网页加载完毕后，您必须立即在 Web 应用中调用 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 开始之前，用户点按麦克风或 Interactive Canvas 客户端调用 sendTextQuery。TTS 已取消，所有 SSML 标记中 系统会忽略 TTS。
• 在 TTS 期间，用户点按麦克风，或者 Interactive Canvas 客户端调用 sendTextQuery。TTS 中断，任何剩余的 SSML 标记会被忽略。

参数
markName	string 标记在 TTS 播放期间调用的名称。