Bagikan melalui

DateTimeInput class

  • Referensi
Paket:
botbuilder-dialogs-adaptive

Dialog input untuk mengumpulkan tanggalwaktu dari pengguna.

Memperluas
InputDialog

Konstruktor

DateTimeInput(string, Partial<Activity> | string)

Menginisialisasi instans baru kelas InputDialog

Properti

$kind
defaultLocale
outputFormat

Properti yang Diwariskan

allowInterruptions

Kebijakan gangguan.
alwaysPrompt

Nilai yang menunjukkan apakah input harus selalu meminta pengguna terlepas dari adanya nilai atau tidak.
defaultValue

Nilai default untuk dialog input saat maxTurnCount terlampaui.
defaultValueResponse

Templat aktivitas yang akan dikirim ketika maxTurnCount telah tercapai dan nilai default digunakan.
disabled

Ekspresi opsional yang jika benar akan menonaktifkan tindakan ini.
EndOfTurn

Mendapatkan hasil akhir giliran default.
id
invalidPrompt

Templat aktivitas untuk dikirim ke pengguna setiap kali nilai yang disediakan tidak valid atau tidak.
maxTurnCount

Jumlah maksimum waktu untuk meminta nilai ini kepada pengguna sebelum dialog menyerah.
OPTIONS_PROPERTY
prompt

Aktivitas yang akan dikirim ke pengguna.
property

Ekspresi nilai tempat input akan terikat.
telemetryClient
TURN_COUNT_PROPERTY
unrecognizedPrompt

Templat aktivitas untuk mencoba kembali permintaan.
validations

Ekspresi yang dijalankan untuk memvalidasi input.
value

Ekspresi nilai yang dapat digunakan untuk menginisialisasi perintah input.
VALUE_PROPERTY

Metode

getConverter(Object)

Metode yang Diwarisi

beginDialog(DialogContext, any)

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

DateTimeInput(string, Partial<Activity> | string)

Menginisialisasi instans baru kelas InputDialog

new DateTimeInput(property?: string, prompt?: Partial<Activity> | string)

Parameter

property

string

Fakultatif. Ekspresi nilai tempat input akan terikat.

prompt

Partial<Activity> | string

Fakultatif. Aktivitas untuk dikirim ke pengguna, jika string ditentukan, itu akan membuat instans ActivityTemplate.

Detail Properti

$kind 

static $kind: string

Nilai Properti

string

defaultLocale 

defaultLocale: StringExpression

Nilai Properti

StringExpression

outputFormat 

outputFormat: StringExpression

Nilai Properti

StringExpression

Detail Properti yang Diwariskan

allowInterruptions

Kebijakan gangguan.

allowInterruptions: BoolExpression

Nilai Properti

BoolExpression

Diwariskan Dari InputDialog.allowInterruptions

alwaysPrompt

Nilai yang menunjukkan apakah input harus selalu meminta pengguna terlepas dari adanya nilai atau tidak.

alwaysPrompt: BoolExpression

Nilai Properti

BoolExpression

Diwarisi DariInputDialog.alwaysPrompt

defaultValue

Nilai default untuk dialog input saat maxTurnCount terlampaui.

defaultValue?: ValueExpression

Nilai Properti

ValueExpression

Diwarisi DariInputDialog.defaultValue

defaultValueResponse

Templat aktivitas yang akan dikirim ketika maxTurnCount telah tercapai dan nilai default digunakan.

defaultValueResponse: TemplateInterface<Partial<Activity>, DialogStateManager>

Nilai Properti

TemplateInterface<Partial<Activity>, DialogStateManager>

Diwarisi DariInputDialog.defaultValueResponse

disabled

Ekspresi opsional yang jika benar akan menonaktifkan tindakan ini.

disabled?: BoolExpression

Nilai Properti

BoolExpression

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

invalidPrompt

Templat aktivitas untuk dikirim ke pengguna setiap kali nilai yang disediakan tidak valid atau tidak.

invalidPrompt: TemplateInterface<Partial<Activity>, DialogStateManager>

Nilai Properti

TemplateInterface<Partial<Activity>, DialogStateManager>

Diwarisi Dari InputDialog.invalidPrompt

maxTurnCount

Jumlah maksimum waktu untuk meminta nilai ini kepada pengguna sebelum dialog menyerah.

maxTurnCount?: IntExpression

Nilai Properti

IntExpression

Diwarisi Dari InputDialog.maxTurnCount

OPTIONS_PROPERTY 

static OPTIONS_PROPERTY: string

Nilai Properti

string

Diwariskan DariInputDialog.OPTIONS_PROPERTY

prompt

Aktivitas yang akan dikirim ke pengguna.

prompt: TemplateInterface<Partial<Activity>, DialogStateManager>

Nilai Properti

TemplateInterface<Partial<Activity>, DialogStateManager>

Diwariskan DariInputDialog.prompt

property

Ekspresi nilai tempat input akan terikat.

property: StringExpression

Nilai Properti

StringExpression

Diwariskan Dari InputDialog.property

telemetryClient 

telemetryClient: BotTelemetryClient

Nilai Properti

BotTelemetryClient

Diwariskan Dari Dialog.telemetryClient

TURN_COUNT_PROPERTY 

static TURN_COUNT_PROPERTY: string

Nilai Properti

string

Diwariskan DariInputDialog.TURN_COUNT_PROPERTY

unrecognizedPrompt

Templat aktivitas untuk mencoba kembali permintaan.

unrecognizedPrompt: TemplateInterface<Partial<Activity>, DialogStateManager>

Nilai Properti

TemplateInterface<Partial<Activity>, DialogStateManager>

Diwariskan DariInputDialog.unrecognizedPrompt

validations

Ekspresi yang dijalankan untuk memvalidasi input.

validations: string[]

Nilai Properti

string[]

Diwariskan Dari InputDialog.validations

value

Ekspresi nilai yang dapat digunakan untuk menginisialisasi perintah input.

value: ValueExpression

Nilai Properti

ValueExpression

Diwariskan Dari inputDialog.value

VALUE_PROPERTY 

static VALUE_PROPERTY: string

Nilai Properti

string

Diwariskan DariInputDialog.VALUE_PROPERTY

Detail Metode

getConverter(Object) 

function getConverter(property: Object): Converter | ConverterFactory

Parameter

property

Object

Kunci konfigurasi pemilih bersyarah.

Mengembalikan

Converter | ConverterFactory

Pengonversi untuk konfigurasi pemilih.

Detail Metode yang Diwarisi

beginDialog(DialogContext, any)

Dipanggil saat dialog dimulai dan didorong ke tumpukan dialog.

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

Parameter

dc

DialogContext

Dialog Konteks untuk pergantian percakapan saat ini.

options

any

Fakultatif. Informasi awal untuk diteruskan ke dialog .

Mengembalikan

Promise<DialogTurnResult>

DialogTurnResultPromise mewakili operasi asinkron.

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

DialogTurnResultPromise mewakili operasi asinkron.

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

Diwariskan Dari dialog.endDialog

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

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>

DialogTurnResultPromise mewakili operasi asinkron.

Diwarisi DariInputDialog.resumeDialog