DynamicBeginDialog class

Paket:

botbuilder-dialogs-adaptive

Tindakan BeginDialog internal yang secara dinamis mengikat x.schema/x.dialog untuk memanggil sumber daya x.dialog dengan properti sebagai opsi.

Memperluas

BeginDialog

Konstruktor

DynamicBeginDialog(string, O)

Membuat instans BeginDialog baru.

Properti

$kind

Properti yang Diwariskan

activityProcessed	Nilai yang menunjukkan apakah akan memiliki dialog baru harus memproses aktivitas.
dialog	Dialog yang akan dipanggil.
disabled	Ekspresi opsional yang jika benar akan menonaktifkan tindakan ini.
EndOfTurn	Mendapatkan hasil akhir giliran default.
id
options	Opsi yang dapat dikonfigurasi untuk dialog.
resultProperty	(Opsional) jalur properti untuk menyimpan hasil dialog.
telemetryClient

Metode yang Diwarisi

beginDialog(DialogContext, O)	Dipanggil saat dialog dimulai dan didorong ke tumpukan dialog.
configure(Record<string, unknown>)	Metode fasih untuk mengonfigurasi objek.
continueDialog(DialogContext)	Saat ditimpa di kelas turunan, melanjutkan dialog.
endDialog(TurnContext, DialogInstance, DialogReason)	Saat ditimpa di kelas turunan, lakukan pembersihan untuk dialog sebelum berakhir.
getConverter(Object)
getDependencies()	Mendapatkan dependensi Dialog anak sehingga dapat ditambahkan ke kontainer Dialog diatur.
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.
repromptDialog(TurnContext, DialogInstance)	Saat ditimpa di kelas turunan, promporsi ulang pengguna untuk input.
resumeDialog(DialogContext, DialogReason, any)	Dipanggil ketika Dialog anak menyelesaikan gilirannya, mengembalikan kontrol ke dialog ini.

Detail Konstruktor

DynamicBeginDialog(string, O)

Membuat instans BeginDialog baru.

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

Parameter

dialogIdToCall

string

ID dialog untuk dipanggil.

options

O

(Opsional) opsi statis untuk meneruskan dialog yang dipanggil.

Detail Properti

$kind

static $kind: string

Nilai Properti

string

Detail Properti yang Diwariskan

activityProcessed

Nilai yang menunjukkan apakah akan memiliki dialog baru harus memproses aktivitas.

activityProcessed: BoolExpression

Nilai Properti

BoolExpression

Diwarisi DariBaseInvokeDialog.activityProcessed

dialog

Dialog yang akan dipanggil.

dialog: DialogExpression

Nilai Properti

DialogExpression

Diwariskan DariBaseInvokeDialog.dialog

disabled

Ekspresi opsional yang jika benar akan menonaktifkan tindakan ini.

disabled?: BoolExpression

Nilai Properti

BoolExpression

Diwariskan DariBeginDialog.disabled

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

options

Opsi yang dapat dikonfigurasi untuk dialog.

options: ObjectExpression<object>

Nilai Properti

ObjectExpression<object>

Diwariskan DariBaseInvokeDialog.options

resultProperty

(Opsional) jalur properti untuk menyimpan hasil dialog.

resultProperty?: StringExpression

Nilai Properti

StringExpression

Diwarisi DariBeginDialog.resultProperty

telemetryClient

telemetryClient: BotTelemetryClient

Nilai Properti

BotTelemetryClient

Diwariskan Dari Dialog.telemetryClient

Detail Metode yang Diwarisi

beginDialog(DialogContext, O)

Dipanggil saat dialog dimulai dan didorong ke tumpukan dialog.

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

Parameter

dc

DialogContext

Dialog Konteks untuk pergantian percakapan saat ini.

options

O

Fakultatif. Informasi awal untuk diteruskan ke dialog.

Mengembalikan

Promise<DialogTurnResult>

Promise yang mewakili operasi asinkron.

Diwarisi DariBeginDialog.beginDialog

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

continueDialog(DialogContext)

Saat ditimpa di kelas turunan, melanjutkan dialog.

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

Parameter

dc

DialogContext

Konteks untuk giliran dialog saat ini.

Mengembalikan

Promise<DialogTurnResult>

Janji yang menyelesaikan hasil giliran dialog.

Keterangan

Dialog turunan yang mendukung percakapan beberapa giliran harus mengambil alih metode ini. Secara default, metode ini memberi sinyal bahwa dialog selesai dan kembali.

DialogContext memanggil metode ini saat melanjutkan dialog.

Untuk memberi sinyal ke konteks dialog bahwa dialog ini telah selesai, tunggu DialogContext.endDialog sebelum keluar dari metode ini.

Lihat juga

• DialogContext.continueDialog

Diwariskan Dari Dialog.lanjutkanDialog

endDialog(TurnContext, DialogInstance, DialogReason)

Saat ditimpa di kelas turunan, lakukan pembersihan untuk dialog sebelum berakhir.

function endDialog(_context: TurnContext, _instance: DialogInstance, _reason: DialogReason): Promise<void>

Parameter

_context

TurnContext

Objek konteks untuk giliran.

_instance

DialogInstance

Informasi status saat ini untuk dialog ini.

_reason

DialogReason

Alasan dialog berakhir.

Mengembalikan

Promise<void>

Keterangan

Dialog turunan yang perlu melakukan pengelogan atau pembersihan sebelum berakhir harus mengambil alih metode ini. Secara default, metode ini tidak berpengaruh.

DialogContext memanggil metode ini ketika dialog saat ini berakhir.

Lihat juga

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

Diwariskan Dari dialog.endDialog

getConverter(Object)

function getConverter(property: Object): Converter | ConverterFactory

Parameter

property

Object

Kunci konfigurasi pemilih bersyarah.

Mengembalikan

Converter | ConverterFactory

Pengonversi untuk konfigurasi pemilih.

Diwarisi DariBeginDialog.getConverter

getDependencies()

Mendapatkan dependensi Dialog anak sehingga dapat ditambahkan ke kontainer Dialog diatur.

function getDependencies(): Dialog<__type>[]

Mengembalikan

Dialog<__type>[]

Dialog anak dependensi.

Diwarisi DariBaseInvokeDialog.getDependencies

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

repromptDialog(TurnContext, DialogInstance)

Saat ditimpa di kelas turunan, promporsi ulang pengguna untuk input.

function repromptDialog(_context: TurnContext, _instance: DialogInstance): Promise<void>

Parameter

_context

TurnContext

Objek konteks untuk giliran.

_instance

DialogInstance

Informasi status saat ini untuk dialog ini.

Mengembalikan

Promise<void>

Keterangan

Dialog turunan yang mendukung validasi dan logika permintaan ulang harus mengambil alih metode ini. Secara default, metode ini tidak berpengaruh.

DialogContext memanggil metode ini ketika dialog saat ini harus meminta kembali input dari pengguna. Metode ini diimplementasikan untuk dialog perintah.

Lihat juga

• DialogContext.repromptDialog
• Prompt

Diwariskan Dari dialog.repromptDialog

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>

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>

Promise yang mewakili operasi asinkron.

Diwariskan DariBeginDialog.resumeDialog