Dialog class

Paket:

botbuilder-dialogs

Menentukan perilaku inti untuk semua dialog.

Memperluas

Configurable

Konstruktor

Dialog(string)

Membuat instans baru kelas Dialog .

Properti

EndOfTurn	Mendapatkan hasil akhir giliran default.
id	ID unik dialog. Mengatur ID unik dialog.
telemetryClient	Mendapatkan klien telemetri untuk dialog ini. Mengatur klien telemetri untuk dialog ini.

Metode

beginDialog(DialogContext, O)	Saat ditimpa di kelas turunan, memulai dialog.
continueDialog(DialogContext)	Saat ditimpa di kelas turunan, melanjutkan dialog.
endDialog(TurnContext, DialogInstance, DialogReason)	Saat ditimpa di kelas turunan, lakukan pembersihan untuk dialog sebelum berakhir.
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)	Saat ditimpa di kelas turunan, melanjutkan dialog setelah dialog di atasnya pada tumpukan selesai.

Metode yang Diwarisi

configure(Record<string, unknown>)	Metode fasih untuk mengonfigurasi objek.
getConverter(string)

Detail Konstruktor

Dialog(string)

Membuat instans baru kelas Dialog .

new Dialog(dialogId?: string)

Parameter

dialogId

string

Fakultatif. ID unik dialog.

Detail Properti

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.

id

ID unik dialog. Mengatur ID unik dialog.

string id

Nilai Properti

string

Id untuk dialog.

Keterangan

Ini akan dibuat secara otomatis jika tidak ditentukan.

telemetryClient

Mendapatkan klien telemetri untuk dialog ini. Mengatur klien telemetri untuk dialog ini.

BotTelemetryClient telemetryClient

Nilai Properti

BotTelemetryClient

BotTelemetryClient digunakan untuk pengelogan.

Detail Metode

beginDialog(DialogContext, O)

Saat ditimpa di kelas turunan, memulai dialog.

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

Parameter

dc

DialogContext

Konteks untuk giliran dialog saat ini.

options

O

Fakultatif. Argumen yang akan digunakan saat dialog dimulai.

Mengembalikan

Promise<DialogTurnResult>

Keterangan

Dialog turunan harus mengambil alih metode ini.

DialogContext memanggil metode ini saat membuat DialogInstance baru untuk dialog ini, mendorongnya ke tumpukan dialog, dan memulai dialog.

Dialog yang mewakili percakapan satu giliran harus menunggu DialogContext.endDialog sebelum keluar dari metode ini.

Lihat juga

• DialogContext.beginDialog
• DialogContext.replaceDialog

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

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

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.

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.

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
• Perintah

resumeDialog(DialogContext, DialogReason, any)

Saat ditimpa di kelas turunan, melanjutkan dialog setelah dialog di atasnya pada tumpukan selesai.

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

Parameter

dc

DialogContext

Konteks untuk giliran dialog saat ini.

reason

DialogReason

Alasan dialog melanjutkan. Ini biasanya akan DialogReason.endCalled

result

any

Fakultatif. Nilai pengembalian, jika ada, dari dialog yang berakhir.

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. Jika dialog sebelumnya pada tumpukan mengembalikan nilai, nilai tersebut berada dalam parameter result.

Untuk memulai dialog anak , gunakan DialogContext.beginDialog atau DialogContext.prompt; namun, dialog ini tidak akan selalu menjadi dialog yang memulai dialog anak. Untuk memberi sinyal ke konteks dialog bahwa dialog ini telah selesai, tunggu DialogContext.endDialog sebelum keluar dari metode ini.

Lihat juga

• DialogContext.endDialog

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 DariConfigurable.configure

getConverter(string)

function getConverter(_property: string): Converter | ConverterFactory

Parameter

_property

string

Kunci konfigurasi pemilih bersyarah.

Mengembalikan

Converter | ConverterFactory

Pengonversi untuk konfigurasi pemilih.

Diwarisi DariConfigurable.getConverter