BotState Класс
Определение
Важно!
Некоторые сведения относятся к предварительной версии продукта, в которую до выпуска могут быть внесены существенные изменения. Майкрософт не предоставляет никаких гарантий, явных или подразумеваемых, относительно приведенных здесь сведений.
Определяет объект управления состоянием и автоматизирует чтение и запись связанных свойств состояния на уровне хранилища.
public abstract class BotState : Microsoft.Bot.Builder.IPropertyManagertype BotState = class
interface IPropertyManagerPublic MustInherit Class BotState
Implements IPropertyManager- Наследование
-
BotState
- Производный
- Реализации
Комментарии
Каждый объект управления состоянием определяет область для уровня хранилища.
Свойства состояния создаются в области управления состоянием, и Bot Framework определяет следующие области: ConversationState, UserStateи PrivateConversationState.
Вы можете определить дополнительные области для бота.
Конструкторы
| BotState(IStorage, String) |
Инициализирует новый экземпляр класса BotState. |
Методы
| ClearStateAsync(ITurnContext, CancellationToken) |
Очищает кэш состояний для этого BotStateобъекта . |
| CreateProperty<T>(String) |
Создает именованное свойство состояния в области BotState и возвращает метод доступа для свойства . |
| DeleteAsync(ITurnContext, CancellationToken) |
Удаляет все состояния в хранилище и кэш для этого BotState. |
| DeletePropertyValueAsync(ITurnContext, String, CancellationToken) |
Удаляет свойство из кэша состояний для данного BotStateобъекта . |
| Get(ITurnContext) |
Получает копию необработанных кэшированных данных для этого BotState из контекста шага. |
| GetCachedState(ITurnContext) |
Возвращает экземпляр состояния кэшированного бота, который заключает необработанные кэшированные данные для этого BotState из контекста шага. |
| GetPropertyValueAsync<T>(ITurnContext, String, CancellationToken) |
Возвращает значение свойства из кэша состояний для данного BotStateобъекта . |
| GetStorageKey(ITurnContext) |
При переопределении в производном классе получает ключ, используемый при чтении и записи состояния в хранилище и из него. |
| LoadAsync(ITurnContext, Boolean, CancellationToken) |
Заполняет кэш состояний для этого BotState уровня хранилища. |
| SaveChangesAsync(ITurnContext, Boolean, CancellationToken) |
Записывает кэш состояний для этого BotState на уровень хранилища. |
| SetPropertyValueAsync(ITurnContext, String, Object, CancellationToken) |
Задает значение свойства в кэше состояний для данного BotStateобъекта . |