InteractiveCanvas (Dialogflow)

O objeto interactiveCanvas é a interface para a ação de conversa que é disponibilizada no seu app da Web.

Observação: o objeto interactiveCanvas está anexado ao objeto window. Se estiver usando um framework de front-end para desenvolver seu app da Web, confira se você tem acesso a window para configurar a API.

Métodos

pronto

ready(callbacks) returns undefined

Chamado pelo app da Web de tela interativa depois que ele é carregado para registrar callbacks.

Parâmetros
callbacks	InteractiveCanvasCallbacks Um objeto que contém callbacks de método.

Observação: é necessário invocar a API ready no app da Web assim que a página for carregada. Caso contrário, a ação vai ser fechada.

sendTextQuery

sendTextQuery(textQuery) returns Promise<state>

Envia uma consulta de texto para a ação de conversa.

Parâmetros
textQuery	string A consulta a ser enviada para a ação de conversa.
state	string Opções: READY: As solicitações podem ser aceitas pela plataforma. BLOCKED: Há uma consulta em andamento, e a nova consulta será descartada. UNKNOWN: Não foi possível determinar o estado atual da consulta.

Atenção: textQuery precisa ter até 640 caracteres.

getHeaderHeightPx

getHeaderHeightPx() returns Promise<height>

Determina a altura do cabeçalho na parte superior de uma tela.

Parâmetros
height	number A altura em pixels.

InteractiveCanvasCallbacks

Esses callbacks oferecem uma maneira de responder a informações ou solicitações da sua ação de conversa, enquanto os métodos oferecem uma maneira de enviar informações ou solicitações para a ação de conversa.

onUpdate

onUpdate(data) returns undefined

Chamado quando um HtmlResponse é enviado da ação de conversa. Após o término da chamada de função, o TTS vai começar imediatamente.

Parâmetros
data	Object Dados atualizados enviados pelo webhook.

onTtsMark

onTtsMark(markName) returns undefined

Callback invocado durante a reprodução de TTS.

Marcas especiais que sempre são acionadas:

• START indica o início do TTS.
• END indica o fim do TTS.
• ERROR indica um erro ao tocar o TTS.

Você também pode definir marcas personalizadas usando SSML e a tag <mark>, como <mark name="custom"/>.

Observação:as marcas SSML não são invocadas quando ocorre o seguinte:

• Antes do TTS começar, o usuário toca no microfone ou o cliente da tela interativa invoca sendTextQuery. A TTS é cancelada, e todas as marcas SSML no TTS são ignoradas.
• Durante o TTS, o usuário toca no microfone ou o cliente de tela interativa invoca sendTextQuery. O TTS é interrompido, e todas as marcas SSML restantes no TTS são ignoradas.

Parâmetros
markName	string Marcar o nome invocado durante a reprodução de TTS.