SkillDialog class

Finestra di dialogo specializzata che può eseguire il wrapping delle chiamate remote a una competenza.

Extends

Commenti

Il parametro options in beginDialog deve essere un'istanza beginSkillDialogOptions con i parametri iniziali per la finestra di dialogo.

Costruttori

SkillDialog(SkillDialogOptions, string)

Finestra di dialogo di esempio in grado di eseguire il wrapping delle chiamate remote a una competenza.

Proprietà

id

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

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

beginDialog(DialogContext, BeginSkillDialogOptions)

Chiamato quando viene avviato il dialogo di competenza e inserito nello stack di dialoghi.

continueDialog(DialogContext)

Chiamato quando il dialogo di competenza viene continua, dove è il dialogo attivo e l'utente risponde con un nuovo Activity.

endDialog(TurnContext, DialogInstance, DialogReason)

Chiamato quando termina il dialogo della competenza.

repromptDialog(TurnContext, DialogInstance)

Chiamato quando la finestra di dialogo della competenza deve richiedere di nuovo all'utente l'input.

resumeDialog(DialogContext, DialogReason, any)

Chiamato quando un dialogo di competenza 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.

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.

Dettagli costruttore

SkillDialog(SkillDialogOptions, string)

Finestra di dialogo di esempio in grado di eseguire il wrapping delle chiamate remote a una competenza.

new SkillDialog(dialogOptions: SkillDialogOptions, dialogId?: string)

Parametri

dialogOptions
SkillDialogOptions

Opzioni per eseguire la finestra di dialogo delle competenze.

dialogId

string

ID del dialogo.

Commenti

Il parametro options in beginDialog() deve essere un oggetto SkillDialogArgs con i parametri iniziali per il dialogo.

Dettagli proprietà

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.

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 metodo

beginDialog(DialogContext, BeginSkillDialogOptions)

Chiamato quando viene avviato il dialogo di competenza e inserito nello stack di dialoghi.

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

Parametri

dc
DialogContext

Il DialogContext per il turno di conversazione corrente.

options
BeginSkillDialogOptions

Informazioni iniziali da passare alla finestra di dialogo.

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.

continueDialog(DialogContext)

Chiamato quando il dialogo di competenza viene continua, dove è il dialogo attivo e l'utente risponde con un nuovo Activity.

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.

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. Il risultato può contenere anche un valore restituito.

endDialog(TurnContext, DialogInstance, DialogReason)

Chiamato quando termina il dialogo della competenza.

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

Parametri

context

TurnContext

Oggetto TurnContext per questo turno.

instance
DialogInstance

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

reason
DialogReason

(xref:botbuilder-dialogs. DialogReason) perché il dialogo è terminato.

Restituisce

Promise<void>

Promessa che rappresenta l'operazione asincrona.

repromptDialog(TurnContext, DialogInstance)

Chiamato quando la finestra di dialogo della competenza deve richiedere di nuovo all'utente l'input.

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

Parametri

context

TurnContext

Oggetto TurnContext per questo turno.

instance
DialogInstance

Informazioni sullo stato per questa finestra di dialogo.

Restituisce

Promise<void>

Promessa che rappresenta l'operazione asincrona.

resumeDialog(DialogContext, DialogReason, any)

Chiamato quando un dialogo di competenza 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

DialogContext per il turno corrente della conversazione.

_reason
DialogReason

(xref:botbuilder-dialogs. DialogReason) perché il dialogo è 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 daConfigurable.configure

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