BeginDialog class

Pacchetto:

botbuilder-dialogs-adaptive

Azione che inizia l'esecuzione di un'altra finestra di dialogo , al termine, verrà restituita al chiamante.

Extends

BaseInvokeDialog<O>

Costruttori

BeginDialog(string, O)

Crea una nuova istanza di BeginDialog.

Proprietà

$kind
disabled	Espressione facoltativa che, se è true, disabiliterà questa azione.
resultProperty	(Facoltativo) percorso della proprietà in cui archiviare il risultato della finestra di dialogo.

Proprietà ereditate

activityProcessed	Valore che indica se il nuovo dialogo deve elaborare l'attività.
dialog	Finestra di dialogo da chiamare.
EndOfTurn	Ottiene un risultato di fine turno predefinito.
id
options	Opzioni configurabili per la finestra di dialogo.
telemetryClient

Metodi

beginDialog(DialogContext, O)	Viene chiamato all'avvio della finestra di dialogo ed è stato eseguito il push nello stack di dialoghi.
getConverter(Object)
resumeDialog(DialogContext, DialogReason, any)	Chiamato quando un dialogo figlio completato il suo turno, restituendo il controllo a questa finestra di dialogo.

Metodi ereditati

configure(Record<string, unknown>)	Metodo Fluent per la configurazione dell'oggetto.
continueDialog(DialogContext)	Quando ne viene eseguito l'override in una classe derivata, continua la finestra di dialogo.
endDialog(TurnContext, DialogInstance, DialogReason)	Quando sottoposto a override in una classe derivata, esegue la pulizia per la finestra di dialogo prima che termini.
getDependencies()	Ottiene le dipendenze finestra di dialogo figlio in modo che possano essere aggiunte ai contenitori finestra di dialogo.
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)	Quando ne viene eseguito l'override in una classe derivata, reinserito l'utente per l'input.

Dettagli costruttore

BeginDialog(string, O)

Crea una nuova istanza di BeginDialog.

new BeginDialog(dialogIdToCall: string, options?: O)

Parametri

dialogIdToCall

string

ID della finestra di dialogo da chiamare.

options

O

(Facoltativo) Opzioni statiche per passare la finestra di dialogo chiamata.

Dettagli proprietà

$kind

static $kind: string

Valore della proprietà

string

disabled

Espressione facoltativa che, se è true, disabiliterà questa azione.

disabled?: BoolExpression

Valore della proprietà

BoolExpression

resultProperty

(Facoltativo) percorso della proprietà in cui archiviare il risultato della finestra di dialogo.

resultProperty?: StringExpression

Valore della proprietà

StringExpression

Dettagli proprietà ereditate

activityProcessed

Valore che indica se il nuovo dialogo deve elaborare l'attività.

activityProcessed: BoolExpression

Valore della proprietà

BoolExpression

Ereditato daBaseInvokeDialog.activityProcessed

dialog

Finestra di dialogo da chiamare.

dialog: DialogExpression

Valore della proprietà

DialogExpression

Ereditato daBaseInvokeDialog.dialog

EndOfTurn

Ottiene un risultato di fine turno predefinito.

static EndOfTurn: DialogTurnResult

Valore della proprietà

DialogTurnResult

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 da Dialog.EndOfTurn

id

id: string

Valore della proprietà

string

ereditato da Dialog.id

options

Opzioni configurabili per la finestra di dialogo.

options: ObjectExpression<object>

Valore della proprietà

ObjectExpression<object>

Ereditato daBaseInvokeDialog.options

telemetryClient

telemetryClient: BotTelemetryClient

Valore della proprietà

BotTelemetryClient

ereditato da Dialog.telemetryClient

Dettagli metodo

beginDialog(DialogContext, O)

Viene chiamato all'avvio della finestra di dialogo ed è stato eseguito il push nello stack di dialoghi.

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

Parametri

dc

DialogContext

Il DialogContext per il turno di conversazione corrente.

options

O

Opzionale. Informazioni iniziali da passare alla finestra di dialogo.

Restituisce

Promise<DialogTurnResult>

Oggetto Promise che rappresenta l'operazione asincrona.

getConverter(Object)

function getConverter(property: Object): Converter | ConverterFactory

Parametri

property

Object

Chiave della configurazione del selettore condizionale.

Restituisce

Converter | ConverterFactory

Convertitore per la configurazione del selettore.

resumeDialog(DialogContext, DialogReason, any)

Chiamato quando un dialogo figlio completato il suo turno, restituendo il controllo a questa finestra di dialogo.

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

Parametri

dc

DialogContext

Il DialogContext per il turno di conversazione corrente.

reason

DialogReason

(xref:botbuilder-dialogs. DialogReason), motivo per cui il dialogo è ripreso.

result

any

Opzionale. Valore restituito dalla finestra di dialogo chiamata. Il tipo del valore restituito dipende dal dialogo figlio.

Restituisce

Promise<DialogTurnResult>

Oggetto Promise che rappresenta l'operazione asincrona.

Dettagli dei metodi ereditati

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 da Configurable.configure

continueDialog(DialogContext)

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

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

Parametri

dc

DialogContext

Contesto del turno di dialogo corrente.

Restituisce

Promise<DialogTurnResult>

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 da Dialog.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

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

Ereditato da Dialog.endDialog

getDependencies()

Ottiene le dipendenze finestra di dialogo figlio in modo che possano essere aggiunte ai contenitori finestra di dialogo.

function getDependencies(): Dialog<__type>[]

Restituisce

Dialog<__type>[]

Le dipendenze della finestra di dialogo figlio.

Ereditato daBaseInvokeDialog.getDependencies

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 da Dialog.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 da Dialog.onDialogEvent

repromptDialog(TurnContext, DialogInstance)

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

_context

TurnContext

Oggetto di contesto per il turno.

_instance

DialogInstance

Informazioni sullo stato corrente per questa finestra di dialogo.

Restituisce

Promise<void>

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 da Dialog.repromptDialog