WaterfallDialog Classe

  • Referência
Pacote:
com.microsoft.bot.dialogs
Artefato Maven:
com.microsoft.bot:bot-dialogs:4.14.3

public class WaterfallDialog
extends Dialog

Caixa de diálogo otimizada para solicitar um usuário com uma série de perguntas. As cascatas aceitam uma pilha de funções que serão executadas em sequência. Cada etapa em cascata pode fazer uma pergunta ao usuário e a resposta do usuário será passada como um argumento para a próxima etapa de cascata.

Resumo do Construtor

Construtor Description
WaterfallDialog(String dialogId, List<WaterfallStep> actions)

Inicializa uma nova instância da classe WaterfallDialog.

Resumo do método

Modificador e tipo Método e descrição
WaterfallDialog addStep(WaterfallStep step)

Adiciona uma nova etapa à cascata.
java.util.concurrent.CompletableFuture<DialogTurnResult> beginDialog(DialogContext dc, Object options)

Chamado quando a caixa de diálogo cascata é 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 cascata é _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 getVersion()

Obtém uma cadeia de caracteres exclusiva que representa a versão desta caixa de diálogo.
protected java.util.concurrent.CompletableFuture<DialogTurnResult> onStep(WaterfallStepContext stepContext)

Chamado quando uma etapa de cascata individual está sendo executada.
java.util.concurrent.CompletableFuture<DialogTurnResult> resumeDialog(DialogContext dc, DialogReason reason, Object result)

Chamado quando uma caixa de diálogo em cascata filho completou sua vez, retornando o controle para essa caixa de diálogo.
protected java.util.concurrent.CompletableFuture<DialogTurnResult> runStep(DialogContext dc, int index, DialogReason reason, Object result)

Excuta uma etapa da caixa de diálogo cascata.

Métodos herdados de Dialog

beginDialog beginDialog continueDialog endDialog getId getTelemetryClient getVersion innerRun onComputeId onDialogEvent onPostBubbleEvent onPreBubbleEvent repromptDialog resumeDialog resumeDialog run setId setTelemetryClient

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 construtor

WaterfallDialog

public WaterfallDialog(String dialogId, List actions)

Inicializa uma nova instância da classe WaterfallDialog.

Parâmetros:

dialogId - A ID da caixa de diálogo.
actions - Ações opcionais a serem definidas pelo chamador.

Detalhes do método

addStep

public WaterfallDialog addStep(WaterfallStep step)

Adiciona uma nova etapa à cascata.

Parâmetros:

step - Etapa a ser adicionada.

Retornos:

Caixa de diálogo cascata para chamadas fluentes para AddStep().

beginDialog

public CompletableFuture beginDialog(DialogContext dc, Object options)

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

Substituições:

WaterfallDialog.beginDialog(DialogContext dc, Object options)

Parâmetros:

dc - O
options - Informações iniciais opcionais a serem passadas para a caixa de diálogo.

Retornos:

Um CompletableFuture que representa a operação assíncrona. 
     If the task is successful, the result indicates whether the dialog is
     still active after the turn has been processed by the dialog.

continueDialog

public CompletableFuture continueDialog(DialogContext dc)

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

Substituições:

WaterfallDialog.continueDialog(DialogContext dc)

Parâmetros:

dc - O

Retornos:

Um CompletableFuture que representa a operação assíncrona. 
     If the task is successful, the result indicates whether the dialog is
     still active after the turn has been processed by the dialog. The
     result may also contain a return value.

endDialog

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

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

Substituições:

WaterfallDialog.endDialog(TurnContext turnContext, DialogInstance instance, DialogReason reason)

Parâmetros:

turnContext - Contexto para a virada atual da conversa.
instance - A instância da caixa de diálogo atual.
reason - O motivo pelo qual a caixa de diálogo está terminando.

Retornos:

Uma tarefa que representa o trabalho enfileirado a ser executado.

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.

Substituições:

WaterfallDialog.getVersion()

Retornos:

A versão será alterada quando as etapas forem alteradas (porque a caixa de diálogo não tem como avaliar o conteúdo das etapas.

onStep

protected CompletableFuture onStep(WaterfallStepContext stepContext)

Chamado quando uma etapa de cascata individual está sendo executada.

Parâmetros:

stepContext - Contexto para a etapa em cascata a ser executada.

Retornos:

Uma tarefa que representa o trabalho enfileirado a ser executado.

resumeDialog

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

Chamado quando uma caixa de diálogo em cascata filho completou sua vez, retornando o controle para essa caixa de diálogo.

Substituições:

WaterfallDialog.resumeDialog(DialogContext dc, DialogReason reason, Object result)

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:

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

runStep

protected CompletableFuture runStep(DialogContext dc, int index, DialogReason reason, Object result)

Excuta uma etapa da caixa de diálogo cascata.

Parâmetros:

dc - O DialogContext para a virada atual da conversa.
index - O índice da etapa de cascata atual a ser executada.
reason - O motivo pelo qual a etapa de cascata está sendo executada.
result - Resultado retornado por uma caixa de diálogo chamada na etapa anterior da cascata.

Retornos:

Uma tarefa que representa o trabalho enfileirado a ser executado.

Aplica-se a