Compartilhar via

ChoicePrompt class

  • Referência
Pacote:
botbuilder-dialogs

Solicita que um usuário selecione em uma lista de opções.

Extends

Prompt<FoundChoice>

Comentários

Por padrão, o prompt retornará à caixa de diálogo de chamada um objeto FoundChoice que contém a opção selecionada.

Construtores

ChoicePrompt(string, PromptValidator<FoundChoice>, string, ChoiceDefaultsChoicePrompt)

Cria uma nova instância de ChoicePrompt.

Propriedades

choiceOptions

Opções adicionais passadas para o ChoiceFactory e usadas para ajustar o estilo de opções renderizado para o usuário.
defaultLocale

A localidade padrão de prompts que deve ser reconhecida.
id

ID exclusiva da caixa de diálogo. Define a ID exclusiva da caixa de diálogo.
recognizerOptions

Opções adicionais passadas para a função de recognizeChoices() subjacente.
style

Estilo das opções "sim" e "não" renderizadas ao usuário ao solicitar.
telemetryClient

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

EndOfTurn

Obtém um resultado de fim de turno padrão.

Métodos herdados

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.
configure(Record<string, unknown>)

Método fluente para configurar o objeto.
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.
endDialog(TurnContext, DialogInstance, DialogReason)

Quando substituído em uma classe derivada, executa a limpeza da caixa de diálogo antes de terminar.
getConverter(string)
getVersion()

Uma cadeia de caracteres codificada usada para ajudar na detecção de alterações de bot na re-implantação.
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.
repromptDialog(TurnContext, DialogInstance)

Chamado quando uma caixa de diálogo de prompt foi solicitada para solicitar novamente entrada ao usuário.
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.

Detalhes do construtor

ChoicePrompt(string, PromptValidator<FoundChoice>, string, ChoiceDefaultsChoicePrompt)

Cria uma nova instância de ChoicePrompt.

new ChoicePrompt(dialogId: string, validator?: PromptValidator<FoundChoice>, defaultLocale?: string, choiceDefaults?: ChoiceDefaultsChoicePrompt)

Parâmetros

dialogId

string

ID exclusiva da caixa de diálogo em seu DialogSetpai.

validator

PromptValidator<FoundChoice>

(Opcional) validador que será chamado sempre que o usuário responder ao prompt. Se o validador responder com uma mensagem, nenhum prompt de repetição adicional será enviado.

defaultLocale

string

(Opcional) localidade a ser usada se dc.context.activity.locale não especificado. O padrão é um valor de en-us.

choiceDefaults
ChoiceDefaultsChoicePrompt

(Opcional) Substitui o dicionário de _choiceDefaults com suporte do SDK do Bot Framework (para localização de prompt). Deve ser passado para cada ConfirmPrompt que precise dos padrões de escolha personalizados.

Detalhes da propriedade

choiceOptions

Opções adicionais passadas para o ChoiceFactory e usadas para ajustar o estilo de opções renderizado para o usuário.

choiceOptions: ChoiceFactoryOptions | undefined

Valor da propriedade

ChoiceFactoryOptions | undefined

defaultLocale

A localidade padrão de prompts que deve ser reconhecida.

defaultLocale: string | undefined

Valor da propriedade

string | undefined

id

ID exclusiva da caixa de diálogo. Define a ID exclusiva da caixa de diálogo.

string id

Valor da propriedade

string

A ID da caixa de diálogo.

Comentários

Isso será gerado automaticamente se não for especificado.

recognizerOptions

Opções adicionais passadas para a função de recognizeChoices() subjacente.

recognizerOptions: FindChoicesOptions | undefined

Valor da propriedade

FindChoicesOptions | undefined

style

Estilo das opções "sim" e "não" renderizadas ao usuário ao solicitar.

style: ListStyle

Valor da propriedade

ListStyle

Comentários

Assume o padrão de ListStyle.auto.

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 telemetryClient

Valor da propriedade

BotTelemetryClient

O BotTelemetryClient a ser usado para registro em log.

Detalhes das propriedades herdadas

EndOfTurn

Obtém um resultado de fim de turno padrão.

static EndOfTurn: DialogTurnResult

Valor da propriedade

DialogTurnResult

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.

herdado doDialog.EndOfTurn

Detalhes do método herdado

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

dc
DialogContext

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.

herdado do prompt.beginDialog do

configure(Record<string, unknown>)

Método fluente para configurar o objeto.

function configure(config: Record<string, unknown>): this

Parâ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

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

dc
DialogContext

O dialogContext para a virada atual da conversa.

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.

herdado deprompt.continueDialog

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 chama esse método quando a caixa de diálogo atual está terminando.

Consulte também

herdado dedialog.endDialog

getConverter(string) 

function getConverter(_property: string): Converter | ConverterFactory

Parâmetros

_property

string

A chave da configuração do seletor condicional.

Retornos

Converter | ConverterFactory

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(): string

Retornos

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

dc
DialogContext

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

e
DialogEvent

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

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.

herdado deprompt.repromptDialog

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

dc
DialogContext

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.

Herdado dePrompt.resumeDialog