InteractiveCanvas（Dialogflow）

interactiveCanvas オブジェクトは会話アクションへのインターフェース ウェブアプリで利用できるようにします

メソッド

ready

ready(callbacks) returns undefined

コールバックを登録するために読み込まれると、Interactive Canvas ウェブアプリによって呼び出されます。

パラメータ
callbacks InteractiveCanvasCallbacks

メソッド コールバックを含むオブジェクト。

sendTextQuery

sendTextQuery(textQuery) returns Promise<state>

テキストクエリを会話型アクションに送信します。

パラメータ
textQuery string

会話アクションに送信するクエリ。
state string

次のいずれかが表示されます。

READY: リクエストはプラットフォームで承認されます。

BLOCKED: 処理中のクエリがあるため、新しいクエリは破棄されます。

UNKNOWN:: 現在のクエリの状態を特定できませんでした。

getHeaderHeightPx

getHeaderHeightPx() returns Promise<height>

ディスプレイの上部にあるヘッダーの高さを指定します。

パラメータ
height number

ピクセル単位の高さ。

Interactive Canvas のコールバック

これらのコールバックは、会話型アクションからの情報やリクエストに応答する手段を提供します。一方、メソッドは、会話型アクションに情報やリクエストを送信する手段を提供します。

onUpdate

onUpdate(data) returns undefined

会話アクションから HtmlResponse が送信されると呼び出されます。関数呼び出しが終了すると、TTS がすぐに開始されます。

パラメータ
data Object

Webhook によって送信された更新済みデータ。

onTtsMark

onTtsMark(markName) returns undefined

TTS の再生中に呼び出されるコールバック。

通常トリガーされる特別なマークを以下に示します。

  • START は、TTS の開始を示します。
  • END は、TTS の終了を示します。
  • ERROR は、TTS の再生中にエラーが発生したことを示します。

また、 SSML <mark name="custom"/> などの <mark> タグを追加します。

パラメータ
markName string

TTS の再生中に呼び出されたマーク名。