Bagikan melalui

BeginSkill class

  • Referensi
Paket:
botbuilder-dialogs-adaptive

Mulai Keterampilan.

Memperluas

SkillDialog

Konstruktor

BeginSkill(SkillDialogOptions)

Membuat instans 'BeginSkillDialog baru.

Properti

$kind
activity

Templat untuk aktivitas.
activityProcessed

Nilai yang menunjukkan apakah dialog baru harus memproses aktivitas.
allowInterruptions

Kebijakan gangguan.
botId

ID Aplikasi Microsoft yang akan memanggil keterampilan.
connectionName

Fakultatif. Nama Koneksi OAuth untuk Bot Induk.
disabled

Ekspresi opsional yang jika benar akan menonaktifkan tindakan ini.
resultProperty

Jalur properti opsional untuk menyimpan hasil dialog.
skillAppId

ID Aplikasi Microsoft untuk keterampilan tersebut.
skillEndpoint

Titik akhir /api/messages untuk keterampilan.
skillHostEndpoint

Url panggilan balik untuk host keterampilan.

Properti yang Diwariskan

EndOfTurn

Mendapatkan hasil akhir giliran default.
id
telemetryClient

Metode

beginDialog(DialogContext, BeginSkillDialogOptions)

Dipanggil saat dialog dimulai dan didorong ke tumpukan dialog.
continueDialog(DialogContext)

Dipanggil ketika Dialogdilanjutkan, di mana dialog tersebut adalah dialog aktif dan pengguna membalas dengan aktivitas baru.
endDialog(TurnContext, DialogInstance, DialogReason)

Dipanggil saat dialog berakhir.
getConverter(Object)
repromptDialog(TurnContext, DialogInstance)

Dipanggil saat dialog harus meminta kembali input kepada pengguna.
resumeDialog(DialogContext, DialogReason, any)

Dipanggil ketika Dialog anak menyelesaikan gilirannya, mengembalikan kontrol ke dialog ini.

Metode yang Diwarisi

configure(Record<string, unknown>)

Metode fasih untuk mengonfigurasi objek.
getVersion()

String yang dikodekan yang digunakan untuk membantu dalam deteksi perubahan bot pada penyebaran ulang.
onDialogEvent(DialogContext, DialogEvent)

Dipanggil ketika peristiwa telah dinaikkan, menggunakan DialogContext.emitEvent(), dengan dialog saat ini atau dialog yang dimulai dialog saat ini.

Detail Konstruktor

BeginSkill(SkillDialogOptions)

Membuat instans 'BeginSkillDialog baru.

new BeginSkill(options?: SkillDialogOptions)

Parameter

options

SkillDialogOptions

Opsi opsional yang digunakan untuk mengonfigurasi dialog keterampilan.

Detail Properti

$kind 

static $kind: string

Nilai Properti

string

activity

Templat untuk aktivitas.

activity: TemplateInterface<Partial<Activity>, DialogStateManager>

Nilai Properti

TemplateInterface<Partial<Activity>, DialogStateManager>

activityProcessed

Nilai yang menunjukkan apakah dialog baru harus memproses aktivitas.

activityProcessed: BoolExpression

Nilai Properti

BoolExpression

Keterangan

Default untuk ini akan benar, yang berarti dialog baru tidak boleh melihat aktivitas. Anda dapat mengatur ini ke false untuk mengirimkan aktivitas ke dialog baru.

allowInterruptions

Kebijakan gangguan.

allowInterruptions: BoolExpression

Nilai Properti

BoolExpression

botId

ID Aplikasi Microsoft yang akan memanggil keterampilan.

botId: StringExpression

Nilai Properti

StringExpression

Keterangan

Defauls ke nilai =settings.MicrosoftAppId yang mengambil ID bot dari pengaturan.

connectionName

Fakultatif. Nama Koneksi OAuth untuk Bot Induk.

connectionName: StringExpression

Nilai Properti

StringExpression

disabled

Ekspresi opsional yang jika benar akan menonaktifkan tindakan ini.

disabled?: BoolExpression

Nilai Properti

BoolExpression

resultProperty

Jalur properti opsional untuk menyimpan hasil dialog.

resultProperty?: StringExpression

Nilai Properti

StringExpression

skillAppId

ID Aplikasi Microsoft untuk keterampilan tersebut.

skillAppId: StringExpression

Nilai Properti

StringExpression

skillEndpoint

Titik akhir /api/messages untuk keterampilan.

skillEndpoint: StringExpression

Nilai Properti

StringExpression

skillHostEndpoint

Url panggilan balik untuk host keterampilan.

skillHostEndpoint: StringExpression

Nilai Properti

StringExpression

Keterangan

Defauls ke nilai =settings.SkillHostEndpoint yang mengambil titik akhir dari pengaturan.

Detail Properti yang Diwariskan

EndOfTurn

Mendapatkan hasil akhir giliran default.

static EndOfTurn: DialogTurnResult

Nilai Properti

DialogTurnResult

Keterangan

Hasil ini menunjukkan bahwa dialog (atau langkah logis dalam dialog) telah menyelesaikan pemrosesan untuk giliran saat ini, masih aktif, dan menunggu lebih banyak input.

