InteractiveCanvas (Dialogflow)

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

Métodos

pronto

ready(callbacks) returns undefined

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

Parâmetros
callbacks InteractiveCanvasCallbacks

Um objeto que contém callbacks de método.

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 será descartada.

UNKNOWN: Não foi possível determinar o estado atual da consulta.

getHeaderHeightPx

getHeaderHeightPx() returns Promise<height>

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

Parâmetros
height number

A altura em pixels.

InteractiveCanvasCallbacks

Esses callbacks oferecem uma maneira de você 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 à sua ação de conversa.

onUpdate

onUpdate(data) returns undefined

Chamado quando uma HtmlResponse é enviada pela ação de conversa. Depois quando a chamada de função terminar, a TTS vai começar imediatamente.

Parâmetros
data Object

Os dados enviados pelo webhook foram atualizados.

onTtsMark

onTtsMark(markName) returns undefined

Callback que é invocado durante a reprodução de TTS.

Marcas especiais que sempre são acionadas:

  • START indica o início da TTS.
  • END indica o fim da TTS.
  • ERROR indica um erro ao reproduzir o TTS.

Também é possível definir marcas personalizadas usando SSML (em inglês) e a tag <mark>, como <mark name="custom"/>.

Parâmetros
markName string

Marcar o nome invocado durante a reprodução do TTS.