InteractiveCanvas（Dialogflow）

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

注: interactiveCanvas オブジェクトは window オブジェクトに関連付けられます。もし ウェブアプリを開発する場合、 window にアクセスして API を設定できます。

メソッド

ready

ready(callbacks) returns undefined

コールバックを登録するために読み込まれると、Interactive 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 ピクセル単位の高さ。

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> タグを追加します。

注: 次の場合は、SSML マークは呼び出されません。 <ph type="x-smartling-placeholder">

</ph>
• TTS が開始される前に、ユーザーがマイクまたはインタラクティブ キャンバスをタップする クライアントが sendTextQuery を呼び出す。TTS はキャンセルされ、SSML のマークが付きます。 TTS は無視されます。
• TTS の実行中に、ユーザーがマイクをタップするか、Interactive Canvas クライアントが sendTextQuery。TTS が中断され、残りの SSML が TTS 内のマークは無視されます。

パラメータ
markName	string TTS の再生中に呼び出されたマーク名。