DialogContainer class

Crea una nuova istanza della classe Dialog.

new DialogContainer(dialogId?: string)

Parametri

Set di dialoghi contenitori.

dialogs: DialogSet

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.

Impostare il client di telemetria e applicarlo anche a tutti i dialoghi figlio. Anche i dialoghi futuri aggiunti al componente erediteranno questo client. Ottenere il client di telemetria corrente.

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

Crea un contesto di dialogo interno per i contenitori figlio attivi.

function createChildContext(dc: DialogContext): DialogContext | undefined

Parametri

Restituisce

Nuovo contesto di dialogo per l'elemento figlio attivo o undefined se non è presente alcun elemento figlio attivo.

Trova una finestra di dialogo figlio aggiunta in precedenza al contenitore.

function findDialog(dialogId: string): Dialog | undefined

Parametri

Restituisce

Finestra di dialogo se trovata; in caso contrario null.

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.

Quando sottoposto a override in una classe derivata, avvia la finestra di dialogo.

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

Parametri

Restituisce

Commenti

I dialoghi derivati devono eseguire l'override di questo metodo.

Il DialogContext chiama questo metodo quando crea un nuovo DialogInstance per questa finestra di dialogo, lo inserisce nello stack di dialoghi e avvia il dialogo.

Una finestra di dialogo che rappresenta una conversazione a turno singolo deve attendere DialogContext.endDialog prima di uscire da questo metodo.

Vedere anche

• DialogContext.beginDialog
• DialogContext.replaceDialog

ereditato daDialog.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

Quando ne viene eseguito l'override in una classe derivata, continua la finestra di dialogo.

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

Parametri

Restituisce

Promessa che risolve il risultato del turno del dialogo.

Commenti

I dialoghi derivati che supportano conversazioni a più turni devono eseguire l'override di questo metodo. Per impostazione predefinita, questo metodo segnala che il dialogo è completo e restituisce.

Il DialogContext chiama questo metodo quando continua la finestra di dialogo.

Per segnalare al contesto del dialogo che il dialogo è stato completato, attendere DialogContext.endDialog prima di uscire da questo metodo.

Vedere anche

• DialogContext.continueDialog

ereditato daDialog.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

Quando ne viene eseguito l'override in una classe derivata, reinserito l'utente per l'input.

function repromptDialog(_context: TurnContext, _instance: DialogInstance): Promise<void>

Parametri

Restituisce

Commenti

I dialoghi derivati che supportano la convalida e la logica di ripetizione della richiesta devono eseguire l'override di questo metodo. Per impostazione predefinita, questo metodo non ha alcun effetto.

Il DialogContext chiama questo metodo quando la finestra di dialogo corrente deve richiedere nuovamente l'input dell'utente. Questo metodo viene implementato per i dialoghi di richiesta.

Vedere anche

• DialogContext.repromptDialog
• Prompt

ereditato daDialog.repromptDialog

Quando ne viene eseguito l'override in una classe derivata, riprende il dialogo al termine del dialogo sopra di esso nello stack.

function resumeDialog(dc: DialogContext, reason: DialogReason, result?: any): Promise<DialogTurnResult>

Parametri

Restituisce

Promessa che risolve il risultato del turno del dialogo.

Commenti

I dialoghi derivati che supportano conversazioni a più turni devono eseguire l'override di questo metodo. Per impostazione predefinita, questo metodo segnala che il dialogo è completo e restituisce.

Il DialogContext chiama questo metodo quando riprende la finestra di dialogo. Se la finestra di dialogo precedente sullo stack ha restituito un valore, tale valore si trova nel parametro result.

Per avviare una finestra di dialogo di figlio , usare DialogContext.beginDialog o DialogContext.prompt; Tuttavia, questo dialogo non sarà necessariamente quello che ha avviato il dialogo figlio. Per segnalare al contesto del dialogo che il dialogo è stato completato, attendere DialogContext.endDialog prima di uscire da questo metodo.

Vedere anche

• DialogContext.endDialog

ereditato daDialog.resumeDialog