ActivityPrompt Classe

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

public class ActivityPrompt
extends Dialog

Define o comportamento principal de uma caixa de diálogo de prompt que aguarda o recebimento de uma atividade. Esse prompt requer que um validador seja passado e é útil ao esperar que atividades que não sejam de mensagens, como um evento, sejam recebidas. O validador pode ignorar as atividades recebidas até que o tipo de atividade esperado seja recebido.

Resumo do Construtor

Construtor Description
ActivityPrompt(String dialogId, PromptValidator<Activity> validator)

Inicializa uma nova instância da classe ActivityPrompt.

Resumo do método

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

Chamado quando uma caixa de diálogo de prompt é enviada por push para a pilha de diálogo e está sendo ativada.
java.util.concurrent.CompletableFuture<DialogTurnResult> continueDialog(DialogContext dc)

Chamado quando uma caixa de diálogo de prompt é a caixa de diálogo ativa e o usuário respondeu com uma nova atividade.
protected java.util.concurrent.CompletableFuture<java.lang.Void> onPrompt(TurnContext turnContext, Map<String,Object> state, PromptOptions options)

Quando substituído em uma classe derivada, solicita entrada ao usuário.
protected java.util.concurrent.CompletableFuture<java.lang.Void> onPrompt(TurnContext turnContext, Map<String,Object> state, PromptOptions options, Boolean isRetry)

Quando substituído em uma classe derivada, solicita entrada ao usuário.
protected java.util.concurrent.CompletableFuture<PromptRecognizerResult<Activity>> onRecognize(TurnContext turnContext, Map<String,Object> state, PromptOptions options)

Quando substituído em uma classe derivada, tenta reconhecer a atividade de entrada.
java.util.concurrent.CompletableFuture<java.lang.Void> repromptDialog(TurnContext turnContext, DialogInstance instance)

Chamado quando uma caixa de diálogo de prompt foi solicitada para solicitar novamente entrada ao usuário.
java.util.concurrent.CompletableFuture<DialogTurnResult> resumeDialog(DialogContext dc, DialogReason reason, Object result)

Chamado quando uma caixa de diálogo de prompt continua sendo a caixa de diálogo ativa na pilha de diálogo, como quando a caixa de diálogo ativa anterior na pilha é concluída.

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

ActivityPrompt

public ActivityPrompt(String dialogId, PromptValidator validator)

Inicializa uma nova instância da classe ActivityPrompt. Chamado de construtores em classes derivadas para inicializar a classe ActivityPrompt.

Parâmetros:

dialogId - A ID a ser atribuída a esse prompt.
validator - Um PromptValidator<T> que contém a validação para este prompt. 
              The value of dialogId must be unique within the
              <xref uid="com.microsoft.bot.dialogs.DialogSet" data-throw-if-not-resolved="false" data-raw-source="DialogSet"></xref> or <xref uid="com.microsoft.bot.dialogs.ComponentDialog" data-throw-if-not-resolved="false" data-raw-source="ComponentDialog"></xref> to which the
              prompt is added.

Detalhes do método

beginDialog

public CompletableFuture beginDialog(DialogContext dc, Object options)

Chamado quando uma caixa de diálogo de prompt é enviada por push para a pilha de diálogo e está sendo ativada.

Substituições:

ActivityPrompt.beginDialog(DialogContext dc, Object options)

Parâmetros:

dc - O contexto da caixa de diálogo para a virada atual da conversa.
options - Informações adicionais opcionais a serem passadas para o prompt que está sendo iniciado.

Retornos:

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

continueDialog

public CompletableFuture continueDialog(DialogContext dc)

Chamado quando uma caixa de diálogo de prompt é a caixa de diálogo ativa e o usuário respondeu com uma nova atividade.

Substituições:

ActivityPrompt.continueDialog(DialogContext dc)

Parâmetros:

dc - O contexto da caixa de diálogo para a virada atual da conversa.

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
     prompt generally continues to receive the user's replies until it
     accepts the user's reply as valid input for the prompt.

onPrompt

protected CompletableFuture onPrompt(TurnContext turnContext, Map state, PromptOptions options)

Quando substituído em uma classe derivada, solicita entrada ao usuário.

Parâmetros:

turnContext - Contexto para a virada atual da conversa com o usuário.
state - Contém o estado da instância atual do prompt na pilha de diálogos.
options - Um objeto de opções de prompt construído a partir das opções inicialmente fornecidas na chamada para prompt(String dialogId, PromptOptions options) .

Retornos:

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

onPrompt

protected CompletableFuture onPrompt(TurnContext turnContext, Map state, PromptOptions options, Boolean isRetry)

Quando substituído em uma classe derivada, solicita entrada ao usuário.

Parâmetros:

turnContext - Contexto para a virada atual da conversa com o usuário.
state - Contém o estado da instância atual do prompt na pilha de diálogos.
options - Um objeto de opções de prompt construído a partir das opções inicialmente fornecidas na chamada para prompt(String dialogId, PromptOptions options) .
isRetry - Um Boolean que representa se o prompt for uma repetição.

Retornos:

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

onRecognize

protected CompletableFuture> onRecognize(TurnContext turnContext, Map state, PromptOptions options)

Quando substituído em uma classe derivada, tenta reconhecer a atividade de entrada.

Parâmetros:

turnContext - Contexto para a virada atual da conversa com o usuário.
state - Contém o estado da instância atual do prompt na pilha de diálogos.
options - Um objeto de opções de prompt construído a partir das opções inicialmente fornecidas na chamada para prompt(String dialogId, PromptOptions options) .

Retornos:

Um CompletableFuture que representa a operação assíncrona. 
     If the task is successful, the result describes the result of the
     recognition attempt.

repromptDialog

public CompletableFuture repromptDialog(TurnContext turnContext, DialogInstance instance)

Chamado quando uma caixa de diálogo de prompt foi solicitada para solicitar novamente entrada ao usuário.

Substituições:

ActivityPrompt.repromptDialog(TurnContext turnContext, DialogInstance instance)

Parâmetros:

turnContext - Contexto para a virada atual da conversa com o usuário.
instance - A instância da caixa de diálogo na pilha.

Retornos:

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

resumeDialog

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

Chamado quando uma caixa de diálogo de prompt continua sendo a caixa de diálogo ativa na pilha de diálogo, como quando a caixa de diálogo ativa anterior na pilha é concluída.

Substituições:

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

Parâmetros:

dc - O contexto da caixa de diálogo para a virada atual da conversa.
reason - Uma enumeração que indica por que a caixa de diálogo foi retomada.
result - Opcional, o valor retornado da caixa de diálogo anterior na pilha. O tipo do valor retornado depende da caixa de diálogo anterior.

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.

Aplica-se a