BeginSkill class

Pacchetto:

botbuilder-dialogs-adaptive

Iniziare una competenza.

Extends

SkillDialog

Costruttori

BeginSkill(SkillDialogOptions)

Crea una nuova istanza di "BeginSkillDialog".

Proprietà

$kind
activity	Modello per l'attività.
activityProcessed	Valore che indica se la nuova finestra di dialogo deve elaborare l'attività.
allowInterruptions	Criterio di interruzione.
botId	ID app Microsoft che chiamerà la competenza.
connectionName	Opzionale. Nome connessione OAuth per il bot padre.
disabled	Espressione facoltativa che se è true disabiliterà questa azione.
resultProperty	Percorso della proprietà facoltativo in cui archiviare il risultato della finestra di dialogo.
skillAppId	ID app Microsoft per la competenza.
skillEndpoint	Endpoint /api/messages per la competenza.
skillHostEndpoint	URL di callback per l'host di competenze.

Proprietà ereditate

EndOfTurn	Ottiene un risultato di fine turno predefinito.
id
telemetryClient

Metodi

beginDialog(DialogContext, BeginSkillDialogOptions)	Viene chiamato all'avvio della finestra di dialogo ed è stato eseguito il push nello stack di dialoghi.
continueDialog(DialogContext)	Chiamato quando la finestra di dialogo continua continua, dove è il dialogo attivo e l'utente risponde con una nuova attività.
endDialog(TurnContext, DialogInstance, DialogReason)	Viene chiamato quando termina il finestra di dialogo .
getConverter(Object)
repromptDialog(TurnContext, DialogInstance)	Chiamato quando la finestra di dialogo deve richiedere di nuovo l'input all'utente.
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.
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

BeginSkill(SkillDialogOptions)

Crea una nuova istanza di "BeginSkillDialog".

new BeginSkill(options?: SkillDialogOptions)

Parametri

options

SkillDialogOptions

Opzioni facoltative usate per configurare la finestra di dialogo delle competenze.

Dettagli proprietà

$kind

static $kind: string

Valore della proprietà

string

activity

Modello per l'attività.

activity: TemplateInterface<Partial<Activity>, DialogStateManager>

Valore della proprietà

TemplateInterface<Partial<Activity>, DialogStateManager>

activityProcessed

Valore che indica se la nuova finestra di dialogo deve elaborare l'attività.

activityProcessed: BoolExpression

Valore della proprietà

BoolExpression

Commenti

Il valore predefinito per questo valore sarà true, il che significa che il nuovo dialogo non deve esaminare l'attività. È possibile impostare su false per inviare l'attività al nuovo dialogo.

allowInterruptions

Criterio di interruzione.

allowInterruptions: BoolExpression

Valore della proprietà

BoolExpression

botId

ID app Microsoft che chiamerà la competenza.

botId: StringExpression

Valore della proprietà

StringExpression

Commenti

Defauls a un valore di =settings.MicrosoftAppId che recupera l'ID bot dalle impostazioni.

connectionName

Opzionale. Nome connessione OAuth per il bot padre.

connectionName: StringExpression

Valore della proprietà

StringExpression

disabled

Espressione facoltativa che se è true disabiliterà questa azione.

disabled?: BoolExpression

Valore della proprietà

BoolExpression

resultProperty

Percorso della proprietà facoltativo in cui archiviare il risultato della finestra di dialogo.

resultProperty?: StringExpression

Valore della proprietà

StringExpression

skillAppId

ID app Microsoft per la competenza.

skillAppId: StringExpression

Valore della proprietà

StringExpression

skillEndpoint

Endpoint /api/messages per la competenza.

skillEndpoint: StringExpression

Valore della proprietà

StringExpression

skillHostEndpoint

URL di callback per l'host di competenze.

skillHostEndpoint: StringExpression

Valore della proprietà

StringExpression

Commenti

Defauls a un valore di =settings.SkillHostEndpoint che recupera l'endpoint dalle impostazioni.

Dettagli proprietà ereditate

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

Dettagli metodo

beginDialog(DialogContext, BeginSkillDialogOptions)

Viene chiamato all'avvio della finestra di dialogo ed è stato eseguito il push 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

Opzionale. Informazioni iniziali da passare alla finestra di dialogo.

Restituisce

Promise<DialogTurnResult>

Oggetto Promise che rappresenta l'operazione asincrona.

continueDialog(DialogContext)

Chiamato quando la finestra di dialogo continua 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>

Oggetto Promise che rappresenta l'operazione asincrona.

endDialog(TurnContext, DialogInstance, DialogReason)

Viene chiamato quando termina il finestra di dialogo .

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

Parametri

turnContext

TurnContext

(xref:botbuilder-core. TurnContext), oggetto di contesto per questo turno.

instance

DialogInstance

(xref:botbuilder-dialogs. DialogInstance), informazioni sullo stato associate all'istanza di questa finestra di dialogo nello stack di dialoghi.

reason

DialogReason

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

Restituisce

Promise<void>

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.

repromptDialog(TurnContext, DialogInstance)

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

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

Parametri

turnContext

TurnContext

(xref:botbuilder-core. TurnContext), oggetto di contesto per questo turno.

instance

DialogInstance

(xref:botbuilder-dialogs. DialogInstance), informazioni sullo stato per questa finestra di dialogo.

Restituisce

Promise<void>

Oggetto Promise che rappresenta l'operazione asincrona.

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<any>>

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<any>>

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

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