InteractiveCanvas (Dialogflow)

Objek interactiveCanvas adalah antarmuka ke tindakan percakapan yang tersedia dalam aplikasi web Anda.

Metode

siap

ready(callbacks) returns undefined

Dipanggil oleh aplikasi web Canvas Interaktif setelah dimuat untuk mendaftarkan callback.

Parameter
callbacks InteractiveCanvasCallbacks

Objek yang berisi callback metode.

sendTextQuery

sendTextQuery(textQuery) returns Promise<state>

Mengirim kueri teks ke tindakan percakapan.

Parameter
textQuery string

Kueri yang akan dikirim ke tindakan percakapan.

state string

Salah satu dari berikut ini:

READY: Permintaan dapat diterima oleh platform.

BLOCKED: Ada kueri yang sedang berlangsung dan kueri baru tersebut akan dihapus.

UNKNOWN: Status kueri saat ini tidak dapat ditentukan.

getHeaderHeightPx

getHeaderHeightPx() returns Promise<height>

Menentukan tinggi header di bagian atas tampilan.

Parameter
height number

Tinggi dalam piksel.

InteractiveCanvasCallbacks

Callback ini memberikan cara bagi Anda untuk merespons informasi atau permintaan dari tindakan percakapan, sedangkan metode tersebut memberikan cara untuk mengirim informasi atau permintaan ke tindakan percakapan Anda.

onUpdate

onUpdate(data) returns undefined

Dipanggil saat HtmlResponse dikirim dari tindakan percakapan. Setelah panggilan fungsi berakhir, TTS akan segera dimulai.

Parameter
data Object

Data yang diperbarui yang dikirim oleh webhook.

onTtsMark

onTtsMark(markName) returns undefined

Callback yang dipanggil selama pemutaran TTS.

Tanda khusus yang selalu dipicu:

  • START menunjukkan awal TTS.
  • END menunjukkan akhir TTS.
  • ERROR menunjukkan error saat memutar TTS.

Anda juga dapat menentukan tanda kustom menggunakan SSML dan tag <mark>, seperti <mark name="custom"/>.

Parameter
markName string

Menandai nama yang dipanggil selama pemutaran TTS.