Idioma

Prompt<T> Classe

Definição

Define o comportamento principal das caixas de diálogo de prompt.

public abstract class Prompt<T> : Microsoft.Bot.Builder.Dialogs.Dialog
type Prompt<'T> = class
    inherit Dialog
Public MustInherit Class Prompt(Of T)
Inherits Dialog

Parâmetros de Tipo Genérico

T

O tipo de valor que o prompt retorna.

Herança
Prompt<T>
Derivado

Observações

Quando o prompt termina, deve devolver um T objeto que represente o valor solicitado. Use Add(Dialog) ou AddDialog(Dialog) para adicionar um prompt a um conjunto de diálogos ou caixa de diálogo de componente, respectivamente. Use PromptAsync(String, PromptOptions, CancellationToken) ou BeginDialogAsync(String, Object, CancellationToken) para iniciar o prompt. Se você iniciar um prompt a partir de um WaterfallStep em um WaterfallDialog, o resultado do prompt estará disponível na próxima etapa da cascata.

Construtores

Name Descrição
Prompt<T>(String, PromptValidator<T>)

Inicializa uma nova instância da Prompt<T> classe. Chamado a partir de construtores em classes derivadas para inicializar a Prompt<T> classe.

Propriedades

Name Descrição
Id

Obtém ou define id para a caixa de diálogo.

(Herdado de Dialog)
Source

Obtém a informação do cref="SourceRange"/>.

(Herdado de Dialog)
TelemetryClient

Obtém ou configura os IBotTelemetryClient para usar na registo de madeira.

(Herdado de Dialog)

Métodos

Name Descrição
AppendChoices(IMessageActivity, String, IList<Choice>, ListStyle, ChoiceFactoryOptions, CancellationToken)

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

AppendChoices(IMessageActivity, String, IList<Choice>, ListStyle, ChoiceFactoryOptions, String, IList<String>, CancellationToken)

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

BeginDialogAsync(DialogContext, Object, CancellationToken)

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

ContinueDialogAsync(DialogContext, CancellationToken)

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

EndDialogAsync(ITurnContext, DialogInstance, DialogReason, CancellationToken)

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

(Herdado de Dialog)
GetVersion()

Obtém uma cadeia de caracteres exclusiva que representa a versão dessa caixa de diálogo. Se a versão mudar entre turnos, o sistema de diálogo emitirá um evento DialogChanged.

(Herdado de Dialog)
OnComputeId()

Cria a ID de computação para a caixa de diálogo.

(Herdado de Dialog)
OnDialogEventAsync(DialogContext, DialogEvent, CancellationToken)

Chamado quando um evento foi levantado, usando DialogContext.emitEvent(), seja pelo diálogo atual ou por um diálogo que o diálogo atual iniciou.

(Herdado de Dialog)
OnPostBubbleEventAsync(DialogContext, DialogEvent, CancellationToken)

Chamado depois de um evento foi borbulhado para todos os pais e não foi atendido.

(Herdado de Dialog)
OnPreBubbleEventAsync(DialogContext, DialogEvent, CancellationToken)

Chamado antes de um evento ser borbulhado para seu pai.

OnPromptAsync(ITurnContext, IDictionary<String,Object>, PromptOptions, Boolean, CancellationToken)

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

OnRecognizeAsync(ITurnContext, IDictionary<String,Object>, PromptOptions, CancellationToken)

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

RegisterSourceLocation(String, Int32)

Regista um cref="SourceRange"/> no local fornecido.

(Herdado de Dialog)
RepromptDialogAsync(ITurnContext, DialogInstance, CancellationToken)

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

ResumeDialogAsync(DialogContext, DialogReason, Object, CancellationToken)

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 da Extensão

Name Descrição
RunAsync(Dialog, ITurnContext, IStatePropertyAccessor<DialogState>, CancellationToken)

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

Aplica-se a