Bagikan melalui

StatePropertyAccessor interface

  • Referensi
Paket:
botbuilder-core

Menentukan metode untuk mengakses properti status yang dibuat di objek BotState .

Keterangan

Untuk membuat properti status dalam objet manajemen status, gunakan metode createPropertyT.

Metode

delete(TurnContext)

Menghapus properti yang dipertahankan dari objek penyimpanan cadangannya.
get(TurnContext)

Membaca properti yang bertahan dari objek penyimpanan cadangannya.
get(TurnContext, T)
set(TurnContext, T)

Menetapkan nilai baru ke objek penyimpanan cadangan properti.

Detail Metode

delete(TurnContext)

Menghapus properti yang dipertahankan dari objek penyimpanan cadangannya.

function delete(context: TurnContext): Promise<void>

Parameter

context
TurnContext

Konteks untuk pergantian percakapan saat ini dengan pengguna.

Mengembalikan

Promise<void>

Keterangan

Properti yang mendukung objek penyimpanan HARUS dimuat ke dalam memori pada akses pertama.

await myProperty.delete(context);

get(TurnContext)

Membaca properti yang bertahan dari objek penyimpanan cadangannya.

function get(context: TurnContext): Promise<T | undefined>

Parameter

context
TurnContext

Konteks untuk pergantian percakapan saat ini dengan pengguna.

Mengembalikan

Promise<T | undefined>

Keterangan

Properti yang mendukung objek penyimpanan HARUS dimuat ke dalam memori pada akses pertama.

Jika properti saat ini tidak ada pada objek penyimpanan dan defaultValue telah ditentukan, kloning defaultValue HARUS disalin ke objek penyimpanan. Jika defaultValue belum ditentukan, nilai undefined HARUS dikembalikan.

const value = await myProperty.get(context, { count: 0 });

get(TurnContext, T) 

function get(context: TurnContext, defaultValue: T): Promise<T>

Parameter

context
TurnContext
defaultValue

T

Mengembalikan

Promise<T>

set(TurnContext, T)

Menetapkan nilai baru ke objek penyimpanan cadangan properti.

function set(context: TurnContext, value: T): Promise<void>

Parameter

context
TurnContext

Konteks untuk pergantian percakapan saat ini dengan pengguna.

value

T

Nilai yang akan ditetapkan.

Mengembalikan

Promise<void>

Keterangan

Properti yang mendukung objek penyimpanan HARUS dimuat ke dalam memori pada akses pertama.

Bergantung pada implementasi sistem status, langkah tambahan mungkin diperlukan untuk mempertahankan perubahan aktual pada disk.

await myProperty.set(context, value);