ChoicePrompt class

Richiede a un utente di selezionare un elenco di scelte.

Extends

Commenti

Per impostazione predefinita, il prompt tornerà alla finestra di dialogo chiamante un oggetto FoundChoice contenente la scelta selezionata.

Costruttori

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

Crea una nuova istanza di ChoicePrompt.

Proprietà

choiceOptions

Opzioni aggiuntive passate al ChoiceFactory e usate per modificare lo stile delle scelte di cui è stato eseguito il rendering all'utente.

defaultLocale

Vengono richieste le impostazioni locali predefinite che devono essere riconosciute.

id

ID univoco del dialogo. Imposta l'ID univoco della finestra di dialogo.

recognizerOptions

Opzioni aggiuntive passate alla funzione recognizeChoices() sottostante.

style

Stile delle scelte "sì" e "no" di cui viene eseguito il rendering all'utente quando richiesto.

telemetryClient

Ottiene il client di telemetria per questa finestra di dialogo. Imposta il client di telemetria per questa finestra di dialogo.

Proprietà ereditate

EndOfTurn

Ottiene un risultato di fine turno predefinito.

Metodi ereditati

beginDialog(DialogContext, PromptOptions)

Viene chiamato quando viene eseguito il push di una finestra di dialogo nello stack di dialoghi e viene attivato.

configure(Record<string, unknown>)

Metodo Fluent per la configurazione dell'oggetto.

continueDialog(DialogContext)

Chiamato quando una finestra di dialogo di richiesta è la finestra di dialogo attiva e l'utente ha risposto con una nuova attività.

endDialog(TurnContext, DialogInstance, DialogReason)

Quando sottoposto a override in una classe derivata, esegue la pulizia per la finestra di dialogo prima che termini.

getConverter(string)
getVersion()

Stringa codificata usata per facilitare il rilevamento delle modifiche del bot nella ri-distribuzione.

onDialogEvent(DialogContext, DialogEvent)

Chiamato quando è stato generato un evento, utilizzando DialogContext.emitEvent(), dalla finestra di dialogo corrente o da una finestra di dialogo avviata dalla finestra di dialogo corrente.

repromptDialog(TurnContext, DialogInstance)

Chiamato quando è stata richiesta una finestra di dialogo di richiesta per richiedere di nuovo l'input all'utente.

resumeDialog(DialogContext, DialogReason, any)

Viene chiamato quando una finestra di dialogo di richiesta riprende a essere la finestra di dialogo attiva nello stack di dialoghi, ad esempio quando viene completata la finestra di dialogo attiva precedente nello stack.

Dettagli costruttore

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

Crea una nuova istanza di ChoicePrompt.

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

Parametri

dialogId

string

ID univoco della finestra di dialogo all'interno del relativo DialogSetpadre.

validator

PromptValidator<FoundChoice>

(Facoltativo) validator che verrà chiamato ogni volta che l'utente risponde al prompt. Se il validator risponde con un messaggio non verrà inviata alcuna richiesta di ripetizione dei tentativi aggiuntiva.

defaultLocale

string

(Facoltativo) Impostazioni locali da usare se non dc.context.activity.locale specificato. Il valore predefinito è en-us.

choiceDefaults
ChoiceDefaultsChoicePrompt

(Facoltativo) Esegue l'override del dizionario delle _choiceDefaults supportate da Bot Framework SDK (per la localizzazione della richiesta). Deve essere passato a ogni ConfirmPrompt che richiede le impostazioni predefinite per la scelta personalizzata.

Dettagli proprietà

choiceOptions

Opzioni aggiuntive passate al ChoiceFactory e usate per modificare lo stile delle scelte di cui è stato eseguito il rendering all'utente.

choiceOptions: ChoiceFactoryOptions | undefined

Valore della proprietà

ChoiceFactoryOptions | undefined

defaultLocale

Vengono richieste le impostazioni locali predefinite che devono essere riconosciute.

defaultLocale: string | undefined

Valore della proprietà

string | undefined

id

ID univoco del dialogo. Imposta l'ID univoco della finestra di dialogo.

string id

Valore della proprietà

string

ID della finestra di dialogo.

Commenti

Questo verrà generato automaticamente se non specificato.

recognizerOptions

Opzioni aggiuntive passate alla funzione recognizeChoices() sottostante.

recognizerOptions: FindChoicesOptions | undefined

Valore della proprietà

FindChoicesOptions | undefined

style

Stile delle scelte "sì" e "no" di cui viene eseguito il rendering all'utente quando richiesto.

style: ListStyle

Valore della proprietà

Commenti

Il valore predefinito è ListStyle.auto.

telemetryClient

Ottiene il client di telemetria per questa finestra di dialogo. Imposta il client di telemetria per questa finestra di dialogo.

BotTelemetryClient telemetryClient

Valore della proprietà

BotTelemetryClient

BotTelemetryClient da usare per la registrazione.

Dettagli proprietà ereditate

EndOfTurn

Ottiene un risultato di fine turno predefinito.

static EndOfTurn: DialogTurnResult

Valore della proprietà

Commenti

