Dialog Classe

  • java.lang.Object
    • com.microsoft.bot.dialogs.Dialog

public abstract class Dialog

Classe base para todos os diálogos.

Resumo do campo

Modificador e tipo Campo e descrição
static final DialogTurnResult END_OF_TURN

Um DialogTurnResult que indica que a caixa de diálogo atual ainda está ativa e aguardando a entrada do usuário na próxima vez.

Resumo do Construtor

Construtor Description
Dialog(String dialogId)

Inicializa uma nova instância da classe Dialog.

Resumo do método

Modificador e tipo Método e descrição
java.util.concurrent.CompletableFuture<DialogTurnResult> beginDialog(DialogContext dc)

Chamado quando a caixa de diálogo é iniciada e enviada por push para a pilha de diálogo.

abstract java.util.concurrent.CompletableFuture<DialogTurnResult> beginDialog(DialogContext dc, Object options)

Chamado quando a caixa de diálogo é iniciada e enviada por push para a pilha de diálogo.

java.util.concurrent.CompletableFuture<DialogTurnResult> continueDialog(DialogContext dc)

Chamado quando a caixa de diálogo é _continued_, onde é a caixa de diálogo ativa e o usuário responde com uma nova atividade.

java.util.concurrent.CompletableFuture<java.lang.Void> endDialog(TurnContext turnContext, DialogInstance instance, DialogReason reason)

Chamado quando a caixa de diálogo está terminando.

java.lang.String getId()

Obtém a ID da caixa de diálogo.

BotTelemetryClient getTelemetryClient()

Obtém o BotTelemetryClient a ser usado para registro em log.

java.lang.String getVersion()

Obtém uma cadeia de caracteres exclusiva que representa a versão desta caixa de diálogo.

protected static java.util.concurrent.CompletableFuture<DialogTurnResult> innerRun(TurnContext turnContext, String dialogId, DialogContext dialogContext, DialogStateManagerConfiguration stateConfiguration)

Implementação compartilhada de execução com o Gerenciador dede Diálogo e Caixa de Diálogo.

protected java.lang.String onComputeId()

Calcula uma ID para a caixa de diálogo.

java.util.concurrent.CompletableFuture<java.lang.Boolean> onDialogEvent(DialogContext dc, DialogEvent e)

Chamado quando um evento foi gerado, usando 'Caixa de diálogoContexto.emitirEvent()', pela caixa de diálogo atual ou por uma caixa de diálogo iniciada pela caixa de diálogo atual.

protected java.util.concurrent.CompletableFuture<java.lang.Boolean> onPostBubbleEvent(DialogContext dc, DialogEvent e)

Chamado depois que um evento foi bolhado para todos os pais e não foi tratado.

protected java.util.concurrent.CompletableFuture<java.lang.Boolean> onPreBubbleEvent(DialogContext dc, DialogEvent e)

Chamado antes de um evento ser colocado em bolhas para seu pai.

java.util.concurrent.CompletableFuture<java.lang.Void> repromptDialog(TurnContext turnContext, DialogInstance instance)

Chamado quando a caixa de diálogo deve solicitar novamente entrada ao usuário.

java.util.concurrent.CompletableFuture<DialogTurnResult> resumeDialog(DialogContext dc, DialogReason reason)

Chamado quando uma caixa de diálogo filho concluiu essa curva, retornando o controle para essa caixa de diálogo.

java.util.concurrent.CompletableFuture<DialogTurnResult> resumeDialog(DialogContext dc, DialogReason reason, Object result)

Chamado quando uma caixa de diálogo filho concluiu essa curva, retornando o controle para essa caixa de diálogo.

static java.util.concurrent.CompletableFuture<java.lang.Void> run(Dialog dialog, TurnContext turnContext, StatePropertyAccessor<DialogState> accessor)

Cria uma pilha de diálogos e inicia uma caixa de diálogo, empurrando-a para a pilha.

void setId(String withId)

Define a ID da caixa de diálogo.

void setTelemetryClient(BotTelemetryClient withTelemetryClient)

Define o BotTelemetryClient a ser usado para registro em log.

Métodos herdados de java.lang.Object

java.lang.Object.clone java.lang.Object.equals java.lang.Object.finalize java.lang.Object.getClass java.lang.Object.hashCode java.lang.Object.notify java.lang.Object.notifyAll java.lang.Object.toString java.lang.Object.wait java.lang.Object.wait java.lang.Object.wait

