ChoicePrompt class

Paket:

botbuilder-dialogs

Meminta pengguna untuk memilih dari daftar pilihan.

Memperluas

Prompt<FoundChoice>

Keterangan

Secara default, perintah akan kembali ke dialog panggilan objek FoundChoice yang berisi pilihan yang dipilih.

Konstruktor

ChoicePrompt(string, PromptValidator<FoundChoice>, string, ChoiceDefaultsChoicePrompt)

Membuat instans ChoicePrompt baru.

Properti

choiceOptions	Opsi tambahan diteruskan ke ChoiceFactory dan digunakan untuk mengubah gaya pilihan yang dirender kepada pengguna.
defaultLocale	Perintah lokal default yang harus dikenali.
id	ID unik dialog. Mengatur ID unik dialog.
recognizerOptions	Opsi tambahan diteruskan ke fungsi recognizeChoices() yang mendasar.
style	Gaya pilihan "ya" dan "tidak" yang dirender kepada pengguna saat meminta.
telemetryClient	Mendapatkan klien telemetri untuk dialog ini. Mengatur klien telemetri untuk dialog ini.

Properti yang Diwariskan

EndOfTurn

Mendapatkan hasil akhir giliran default.

Metode yang Diwarisi

beginDialog(DialogContext, PromptOptions)	Dipanggil saat dialog perintah didorong ke tumpukan dialog dan sedang diaktifkan.
configure(Record<string, unknown>)	Metode fasih untuk mengonfigurasi objek.
continueDialog(DialogContext)	Dipanggil saat dialog perintah 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(string)
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)	Dipanggil ketika dialog perintah telah diminta untuk meminta kembali input kepada pengguna.
resumeDialog(DialogContext, DialogReason, any)	Dipanggil saat dialog perintah dilanjutkan menjadi dialog aktif pada tumpukan dialog, seperti ketika dialog aktif sebelumnya pada tumpukan selesai.

Detail Konstruktor

ChoicePrompt(string, PromptValidator<FoundChoice>, string, ChoiceDefaultsChoicePrompt)

Membuat instans ChoicePrompt baru.

new ChoicePrompt(dialogId: string, validator?: PromptValidator<FoundChoice>, defaultLocale?: string, choiceDefaults?: ChoiceDefaultsChoicePrompt)

Parameter

dialogId

string

ID unik dialog dalam DialogSetinduknya .

validator

PromptValidator<FoundChoice>

Validator (Opsional) yang akan dipanggil setiap kali pengguna merespons permintaan. Jika validator membalas dengan pesan, tidak ada permintaan coba lagi tambahan yang akan dikirim.

defaultLocale

string

(Opsional) lokal untuk digunakan jika dc.context.activity.locale tidak ditentukan. Default ke nilai en-us.

choiceDefaults

ChoiceDefaultsChoicePrompt

(Opsional) Mengambil alih kamus _choiceDefaults yang didukung Bot Framework SDK (untuk pelokalan permintaan). Harus diteruskan ke setiap ConfirmPrompt yang memerlukan default pilihan kustom.

Detail Properti

choiceOptions

Opsi tambahan diteruskan ke ChoiceFactory dan digunakan untuk mengubah gaya pilihan yang dirender kepada pengguna.

choiceOptions: ChoiceFactoryOptions | undefined

Nilai Properti

ChoiceFactoryOptions | undefined

defaultLocale

Perintah lokal default yang harus dikenali.

defaultLocale: string | undefined

Nilai Properti

string | undefined

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.

recognizerOptions

Opsi tambahan diteruskan ke fungsi recognizeChoices() yang mendasar.

recognizerOptions: FindChoicesOptions | undefined

Nilai Properti

FindChoicesOptions | undefined

style

Gaya pilihan "ya" dan "tidak" yang dirender kepada pengguna saat meminta.

style: ListStyle

Nilai Properti

ListStyle

Keterangan

Default ke ListStyle.auto.

telemetryClient

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

BotTelemetryClient telemetryClient

Nilai Properti

BotTelemetryClient

BotTelemetryClient digunakan untuk pengelogan.

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

Detail Metode yang Diwarisi

beginDialog(DialogContext, PromptOptions)

Dipanggil saat dialog perintah didorong ke tumpukan dialog dan sedang diaktifkan.

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

Parameter

dc

DialogContext

DialogContext untuk pergantian percakapan saat ini.

options

PromptOptions

Fakultatif. PromptOptions, informasi tambahan untuk diteruskan ke perintah yang sedang dimulai.

Mengembalikan

Promise<DialogTurnResult>

Promise yang mewakili operasi asinkron.

Keterangan

Jika tugas berhasil, hasilnya menunjukkan apakah perintah masih aktif setelah giliran diproses oleh perintah.

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

continueDialog(DialogContext)

Dipanggil saat dialog perintah 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.

Keterangan

Jika tugas berhasil, hasilnya menunjukkan apakah dialog masih aktif setelah giliran diproses oleh dialog. Perintah umumnya terus menerima balasan pengguna sampai menerima balasan pengguna sebagai input yang valid untuk permintaan tersebut.

Diwariskan DariPrompt.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(string)

function getConverter(_property: string): Converter | ConverterFactory

Parameter

_property

string

Kunci konfigurasi pemilih bersyarah.

Mengembalikan

Converter | ConverterFactory

Pengonversi untuk konfigurasi pemilih.

Diwarisi DariConfigurable.getConverter

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.

Diwarisi Dari dialog.onDialogEvent

repromptDialog(TurnContext, DialogInstance)

Dipanggil ketika dialog perintah telah diminta untuk meminta kembali input kepada pengguna.

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

Parameter

context

TurnContext

(xref:botbuilder-core. TurnContext), konteks untuk pergantian percakapan saat ini dengan pengguna.

instance

DialogInstance

(xref:botbuilder-dialogs. DialogInstance), instans dialog pada tumpukan.

Mengembalikan

Promise<void>

Promise yang mewakili operasi asinkron.

Diwarisi DariPrompt.repromptDialog

resumeDialog(DialogContext, DialogReason, any)

Dipanggil saat dialog perintah dilanjutkan menjadi dialog aktif pada tumpukan dialog, seperti ketika dialog aktif sebelumnya pada tumpukan selesai.

function resumeDialog(dc: DialogContext, _reason: DialogReason, _result?: any): Promise<DialogTurnResult>

Parameter

dc

DialogContext

DialogContext untuk pergantian percakapan saat ini.

_reason

DialogReason

Enum yang menunjukkan mengapa dialog dilanjutkan.

_result

any

Opsional, nilai yang dikembalikan dari dialog sebelumnya pada tumpukan. Jenis nilai yang dikembalikan tergantung pada dialog sebelumnya.

Mengembalikan

Promise<DialogTurnResult>

Janji yang mewakili operasi asinkron.

Keterangan

Jika tugas berhasil, hasilnya menunjukkan apakah dialog masih aktif setelah giliran diproses oleh dialog.

Diwariskan DariPrompt.resumeDialog