StatePropertyAccessor interface
Определяет методы для доступа к свойству состояния, созданному в объекте BotState.
Комментарии
Чтобы создать свойство состояния в objet управления состояниями, используйте метод createProperty <T>.
Методы
| delete(Turn |
Удаляет сохраненное свойство из своего резервного объекта хранилища. |
| get(Turn |
Считывает сохраненное свойство из своего резервного объекта хранилища. |
| get(Turn |
|
| set(Turn |
Присваивает новому значению объекту хранилища свойств. |
Сведения о методе
delete(TurnContext)
Удаляет сохраненное свойство из своего резервного объекта хранилища.
function delete(context: TurnContext): Promise<void>Параметры
- context
- TurnContext
Контекст для текущего шага беседы с пользователем.
Возвращаемое значение
Promise<void>
Комментарии
Свойства, резервные объекты хранилища должны быть загружены в память при первом доступе.
await myProperty.delete(context);
get(TurnContext)
Считывает сохраненное свойство из своего резервного объекта хранилища.
function get(context: TurnContext): Promise<T | undefined>Параметры
- context
- TurnContext
Контекст для текущего шага беседы с пользователем.
Возвращаемое значение
Promise<T | undefined>
Комментарии
Свойства, резервные объекты хранилища должны быть загружены в память при первом доступе.
Если свойство в настоящее время не существует в объекте хранилища и указана defaultValue, клон defaultValue ДОЛЖЕН быть скопирован в объект хранилища. Если defaultValue не задано, возвращается значение undefined.
const value = await myProperty.get(context, { count: 0 });
get(TurnContext, T)
function get(context: TurnContext, defaultValue: T): Promise<T>Параметры
- context
- TurnContext
- defaultValue
-
T
Возвращаемое значение
Promise<T>
set(TurnContext, T)
Присваивает новому значению объекту хранилища свойств.
function set(context: TurnContext, value: T): Promise<void>Параметры
- context
- TurnContext
Контекст для текущего шага беседы с пользователем.
- value
-
T
Значение для назначения.
Возвращаемое значение
Promise<void>
Комментарии
Свойства, резервные объекты хранилища должны быть загружены в память при первом доступе.
В зависимости от реализации систем состояния может потребоваться дополнительный шаг для сохранения фактических изменений на диске.
await myProperty.set(context, value);