Detalhes do campo

END_OF_TURN

public static final DialogTurnResult END_OF_TURN

Um DialogTurnResult que indica que a caixa de diálogo atual ainda está ativa e aguardando a entrada do usuário na próxima vez.

Detalhes do construtor

Dialog

public Dialog(String dialogId)

Inicializa uma nova instância da classe Dialog.

Parâmetros:

dialogId - A ID a ser atribuída a essa caixa de diálogo.

Detalhes do método

beginDialog

public CompletableFuture beginDialog(DialogContext dc)

Chamado quando a caixa de diálogo é iniciada e enviada por push para a pilha de diálogo.

Parâmetros:

dc - O DialogContext para a virada atual da conversa.

Retornos:

Se a tarefa for bem-sucedida, o resultado indicará se a caixa de diálogo ainda estará ativa depois que a curva tiver sido processada pela caixa de diálogo.

beginDialog

public abstract CompletableFuture beginDialog(DialogContext dc, Object options)

Chamado quando a caixa de diálogo é iniciada e enviada por push para a pilha de diálogo.

Parâmetros:

dc - O DialogContext para a virada atual da conversa.
options - Informações iniciais a serem passadas para a caixa de diálogo.

Retornos:

Se a tarefa for bem-sucedida, o resultado indicará se a caixa de diálogo ainda estará ativa depois que a curva tiver sido processada pela caixa de diálogo.

continueDialog

public CompletableFuture continueDialog(DialogContext dc)

Chamado quando a caixa de diálogo é _continued_, onde é a caixa de diálogo ativa e o usuário responde com uma nova atividade.

Se esse método for *not* substituído, a caixa de diálogo terminará automaticamente quando o usuário responder.

Parâmetros:

dc - O DialogContext para a virada atual da conversa.

Retornos:

Se a tarefa for bem-sucedida, o resultado indicará se a caixa de diálogo ainda estará ativa depois que a curva tiver sido processada pela caixa de diálogo. O resultado também pode conter um valor retornado.

endDialog

public CompletableFuture endDialog(TurnContext turnContext, DialogInstance instance, DialogReason reason)

Chamado quando a caixa de diálogo está terminando.

Parâmetros:

turnContext - O objeto de contexto para este turno.
instance - Informações de estado associadas à instância dessa caixa de diálogo na pilha de diálogo.
reason - Motivo pelo qual a caixa de diálogo terminou.

Retornos:

Um CompletableFuture que representa a operação assíncrona.

getId

public String getId()

Obtém a ID da caixa de diálogo.

Retornos:

ID da caixa de diálogo.

getTelemetryClient

public BotTelemetryClient getTelemetryClient()

Obtém o BotTelemetryClient a ser usado para registro em log.

Retornos:

O BotTelemetryClient a ser usado para registro em log.

getVersion

public String getVersion()

Obtém uma cadeia de caracteres exclusiva que representa a versão desta caixa de diálogo. Se a versão for alterada entre as transformações, o sistema de diálogo emitirá um evento DialogChanged.

Retornos:

Cadeia de caracteres exclusiva que só deve ser alterada quando a caixa de diálogo foi alterada de uma maneira que deve reiniciar a caixa de diálogo.

innerRun

protected static CompletableFuture innerRun(TurnContext turnContext, String dialogId, DialogContext dialogContext, DialogStateManagerConfiguration stateConfiguration)

Implementação compartilhada de execução com Dialog e DialogManager.

Parâmetros:

turnContext - O turnContext.
dialogId - A ID da caixa de diálogo.
dialogContext - O DialogContext.
stateConfiguration - O DialogStateManagerConfiguration.

Retornos:

Um DialogTurnResult.

onComputeId

protected String onComputeId()

Calcula uma ID para a caixa de diálogo.

Retornos:

A ID.

onDialogEvent

public CompletableFuture onDialogEvent(DialogContext dc, DialogEvent e)

Chamado quando um evento foi gerado, usando 'DialogContext.emitEvent()', pela caixa de diálogo atual ou por uma caixa de diálogo iniciada pela caixa de diálogo atual.

Parâmetros:

dc - O contexto da caixa de diálogo para a virada atual da conversa.
e - O evento que está sendo gerado.

Retornos:

True se o evento for tratado pela caixa de diálogo atual e o borbulhamento deve parar.

onPostBubbleEvent

protected CompletableFuture onPostBubbleEvent(DialogContext dc, DialogEvent e)

