AdaptiveDialog class

Pacchetto:

botbuilder-dialogs-adaptive

Il dialogo adattivo modella la conversazione usando eventi ed eventi per adattarsi dinamicamente alla modifica del flusso di conversazione.

Extends

DialogContainer<O>

Costruttori

AdaptiveDialog(string)

Crea una nuova istanza di AdaptiveDialog.

Proprietà

$kind
autoEndDialog	Indica se terminare la finestra di dialogo quando non sono presenti azioni da eseguire.
conditionTracker
defaultResultProperty	Proprietà da restituire come risultato quando la finestra di dialogo termina quando non sono presenti altre azioni e AutoEndDialog = true.
generator	Opzionale. Override del generatore di linguaggio.
recognizer	Opzionale. Riconoscitore usato per analizzare qualsiasi espressione di messaggio.
schema	Imposta lo schema JSON per la finestra di dialogo. Ottiene lo schema JSON per la finestra di dialogo.
selector	Opzionale. Selettore per la selezione degli eventi possibili da eseguire.
triggers	Attivare i gestori per rispondere alle condizioni che modificano il piano in esecuzione.

Proprietà ereditate

dialogs	Set di dialoghi contenitori.
EndOfTurn	Ottiene un risultato di fine turno predefinito.
id
telemetryClient

Metodi

beginDialog(DialogContext, O)	Chiamato quando il dialogo viene avviato e inserito nello stack di dialoghi.
continueDialog(DialogContext)	Chiamato quando il dialogo viene continua, dove è il dialogo attivo e l'utente risponde con una nuova attività.
createChildContext(DialogContext)	Crea un figlio DialogContext per il contesto specificato.
endDialog(TurnContext, DialogInstance, DialogReason)	Chiamato quando termina il dialogo.
getConverter(Object)
getDependencies()	Ottiene dialog dipendenze enumerate.
repromptDialog(DialogContext | TurnContext, DialogInstance)	Riprova l'utente.
resumeDialog(DialogContext, DialogReason, any)	Chiamato quando un dialogo figlio ha 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.
findDialog(string)	Trova una finestra di dialogo figlio aggiunta in precedenza al contenitore.
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.

Dettagli costruttore

AdaptiveDialog(string)

Crea una nuova istanza di AdaptiveDialog.

new AdaptiveDialog(dialogId?: string)

Parametri

dialogId

string

(Facoltativo) ID univoco del componente all'interno del set di dialoghi padre.

Dettagli proprietà

$kind

static $kind: string

Valore della proprietà

string

autoEndDialog

Indica se terminare la finestra di dialogo quando non sono presenti azioni da eseguire.

autoEndDialog: BoolExpression

Valore della proprietà

BoolExpression

Commenti

Se true, quando non sono presenti azioni da eseguire, la finestra di dialogo corrente terminerà. Se false, quando non sono presenti azioni da eseguire, il dialogo corrente terminerà semplicemente il turno e sarà ancora attivo. Il valore predefinito è true.

conditionTracker

static conditionTracker: string

Valore della proprietà

string

defaultResultProperty

Proprietà da restituire come risultato quando la finestra di dialogo termina quando non sono presenti altre azioni e AutoEndDialog = true.

defaultResultProperty: string

Valore della proprietà

string

Commenti

Il valore predefinito è dialog.result.

generator

Opzionale. Override del generatore di linguaggio.

generator?: LanguageGenerator

Valore della proprietà

LanguageGenerator

recognizer

Opzionale. Riconoscitore usato per analizzare qualsiasi espressione di messaggio.

recognizer?: Recognizer

Valore della proprietà

Recognizer

schema

Imposta lo schema JSON per la finestra di dialogo. Ottiene lo schema JSON per la finestra di dialogo.

object schema

Valore della proprietà

object

Schema della finestra di dialogo.

selector

Opzionale. Selettore per la selezione degli eventi possibili da eseguire.

selector: TriggerSelector

Valore della proprietà

TriggerSelector

triggers

Attivare i gestori per rispondere alle condizioni che modificano il piano in esecuzione.

triggers: OnCondition[]

Valore della proprietà

OnCondition[]

Dettagli proprietà ereditate

dialogs

Set di dialoghi contenitori.

dialogs: DialogSet

Valore della proprietà

DialogSet

Ereditato da DialogContainer.dialogs

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

telemetryClient

telemetryClient: BotTelemetryClient

Valore della proprietà

BotTelemetryClient

ereditato da DialogContainer.telemetryClient

Dettagli metodo

beginDialog(DialogContext, O)

Chiamato quando il dialogo viene avviato e inserito 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

Informazioni iniziali facoltative da passare alla finestra di dialogo.

Restituisce

Promise<DialogTurnResult>

Promessa che rappresenta l'operazione asincrona.

continueDialog(DialogContext)

Chiamato quando il dialogo viene continua, dove è il dialogo attivo e l'utente risponde con una nuova attività.

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

Parametri

dc

DialogContext

Il DialogContext per il turno di conversazione corrente.

Restituisce

Promise<DialogTurnResult>

Promessa che rappresenta l'operazione asincrona.

createChildContext(DialogContext)

Crea un figlio DialogContext per il contesto specificato.

function createChildContext(dc: DialogContext): DialogContext

Parametri

dc

DialogContext

Il DialogContext per il turno di conversazione corrente.

Restituisce

DialogContext

Il figlio DialogContext o null se non viene trovato alcun AdaptiveDialogState. actions per il contesto specificato.

endDialog(TurnContext, DialogInstance, DialogReason)

Chiamato quando termina il dialogo.

function endDialog(turnContext: TurnContext, instance: DialogInstance, reason: DialogReason): Promise<void>

Parametri

turnContext

TurnContext

Oggetto di contesto per questo turno.

instance

DialogInstance

Informazioni sullo stato associate all'istanza di questa finestra di dialogo nello stack di dialoghi.

reason

DialogReason

Motivo per cui il dialogo è terminato.

Restituisce

Promise<void>

Promessa 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.

getDependencies()

Ottiene dialog dipendenze enumerate.

function getDependencies(): Dialog[]

Restituisce

Dialog[]

(xref:botbuilder-dialogs. Dipendenze enumerate della finestra di dialogo.

repromptDialog(DialogContext | TurnContext, DialogInstance)

Riprova l'utente.

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

Parametri

context

DialogContext | TurnContext

Oggetto di contesto per il turno.

instance

DialogInstance

Informazioni sullo stato corrente per questa finestra di dialogo.

Restituisce

Promise<void>

Promessa che rappresenta l'operazione asincrona.

resumeDialog(DialogContext, DialogReason, any)

Chiamato quando un dialogo figlio ha 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

Contesto del dialogo per il turno corrente della conversazione.

_reason

DialogReason

Motivo per cui il dialogo è stato ripreso.

_result

any

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

Restituisce

Promise<DialogTurnResult>

Promessa 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

findDialog(string)

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

function findDialog(dialogId: string): Dialog | undefined

Parametri

dialogId

string

ID della finestra di dialogo da cercare.

Restituisce

Dialog | undefined

Finestra di dialogo se trovata; in caso contrario null.

ereditato da DialogContainer.findDialog

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 DialogContainer.onDialogEvent