Questo risultato indica che un dialogo (o un passaggio logico all'interno di una finestra di dialogo) ha completato l'elaborazione per il turno corrente, è ancora attiva ed è in attesa di più input.

ereditato daDialog.EndOfTurn

Dettagli dei metodi ereditati

beginDialog(DialogContext, PromptOptions)

Viene chiamato quando viene eseguito il push di una finestra di dialogo nello stack di dialoghi e viene attivato.

function beginDialog(dc: DialogContext, options: PromptOptions): Promise<DialogTurnResult>

Parametri

dc
DialogContext

DialogContext per il turno corrente della conversazione.

options
PromptOptions

Opzionale. PromptOptions, informazioni aggiuntive da passare alla richiesta avviata.

Restituisce

Promise<DialogTurnResult>

Oggetto Promise che rappresenta l'operazione asincrona.

Commenti

Se l'attività ha esito positivo, il risultato indica se la richiesta è ancora attiva dopo che il turno è stato elaborato dal prompt.

ereditato daprompt.beginDialog

configure(Record<string, unknown>)

Metodo Fluent per la configurazione dell'oggetto.

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

Parametri

config

Record<string, unknown>

Impostazioni di configurazione da applicare.

Restituisce

this

Configurabile al termine dell'operazione.

Ereditato daConfigurable.configure

continueDialog(DialogContext)

Chiamato quando una finestra di dialogo di richiesta è la finestra di dialogo attiva e l'utente ha risposto con una nuova attività.

function continueDialog(dc: DialogContext): Promise<DialogTurnResult>

Parametri

dc
DialogContext

Il DialogContext per il turno di conversazione corrente.

Restituisce

Promise<DialogTurnResult>

Oggetto Promise che rappresenta l'operazione asincrona.

Commenti

Se l'attività ha esito positivo, il risultato indica se il dialogo è ancora attivo dopo che il turno è stato elaborato dalla finestra di dialogo. La richiesta continua in genere a ricevere le risposte dell'utente finché non accetta la risposta dell'utente come input valido per la richiesta.

ereditato daPrompt.continueDialog

endDialog(TurnContext, DialogInstance, DialogReason)

Quando sottoposto a override in una classe derivata, esegue la pulizia per la finestra di dialogo prima che termini.

function endDialog(_context: TurnContext, _instance: DialogInstance, _reason: DialogReason): Promise<void>

Parametri

_context

TurnContext

Oggetto di contesto per il turno.

_instance
DialogInstance

Informazioni sullo stato corrente per questa finestra di dialogo.

_reason
DialogReason

Motivo per cui la finestra di dialogo sta terminando.

Restituisce

Promise<void>

Commenti

Le finestre di dialogo derivate che devono eseguire la registrazione o la pulizia prima di terminare devono eseguire l'override di questo metodo. Per impostazione predefinita, questo metodo non ha alcun effetto.

Il DialogContext chiama questo metodo al termine della finestra di dialogo corrente.

Vedere anche

ereditato daDialog.endDialog

getConverter(string)

function getConverter(_property: string): Converter | ConverterFactory

Parametri

_property

string

Chiave della configurazione del selettore condizionale.

Restituisce

Convertitore per la configurazione del selettore.

ereditato daConfigurable.getConverter

getVersion()

Stringa codificata usata per facilitare il rilevamento delle modifiche del bot nella ri-distribuzione.

function getVersion(): string

Restituisce

string

Stringa univoca che deve cambiare solo quando il dialogo è stato modificato in modo da riavviare la finestra di dialogo.

Commenti

Per impostazione predefinita, la restituzione dei dialoghi id ma può essere sottoposta a override per fornire una logica di rilevamento delle modifiche più precisa. Qualsiasi finestra di dialogo nello stack con la modifica della versione genererà un evento versionChanged verrà generato. Se questo evento non viene gestito dal bot, verrà generato un errore che causa l'esecuzione della logica del gestore errori dei bot.

La restituzione di una stringa vuota disabilita il rilevamento della versione per il componente insieme.

ereditato daDialog.getVersion

onDialogEvent(DialogContext, DialogEvent)

Chiamato quando è stato generato un evento, utilizzando DialogContext.emitEvent(), dalla finestra di dialogo corrente o da una finestra di dialogo avviata dalla finestra di dialogo corrente.

function onDialogEvent(dc: DialogContext, e: DialogEvent): Promise<boolean>

Parametri

dc
DialogContext

Contesto del dialogo per il turno corrente della conversazione.

e
DialogEvent

Evento generato.

Restituisce

Promise<boolean>

True se l'evento viene gestito dalla finestra di dialogo corrente e il bubbling deve essere arrestato.

ereditato daDialog.onDialogEvent

repromptDialog(TurnContext, DialogInstance)

Chiamato quando è stata richiesta una finestra di dialogo di richiesta per richiedere di nuovo l'input all'utente.

function repromptDialog(context: TurnContext, instance: DialogInstance): Promise<void>

Parametri

context

TurnContext

(xref:botbuilder-core. TurnContext), contesto per il turno corrente della conversazione con l'utente.

instance
DialogInstance

(xref:botbuilder-dialogs. DialogInstance), istanza del dialogo nello stack.

Restituisce

Promise<void>

Oggetto Promise che rappresenta l'operazione asincrona.

ereditato daPrompt.repromptDialog

resumeDialog(DialogContext, DialogReason, any)

Viene chiamato quando una finestra di dialogo di richiesta riprende a essere la finestra di dialogo attiva nello stack di dialoghi, ad esempio quando viene completata la finestra di dialogo attiva precedente nello stack.

function resumeDialog(dc: DialogContext, _reason: DialogReason, _result?: any): Promise<DialogTurnResult>

Parametri

dc
DialogContext

DialogContext per il turno corrente della conversazione.

_reason
DialogReason

Enumerazione che indica il motivo per cui il dialogo è stato ripreso.

_result

any

Valore facoltativo restituito dalla finestra di dialogo precedente nello stack. Il tipo del valore restituito dipende dalla finestra di dialogo precedente.

Restituisce

Promise<DialogTurnResult>

Promessa che rappresenta l'operazione asincrona.

Commenti

Se l'attività ha esito positivo, il risultato indica se il dialogo è ancora attivo dopo che il turno è stato elaborato dalla finestra di dialogo.

ereditato daPrompt.resumeDialog