BotStateSet class
Коллекция подключаемых модулей BotState
, которые должны быть загружены или сохранены параллельно в виде одной единицы.
Сведения о реализации этого класса см. в AutoSaveStateMiddleware
.
Конструкторы
Bot |
Создает новый экземпляр BotStateSet. |
Свойства
bot |
Массив наборов |
Методы
add(Bot |
Регистрирует один или несколько подключаемых модулей |
load |
Вызывает |
save |
Вызывает |
Сведения о конструкторе
BotStateSet(BotState[])
Создает новый экземпляр BotStateSet.
new BotStateSet(botStates: BotState[])
Параметры
- botStates
-
BotState[]
Один или несколько подключаемых модулей BotState для регистрации.
Сведения о свойстве
botStates
Сведения о методе
add(BotState[])
Регистрирует один или несколько подключаемых модулей BotState
с набором.
function add(botStates: BotState[]): this
Параметры
- botStates
-
BotState[]
Один или несколько подключаемых модулей BotState для регистрации.
Возвращаемое значение
this
Обновленный BotStateSet.
loadAll(TurnContext, boolean)
Вызывает BotState.load()
во всех подключаемых модулях BotState в наборе.
function loadAll(context: TurnContext, force?: boolean): Promise<void>
Параметры
- context
- TurnContext
Контекст для текущего шага беседы с пользователем.
- force
-
boolean
(Необязательно) Если true
кэш будет обходить, состояние всегда будет считываться непосредственно из хранилища. По умолчанию используется false
.
Возвращаемое значение
Promise<void>
Комментарии
Это приведет ко всем подключаемым модулям для параллельного чтения в их состоянии.
await stateSet.readAll(context);
saveAllChanges(TurnContext, boolean)
Вызывает BotState.saveChanges()
во всех подключаемых модулях BotState в наборе.
function saveAllChanges(context: TurnContext, force?: boolean): Promise<void>
Параметры
- context
- TurnContext
Контекст для текущего шага беседы с пользователем.
- force
-
boolean
(Необязательно) если true
состояние всегда будет записано независимо от его состояния изменения. По умолчанию используется false
.
Возвращаемое значение
Promise<void>
Комментарии
Это приведет ко всем подключаемым модулям для параллельной записи состояния.
await stateSet.saveAllChanges(context);