Chamado depois que um evento foi bolhado para todos os pais e não foi tratado.

Esse é um bom lugar para executar a lógica de processamento padrão para um evento. Retornar 'true' impedirá qualquer processamento do evento por caixas de diálogo filho.

Parâmetros:

dc - O contexto da caixa de diálogo para a virada atual da conversa.
e - O evento que está sendo gerado.

Retornos:

Se o evento é tratado pela caixa de diálogo atual e o processamento adicional deve ser interrompido.

onPreBubbleEvent

protected CompletableFuture onPreBubbleEvent(DialogContext dc, DialogEvent e)

Chamado antes de um evento ser colocado em bolhas para seu pai.

Este é um bom lugar para realizar a interceptação de um evento, pois retornar "true" impedirá qualquer propagação adicional do evento para os pais dos diálogos e também impedirá que os diálogos filho realizem seu processamento padrão.

Parâmetros:

dc - O contexto da caixa de diálogo para a virada atual da conversa.
e - O evento que está sendo gerado.

Retornos:

Se o evento é tratado pela caixa de diálogo atual e o processamento adicional deve ser interrompido.

repromptDialog

public CompletableFuture repromptDialog(TurnContext turnContext, DialogInstance instance)

Chamado quando a caixa de diálogo deve solicitar novamente entrada ao usuário.

Parâmetros:

turnContext - O objeto de contexto para este turno.
instance - Informações de estado para esta caixa de diálogo.

Retornos:

Um CompletableFuture que representa a operação assíncrona.

resumeDialog

public CompletableFuture resumeDialog(DialogContext dc, DialogReason reason)

Chamado quando uma caixa de diálogo filho concluiu essa curva, retornando o controle para essa caixa de diálogo.

Geralmente, a caixa de diálogo filho foi iniciada com uma chamada para beginDialog(DialogContext dc, Object options) No entanto, se o método replaceDialog(String dialogId) for chamado, a caixa de diálogo filho lógica poderá ser diferente da original.

Se esse método for *not* substituído, a caixa de diálogo terminará automaticamente quando o usuário responder.

Parâmetros:

dc - O contexto da caixa de diálogo para a virada atual da conversa.
reason - Motivo pelo qual a caixa de diálogo foi retomada.

Retornos:

Se a tarefa for bem-sucedida, o resultado indicará se essa caixa de diálogo ainda estará ativa depois que essa curva de diálogo tiver sido processada.

resumeDialog

public CompletableFuture resumeDialog(DialogContext dc, DialogReason reason, Object result)

Chamado quando uma caixa de diálogo filho concluiu essa curva, retornando o controle para essa caixa de diálogo.

Geralmente, a caixa de diálogo filho foi iniciada com uma chamada para beginDialog(DialogContext dc, Object options) No entanto, se o método replaceDialog(String dialogId, Object options) for chamado, a caixa de diálogo filho lógica poderá ser diferente da original.

Se esse método for *not* substituído, a caixa de diálogo terminará automaticamente quando o usuário responder.

Parâmetros:

dc - O contexto da caixa de diálogo para a virada atual da conversa.
reason - Motivo pelo qual a caixa de diálogo foi retomada.
result - Opcional, o valor retornado da caixa de diálogo que foi chamada. O tipo do valor retornado depende da caixa de diálogo filho.

Retornos:

Se a tarefa for bem-sucedida, o resultado indicará se essa caixa de diálogo ainda estará ativa depois que essa curva de diálogo tiver sido processada.

run

public static CompletableFuture run(Dialog dialog, TurnContext turnContext, StatePropertyAccessor accessor)

Cria uma pilha de diálogos e inicia uma caixa de diálogo, empurrando-a para a pilha.

Parâmetros:

dialog - A caixa de diálogo a ser iniciada.
turnContext - O contexto para a virada atual da conversa.
accessor - O acessador StatePropertyAccessor com o qual gerenciar o estado da pilha de diálogos.

Retornos:

Uma tarefa que representa a operação assíncrona.

setId

public void setId(String withId)

Define a ID da caixa de diálogo.

Parâmetros:

withId - ID da caixa de diálogo.

setTelemetryClient

public void setTelemetryClient(BotTelemetryClient withTelemetryClient)

Define o BotTelemetryClient a ser usado para registro em log.

Parâmetros:

withTelemetryClient - O BotTelemetryClient a ser usado para registro em log.

Aplica-se a