Case class

Paket:

botbuilder-dialogs-adaptive

Kasus cakupan tindakan.

Memperluas

ActionScope

Konstruktor

Case(string, Dialog[])

Menginisialisasi instans baru kelas Kasus .

Properti

value

Mendapatkan atau menetapkan ekspresi nilai yang akan dibandingkan dengan kondisi.

Properti yang Diwariskan

actions	Tindakan yang akan dijalankan.
EndOfTurn	Mendapatkan hasil akhir giliran default.
id
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)	Dipanggil ketika Dialog dilanjutkan, di mana dialog tersebut adalah dialog aktif dan pengguna membalas dengan aktivitas baru.
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()	Mendapatkan string unik yang mewakili versi dialog ini. Jika versi berubah antara mengubah sistem dialog akan memancarkan peristiwa DialogChanged.
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

Case(string, Dialog[])

Menginisialisasi instans baru kelas Kasus .

new Case(value?: string, actions?: Dialog[])

Parameter

value

string

Fakultatif. Nilai string kasus.

actions

Dialog[]

Fakultatif. Daftar tindakan Dialog yang dapat diubah.

Detail Properti

value

Mendapatkan atau menetapkan ekspresi nilai yang akan dibandingkan dengan kondisi.

value: string

Nilai Properti

string

Detail Properti yang Diwariskan

actions

Tindakan yang akan dijalankan.

actions: Dialog[]

Nilai Properti

Dialog[]

Diwariskan Dari ActionScope.actions

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

Diwariskan DariActionScope.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)

Dipanggil ketika Dialog dilanjutkan, 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.

Diwariskan DariActionScope.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

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.

Diwariskan DariActionScope.getConverter

getDependencies()

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

function getDependencies(): Dialog[]

Mengembalikan

Dialog[]

Dialog anak dependensi.

Diwarisi DariActionScope.getDependencies

getVersion()

Mendapatkan string unik yang mewakili versi dialog ini. Jika versi berubah antara mengubah sistem dialog akan memancarkan peristiwa DialogChanged.

function getVersion(): string

Mengembalikan

string

string unik yang seharusnya hanya berubah ketika dialog telah berubah dengan cara yang harus memulai ulang dialog.

Diwariskan DariActionScope.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.

Diwarisi DariActionScope.resumeDialog