Prompt class
Classe base para todos os prompts.
- Extends
Propriedades
| id | ID exclusiva da caixa de diálogo. Define a ID exclusiva da caixa de diálogo. |
| telemetry |
Obtém o cliente de telemetria para esta caixa de diálogo. Define o cliente de telemetria para essa caixa de diálogo. |
Propriedades herdadas
| End |
Obtém um resultado de fim de turno padrão. |
Métodos
| begin |
Chamado quando uma caixa de diálogo de prompt é enviada por push para a pilha de diálogo e está sendo ativada. |
| continue |
Chamado quando uma caixa de diálogo de prompt é a caixa de diálogo ativa e o usuário respondeu com uma nova atividade. |
| reprompt |
Chamado quando uma caixa de diálogo de prompt foi solicitada para solicitar novamente entrada ao usuário. |
| resume |
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
| configure(Record<string, unknown>) | Método fluente para configurar o objeto. |
| end |
Quando substituído em uma classe derivada, executa a limpeza da caixa de diálogo antes de terminar. |
| get |
|
| get |
Uma cadeia de caracteres codificada usada para ajudar na detecção de alterações de bot na re-implantação. |
| on |
Chamado quando um evento foi gerado, usando |
Detalhes da propriedade
id
ID exclusiva da caixa de diálogo. Define a ID exclusiva da caixa de diálogo.
string idValor da propriedade
string
A ID da caixa de diálogo.
Comentários
Isso será gerado automaticamente se não for especificado.
telemetryClient
Obtém o cliente de telemetria para esta caixa de diálogo. Define o cliente de telemetria para essa caixa de diálogo.
BotTelemetryClient telemetryClientValor da propriedade
BotTelemetryClient
O
Detalhes das propriedades herdadas
EndOfTurn
Obtém um resultado de fim de turno padrão.
static EndOfTurn: DialogTurnResultValor da propriedade
Comentários
Esse resultado indica que uma caixa de diálogo (ou uma etapa lógica em uma caixa de diálogo) concluiu o processamento para a curva atual, ainda está ativa e está aguardando mais entrada.
Detalhes do método
beginDialog(DialogContext, PromptOptions)
Chamado quando uma caixa de diálogo de prompt é enviada por push para a pilha de diálogo e está sendo ativada.
function beginDialog(dc: DialogContext, options: PromptOptions): Promise<DialogTurnResult>Parâmetros
O DialogContext para a virada atual da conversa.
- options
- PromptOptions
Opcional. promptOptions, informações adicionais a serem passadas para o prompt que está sendo iniciado.
Retornos
Promise<DialogTurnResult>
Um Promise que representa a operação assíncrona.
Comentários
Se a tarefa for bem-sucedida, o resultado indicará se o prompt ainda está ativo após a curva ter sido processada pelo prompt.
continueDialog(DialogContext)
Chamado quando uma caixa de diálogo de prompt é a caixa de diálogo ativa e o usuário respondeu com uma nova atividade.
function continueDialog(dc: DialogContext): Promise<DialogTurnResult>Parâmetros
O dialogContext
Retornos
Promise<DialogTurnResult>
Um Promise que representa a operação assíncrona.
Comentários
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 prompt geralmente continua a receber as respostas do usuário até aceitar a resposta do usuário como entrada válida para o prompt.
repromptDialog(TurnContext, DialogInstance)
Chamado quando uma caixa de diálogo de prompt foi solicitada para solicitar novamente entrada ao usuário.
function repromptDialog(context: TurnContext, instance: DialogInstance): Promise<void>Parâmetros
- context
-
TurnContext
(xref:botbuilder-core. TurnContext), contexto para a virada atual da conversa com o usuário.
- instance
- DialogInstance
(xref:botbuilder-dialogs. DialogInstance), a instância da caixa de diálogo na pilha.
Retornos
Promise<void>
Um Promise que representa a operação assíncrona.
resumeDialog(DialogContext, DialogReason, any)
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.
function resumeDialog(dc: DialogContext, _reason: DialogReason, _result?: any): Promise<DialogTurnResult>Parâmetros
O DialogContext para a virada atual da conversa.
- _reason
- DialogReason
Uma enumeração que indica por que a caixa de diálogo foi retomada.
- _result
-
any
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
Promise<DialogTurnResult>
Uma promessa que representa a operação assíncrona.
Comentários
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.
Detalhes do método herdado
configure(Record<string, unknown>)
Método fluente para configurar o objeto.
function configure(config: Record<string, unknown>): thisParâmetros
- config
-
Record<string, unknown>
Configurações a serem aplicadas.
Retornos
this
O configurável após a conclusão da operação.
Herdado deConfigurble.configure
endDialog(TurnContext, DialogInstance, DialogReason)
Quando substituído em uma classe derivada, executa a limpeza da caixa de diálogo antes de terminar.
function endDialog(_context: TurnContext, _instance: DialogInstance, _reason: DialogReason): Promise<void>Parâmetros
- _context
-
TurnContext
O objeto de contexto para a curva.
- _instance
- DialogInstance
Informações de estado atuais para essa caixa de diálogo.
- _reason
- DialogReason
O motivo pelo qual a caixa de diálogo está terminando.
Retornos
Promise<void>
Comentários
As caixas de diálogo derivadas que precisam executar o registro em log ou a limpeza antes de terminar devem substituir esse método. Por padrão, esse método não tem efeito.
O dialogContext
Consulte também
- DialogContext.cancelAllDialogs
- dialogContext.endDialog
-
DialogContext.replaceDialog
herdado dedialog.endDialog
getConverter(string)
function getConverter(_property: string): Converter | ConverterFactoryParâmetros
- _property
-
string
A chave da configuração do seletor condicional.
Retornos
O conversor para a configuração do seletor.
herdado deconfigurable.getConverter
getVersion()
Uma cadeia de caracteres codificada usada para ajudar na detecção de alterações de bot na re-implantação.
function getVersion(): stringRetornos
string
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.
Comentários
Esse padrão é retornar as caixas de diálogo id mas pode ser substituído para fornecer uma lógica de detecção de alterações mais precisa. Qualquer caixa de diálogo na pilha que tenha sua alteração de versão resultará em um evento versionChanged será gerado. Se esse evento não for tratado pelo bot, um erro será gerado, resultando na execução da lógica do manipulador de erros de bots.
Retornar uma cadeia de caracteres vazia desabilitará o acompanhamento de versão para o componente.
herdado dedialog.getVersion
onDialogEvent(DialogContext, DialogEvent)
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.
function onDialogEvent(dc: DialogContext, e: DialogEvent): Promise<boolean>Parâmetros
O contexto da caixa de diálogo para a virada atual da conversa.
O evento que está sendo gerado.
Retornos
Promise<boolean>
True se o evento for tratado pela caixa de diálogo atual e o borbulhamento deve parar.
herdado da caixa de diálogo.onDialogEvent