InteractiveCanvas (Dialogflow)

interactiveCanvas 对象是在您的 Web 应用中提供的对话操作的接口。

方法

准备就绪

ready(callbacks) returns undefined

在加载完成后由 Interactive Canvas Web 应用调用以注册回调。

参数
callbacks InteractiveCanvasCallbacks

一个包含方法回调的对象。

sendTextQuery

sendTextQuery(textQuery) returns Promise<state>

向对话操作发送文本查询。

参数
textQuery string

要发送到对话操作的查询。

state string

以下任一项:

READY: 平台可以接受请求。

BLOCKED:有一个正在执行的查询,新查询将被舍弃。

UNKNOWN:无法确定当前的查询状态。

getHeaderHeightPx

getHeaderHeightPx() returns Promise<height>

确定显示屏顶部标头的高度。

参数
height number

高度(以像素为单位)。

InteractiveCanvasCallbacks

这些回调提供了一种方式来响应来自对话操作的信息或请求,而方法则提供了向对话操作发送信息或请求的方法。

onUpdate

onUpdate(data) returns undefined

从对话操作发送 HtmlResponse 时调用。函数调用结束后,TTS 将立即开始。

参数
data Object

网络钩子发送的已更新数据。

onTtsMark

onTtsMark(markName) returns undefined

在 TTS 播放期间调用的回调。

始终触发的特殊标记:

  • START 表示 TTS 的开始。
  • END 表示 TTS 的结束。
  • ERROR 表示播放 TTS 时发生错误。

您还可以使用 SSML<mark> 标记(例如 <mark name="custom"/>)定义自定义标记。

参数
markName string

将名称标记为在 TTS 播放期间调用。