BotStateMemoryScope class
Базовый класс для областей памяти на основе BotState.
- Extends
Конструкторы
| Bot |
Инициализирует новый экземпляр класса BotStateMemoryScope. |
Унаследованные свойства
| include |
Возвращает значение, указывающее, должна ли эта память быть включена в моментальный снимок. |
| name | Возвращает или задает имя области |
Методы
| delete(Dialog |
Удаляет любое состояние в хранилище и кэш для этого BotState. |
| get |
Получите резервную память для этой области. |
| load(Dialog |
Заполняет кэш состояния для этого BotState из уровня хранилища. |
| save |
Записывает кэш состояния для этого BotState на уровень хранилища. |
| set |
Изменяет резервный объект для области памяти. |
Сведения о конструкторе
BotStateMemoryScope(string)
Инициализирует новый экземпляр класса BotStateMemoryScope.
new BotStateMemoryScope(name: string)Параметры
- name
-
string
имя свойства.
Сведения об унаследованном свойстве
includeInSnapshot
Возвращает значение, указывающее, должна ли эта память быть включена в моментальный снимок.
includeInSnapshot: booleanЗначение свойства
boolean
наследуется отMemoryScope.includeInSnapshot
name
Возвращает или задает имя области
name: stringЗначение свойства
string
унаследован отMemoryScope.name
Сведения о методе
delete(DialogContext)
Удаляет любое состояние в хранилище и кэш для этого BotState.
function delete(_dc: DialogContext): Promise<void>Параметры
- _dc
- DialogContext
Объект DialogContext для этого поворота.
Возвращаемое значение
Promise<void>
Обещание, представляющее рабочую очередь для выполнения.
getMemory(DialogContext)
Получите резервную память для этой области.
function getMemory(dc: DialogContext): objectПараметры
текущий контекст диалогового окна.
Возвращаемое значение
object
Память для области.
load(DialogContext, boolean)
Заполняет кэш состояния для этого BotState из уровня хранилища.
function load(dc: DialogContext, force?: boolean): Promise<void>Параметры
Объект DialogContext для этого поворота.
- force
-
boolean
Необязательный, true для перезаписи любого существующего кэша состояния; или false загружать состояние из хранилища, только если кэш еще не существует.
Возвращаемое значение
Promise<void>
Обещание, представляющее рабочую очередь для выполнения.
saveChanges(DialogContext, boolean)
Записывает кэш состояния для этого BotState на уровень хранилища.
function saveChanges(dc: DialogContext, force?: boolean): Promise<void>Параметры
Объект DialogContext для этого поворота.
- force
-
boolean
Необязательно, true для сохранения кэша состояния в хранилище; или false сохранить состояние в хранилище только в том случае, если свойство в кэше изменилось.
Возвращаемое значение
Promise<void>
Обещание, представляющее рабочую очередь для выполнения.
setMemory(DialogContext, object)
Изменяет резервный объект для области памяти.
function setMemory(dc: DialogContext, _memory: object)Параметры
текущий контекст диалогового окна
- _memory
-
object
память