ChoicePrompt class

Crea una nuova istanza di ChoicePrompt.

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

Parametri

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à

Vengono richieste le impostazioni locali predefinite che devono essere riconosciute.

defaultLocale: string | undefined

Valore della proprietà

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

string id

Valore della proprietà

ID della finestra di dialogo.

Commenti

Questo verrà generato automaticamente se non specificato.

Opzioni aggiuntive passate alla funzione recognizeChoices() sottostante.

recognizerOptions: FindChoicesOptions | undefined

Valore della proprietà

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.

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 da usare per la registrazione.

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

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

Restituisce

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

Metodo Fluent per la configurazione dell'oggetto.

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

Parametri

Restituisce

Configurabile al termine dell'operazione.

Ereditato daConfigurable.configure

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

Restituisce

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

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

Restituisce

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

• DialogContext.cancelAllDialogs
• DialogContext.endDialog
• DialogContext.replaceDialog

ereditato daDialog.endDialog

function getConverter(_property: string): Converter | ConverterFactory

Parametri

Restituisce

Convertitore per la configurazione del selettore.

ereditato daConfigurable.getConverter

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

function getVersion(): string

Restituisce

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

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

Restituisce

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

ereditato daDialog.onDialogEvent

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

Restituisce

Oggetto Promise che rappresenta l'operazione asincrona.

ereditato daPrompt.repromptDialog

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

Restituisce

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