Diwariskan Dari dialog.EndOfTurn

id 

id: string

Nilai Properti

string

Diwariskan Dari Dialog.id

telemetryClient 

telemetryClient: BotTelemetryClient

Nilai Properti

BotTelemetryClient

Diwariskan Dari Dialog.telemetryClient

Detail Metode

beginDialog(DialogContext, BeginSkillDialogOptions)

Dipanggil saat dialog dimulai dan didorong ke tumpukan dialog.

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

Parameter

dc

DialogContext

Dialog Konteks untuk pergantian percakapan saat ini.

options

BeginSkillDialogOptions

Fakultatif. Informasi awal untuk diteruskan ke dialog.

Mengembalikan

Promise<DialogTurnResult>

Promise yang mewakili operasi asinkron.

continueDialog(DialogContext)

Dipanggil ketika Dialogdilanjutkan, di mana dialog tersebut adalah dialog aktif dan pengguna membalas dengan aktivitas baru.

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

Parameter

dc

DialogContext

Dialog Konteks untuk pergantian percakapan saat ini.

Mengembalikan

Promise<DialogTurnResult>

Promise yang mewakili operasi asinkron.

endDialog(TurnContext, DialogInstance, DialogReason)

Dipanggil saat dialog berakhir.

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

Parameter

turnContext

TurnContext

(xref:botbuilder-core. TurnContext), objek konteks untuk giliran ini.

instance

DialogInstance

(xref:botbuilder-dialogs. DialogInstance), informasi status yang terkait dengan instans dialog ini pada tumpukan dialog.

reason

DialogReason

(xref:botbuilder-dialogs. DialogReason), alasan mengapa dialog berakhir.

Mengembalikan

Promise<void>

Promise yang mewakili operasi asinkron.

getConverter(Object) 

function getConverter(property: Object): Converter | ConverterFactory

Parameter

property

Object

Kunci konfigurasi pemilih bersyarah.

Mengembalikan

Converter | ConverterFactory

Pengonversi untuk konfigurasi pemilih.

repromptDialog(TurnContext, DialogInstance)

Dipanggil saat dialog harus meminta kembali input kepada pengguna.

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

Parameter

turnContext

TurnContext

(xref:botbuilder-core. TurnContext), objek konteks untuk giliran ini.

instance

DialogInstance

(xref:botbuilder-dialogs. DialogInstance), informasi status untuk dialog ini.

Mengembalikan

Promise<void>

Promise yang mewakili operasi asinkron.

resumeDialog(DialogContext, DialogReason, any)

Dipanggil ketika Dialog anak menyelesaikan gilirannya, mengembalikan kontrol ke dialog ini.

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

Parameter

dc

DialogContext

Dialog Konteks untuk pergantian percakapan saat ini.

reason

DialogReason

(xref:botbuilder-dialogs. DialogReason), alasan mengapa dialog dilanjutkan.

result

any

Fakultatif. Nilai yang dikembalikan dari dialog yang dipanggil. Jenis nilai yang dikembalikan tergantung pada dialog anak.

Mengembalikan

Promise<DialogTurnResult<any>>

Promise yang mewakili operasi asinkron.

Detail Metode yang Diwarisi

configure(Record<string, unknown>)

Metode fasih untuk mengonfigurasi objek.

function configure(config: Record<string, unknown>): this

Parameter

config

Record<string, unknown>

Pengaturan konfigurasi yang akan diterapkan.

Mengembalikan

this

yang dapat dikonfigurasi setelah operasi selesai.

Diwariskan Dari Configurable.configure

getVersion()

String yang dikodekan yang digunakan untuk membantu dalam deteksi perubahan bot pada penyebaran ulang.

function getVersion(): string

Mengembalikan

string

String unik yang seharusnya hanya berubah ketika dialog telah berubah dengan cara yang harus menghidupkan ulang dialog.

Keterangan

Ini default untuk mengembalikan dialog id tetapi dapat ditimpa untuk memberikan logika deteksi perubahan yang lebih tepat. Setiap dialog pada tumpukan yang memiliki perubahan versinya akan mengakibatkan peristiwa versionChanged akan dinaikkan. Jika kejadian ini tidak ditangani oleh bot, kesalahan akan dilemparkan yang mengakibatkan logika handler kesalahan bot dijalankan.

Mengembalikan string kosong akan menonaktifkan pelacakan versi untuk komponen bersama-sama.

Diwariskan Dari Dialog.getVersion

onDialogEvent(DialogContext, DialogEvent)

Dipanggil ketika peristiwa telah dinaikkan, menggunakan DialogContext.emitEvent(), dengan dialog saat ini atau dialog yang dimulai dialog saat ini.

function onDialogEvent(dc: DialogContext, e: DialogEvent): Promise<boolean>

Parameter

dc

DialogContext

Konteks dialog untuk pergantian percakapan saat ini.

e

DialogEvent

Peristiwa yang sedang dinaikkan.

Mengembalikan

Promise<boolean>

True jika peristiwa ditangani oleh dialog saat ini dan gelembung harus berhenti.

Diwariskan Dari dialog.onDialogEvent