BotStateMemoryScope class

Paket:

botbuilder-dialogs

Kelas dasar untuk cakupan memori berdasarkan BotState.

Memperluas

MemoryScope

Konstruktor

BotStateMemoryScope(string)

Menginisialisasi instans baru BotStateMemoryScope.

Properti yang Diwariskan

includeInSnapshot	Mendapatkan nilai yang menunjukkan apakah memori ini harus disertakan dalam rekam jepret.
name	Mendapatkan atau menetapkan nama cakupan

Metode

delete(DialogContext)	Menghapus status apa pun dalam penyimpanan dan cache untukBotState ini.
getMemory(DialogContext)	Dapatkan memori cadangan untuk cakupan ini.
load(DialogContext, boolean)	Mengisi cache status untuk BotState ini dari lapisan penyimpanan.
saveChanges(DialogContext, boolean)	Menulis cache status untuk BotState ini ke lapisan penyimpanan.
setMemory(DialogContext, object)	Mengubah objek pendukung untuk cakupan memori.

Detail Konstruktor

BotStateMemoryScope(string)

Menginisialisasi instans baru BotStateMemoryScope.

new BotStateMemoryScope(name: string)

Parameter

name

string

nama properti.

Detail Properti yang Diwariskan

includeInSnapshot

Mendapatkan nilai yang menunjukkan apakah memori ini harus disertakan dalam rekam jepret.

includeInSnapshot: boolean

Nilai Properti

boolean

Diwarisi DariMemoryScope.includeInSnapshot

name

Mendapatkan atau menetapkan nama cakupan

name: string

Nilai Properti

string

Diwariskan DariMemoryScope.name

Detail Metode

delete(DialogContext)

Menghapus status apa pun dalam penyimpanan dan cache untukBotState ini.

function delete(_dc: DialogContext): Promise<void>

Parameter

_dc

DialogContext

Objek DialogContext untuk giliran ini.

Mengembalikan

Promise<void>

Janji yang mewakili pekerjaan yang diantrekan untuk dijalankan.

getMemory(DialogContext)

Dapatkan memori cadangan untuk cakupan ini.

function getMemory(dc: DialogContext): object

Parameter

dc

DialogContext

konteks dialog saat ini.

Mengembalikan

object

Memori untuk cakupan.

load(DialogContext, boolean)

Mengisi cache status untuk BotState ini dari lapisan penyimpanan.

function load(dc: DialogContext, force?: boolean): Promise<void>

Parameter

dc

DialogContext

Objek DialogContext untuk giliran ini.

force

boolean

Opsional, true untuk menimpa cache status yang ada; atau false untuk memuat status dari penyimpanan hanya jika cache belum ada.

Mengembalikan

Promise<void>

Janji yang mewakili pekerjaan yang diantrekan untuk dijalankan.

saveChanges(DialogContext, boolean)

Menulis cache status untuk BotState ini ke lapisan penyimpanan.

function saveChanges(dc: DialogContext, force?: boolean): Promise<void>

Parameter

dc

DialogContext

Objek DialogContext untuk giliran ini.

force

boolean

Opsional, true untuk menyimpan cache status ke penyimpanan; atau false untuk menyimpan status ke penyimpanan hanya jika properti dalam cache telah berubah.

Mengembalikan

Promise<void>

Janji yang mewakili pekerjaan yang diantrekan untuk dijalankan.

setMemory(DialogContext, object)

Mengubah objek pendukung untuk cakupan memori.

function setMemory(dc: DialogContext, _memory: object)

Parameter

dc

DialogContext

konteks dialog saat ini

_memory

object

ingatan