Prompt<T> Classe

Pacote:

com.microsoft.bot.dialogs.prompts

Artefato Maven:

com.microsoft.bot:bot-dialogs:4.14.3

• java.lang.Object
• • com.microsoft.bot.dialogs.Dialog
  • • com.microsoft.bot.dialogs.prompts.Prompt<T>

Parâmetros de tipo

T

Digite para o qual o prompt foi criado.

public abstract class Prompt
extends Dialog

Define o comportamento principal das caixas de diálogo de prompt. Quando o prompt for encerrado, ele deverá retornar um Objeto que representa o valor que foi solicitado. Use add(Dialog dialog) ou addDialog(Dialog dialog) para adicionar um prompt a um conjunto de diálogos ou caixa de diálogo de componente, respectivamente. Use prompt(String dialogId, PromptOptions options) ou beginDialog(String dialogId, Object options) para iniciar o prompt. Se você iniciar um prompt de um WaterfallStep em um WaterfallDialog, o resultado do prompt estará disponível na próxima etapa da cascata.

Resumo do campo

Modificador e tipo	Campo e descrição
static final java.lang.String	ATTEMPTCOUNTKEY

Resumo do Construtor

Construtor	Description
Prompt(String dialogId, PromptValidator<T> validator)	Inicializa uma nova instância da classe {@link Prompt{T}}.

Resumo do método

Modificador e tipo	Método e descrição
protected Activity	appendChoices(Activity prompt, String channelId, List<Choice> choices, ListStyle style, ChoiceFactoryOptions options) Quando substituído em uma classe derivada, acrescenta opções à atividade quando o usuário é solicitado a inserir.
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.Boolean>	onPreBubbleEvent(DialogContext dc, DialogEvent e) Chamado antes de um evento ser bolhas para seu pai.
protected abstract 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 abstract java.util.concurrent.CompletableFuture<PromptRecognizerResult<T>>	onRecognize(TurnContext turnContext, Map<String,Object> state, PromptOptions options) Quando substituído em uma classe derivada, tenta reconhecer a entrada do usuário.
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 a entrada do 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 campo

ATTEMPTCOUNTKEY

public static final String ATTEMPTCOUNTKEY

Detalhes do construtor

Prompt

public Prompt(String dialogId, PromptValidator validator)

Inicializa uma nova instância da classe {@link Prompt{T}}. Chamado de construtores em classes derivadas para inicializar a classe {@link Prompt{T}}.

Parameters:

dialogId - A ID a ser atribuída a esse prompt.

validator - Opcional, um {@link PromptValidator{T}} que contém validação personalizada adicional para esse 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="com.microsoft.bot.dialogs.DialogSet"></xref> or
              <xref uid="com.microsoft.bot.dialogs.ComponentDialog" data-throw-if-not-resolved="false" data-raw-source="com.microsoft.bot.dialogs.ComponentDialog"></xref> to which
              the prompt is added.

Detalhes do método

appendChoices

protected Activity appendChoices(Activity prompt, String channelId, List choices, ListStyle style, ChoiceFactoryOptions options)

Quando substituído em uma classe derivada, acrescenta opções à atividade quando o usuário é solicitado a inserir.

Parameters:

prompt - A atividade à qual acrescentar as opções.

channelId - A ID do canal do usuário.

choices - As opções a serem acrescentadas.

style - Indica como as opções devem ser apresentadas ao usuário.

options - As opções de formatação a serem usadas ao apresentar as opções.

Returns:

Um CompletableFuture representando a operação assíncrona.

     If the task is successful, the result contains the updated activity.

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.

Overrides:

Prompt<T>.beginDialog(DialogContext dc, Object options)

Parameters:

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

options - Opcional, informações adicionais a serem passadas para o prompt que está sendo iniciado.

Returns:

Um CompletableFuture representando 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.

Overrides:

Prompt<T>.continueDialog(DialogContext dc)

Parameters:

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

Returns:

Um CompletableFuture representando 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.

onPreBubbleEvent

protected CompletableFuture onPreBubbleEvent(DialogContext dc, DialogEvent e)

Chamado antes de um evento ser 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 das caixas de diálogo e também impedirá que qualquer caixa de diálogo filho execute seu processamento padrão.

Overrides:

Prompt<T>.onPreBubbleEvent(DialogContext dc, DialogEvent e)

Parameters:

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

e - O evento que está sendo gerado.

Returns:

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

onPrompt

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

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

Parameters:

turnContext - Contexto para a virada de conversa atual com o usuário.

state - Contém o estado da instância atual do prompt na pilha de diálogo.

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 - true se esta for a primeira vez que essa instância de diálogo de prompt estiver na pilha está solicitando entrada ao usuário; caso contrário, false. Determina se getPrompt() ou getRetryPrompt() deve ser usado.

Returns:

Um CompletableFuture representando a operação assíncrona.

onRecognize

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

Quando substituído em uma classe derivada, tenta reconhecer a entrada do usuário.

Parameters:

turnContext - Contexto para a virada de conversa atual com o usuário.

state - Contém o estado da instância atual do prompt na pilha de diálogo.

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) .

Returns:

Um CompletableFuture representando 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 a entrada do usuário.

Overrides:

Prompt<T>.repromptDialog(TurnContext turnContext, DialogInstance instance)

Parameters:

turnContext - Contexto para a virada de conversa atual com o usuário.

instance - A instância da caixa de diálogo na pilha.

Returns:

Um CompletableFuture representando 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.

Overrides:

Prompt<T>.resumeDialog(DialogContext dc, DialogReason reason, Object result)

Parameters:

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, valor retornado da caixa de diálogo anterior na pilha. O tipo do valor retornado depende da caixa de diálogo anterior.

Returns:

Um CompletableFuture representando 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.