InteractiveCanvas (Dialogflow)

El objeto interactiveCanvas es la interfaz de tu acción conversacional. que está disponible en tu aplicación web.

Nota: El objeto interactiveCanvas se adjunta al objeto window. Si eres usando un framework de frontend para desarrollar tu aplicación web, debes asegurarte de que Tienes acceso a window para configurar la API.

Métodos

listo

ready(callbacks) returns undefined

La app web de Interactive Canvas lo llama una vez que se carga para registrar devoluciones de llamada.

Parámetros
callbacks	InteractiveCanvasCallbacks Un objeto que contiene devoluciones de llamada de métodos.

Nota: Debes invocar la API de ready en la app web en cuanto se cargado. De lo contrario, la acción se cerrará.

sendTextQuery

sendTextQuery(textQuery) returns Promise<state>

Envía una consulta de texto a la acción conversacional.

Parámetros
textQuery	string La consulta que se enviará a la acción conversacional.
state	string Uno de los siguientes: READY: La plataforma puede aceptar las solicitudes. BLOCKED: Hay una consulta en tránsito y la consulta nueva se descartará. UNKNOWN: No se pudo determinar el estado actual de la consulta.

Precaución: textQuery debe tener 640 caracteres o menos.

getHeaderHeightPx

getHeaderHeightPx() returns Promise<height>

Determina la altura del encabezado en la parte superior de una pantalla.

Parámetros
height	number Es la altura en píxeles.

InteractiveCanvasCallbacks

Estas devoluciones de llamada te permiten responder a la información o las solicitudes de tu acción conversacional, mientras que los métodos proporcionan una forma de enviar información o solicitudes a tu acción conversacional.

onUpdate

onUpdate(data) returns undefined

Se llama cuando se envía un HtmlResponse desde la acción conversacional. Después del al final de la llamada a función, el TTS comenzará de inmediato.

Parámetros
data	Object Se actualizaron los datos que envió el webhook.

onTtsMark

onTtsMark(markName) returns undefined

Es la devolución de llamada que se invoca durante la reproducción de TTS.

Marcas especiales que siempre se activan:

• START indica el inicio de la TTS.
• END indica el final del TTS.
• ERROR indica un error de reproducción del TTS.

También puedes definir marcas personalizadas SSML y la etiqueta <mark>, como <mark name="custom"/>.

Nota: Las marcas de SSML no se invocan en los siguientes casos:

• Antes de que comience la función de TTS, el usuario presiona el micrófono o el lienzo interactivo. el cliente invoca a sendTextQuery. Se cancela el TTS y las marcas de SSML se se ignoran las TTS.
• Durante la función de TTS, el usuario presiona el micrófono, o bien el cliente de Interactive Canvas invoca sendTextQuery Se interrumpe el TTS y se elimina cualquier SSML restante. las marcas en el TTS se ignoran.

Parámetros
markName	string Nombre de la marca invocado durante la reproducción de TTS