BotState Класс

Ссылка

Пакет:: com.microsoft.bot.builder

Артефакт Maven:: com.microsoft.bot:bot-builder:4.14.3

java.lang.Object
- com.microsoft.bot.builder.BotState

Реализации

public abstract class BotState
implements PropertyManager

Определяет объект управления состоянием и автоматизирует чтение и запись связанных свойств состояния в слой хранилища.

Каждый объект управления состоянием определяет область для слоя хранения. Свойства состояния создаются в области управления состоянием, а Платформа Bot Framework определяет следующие области: ConversationState, UserStateи PrivateConversationState. Вы можете определить дополнительные области для бота.

Сводка по конструктору

Конструктор	Описание
BotState(Storage withStorage, String withContextServiceKey)	Инициализирует новый экземпляр класса BotState.

Сводка по методу

Модификатор и тип	Метод и описание
StatePropertyAccessor<T>	<T>createProperty(String name) Создает именованное свойство состояния в области ботаstate и возвращает метод доступа для свойства.
protected java.util.concurrent.CompletableFuture<T>	<T>getPropertyValue(TurnContext turnContext, String propertyName) Возвращает значение свойства из кэша состояний для этого ботасостояния.
java.util.concurrent.CompletableFuture<java.lang.Void>	clearState(TurnContext turnContext) Очищает кэш состояния для этого состояния ботасостояния.
java.util.concurrent.CompletableFuture<java.lang.Void>	delete(TurnContext turnContext) Удалите любое состояние, хранящееся в этой области состояния.
protected java.util.concurrent.CompletableFuture<java.lang.Void>	deletePropertyValue(TurnContext turnContext, String propertyName) Удаляет свойство из кэша состояний для этогосостояния Бота.
com.fasterxml.jackson.databind.JsonNode	get(TurnContext turnContext) Возвращает копию необработанных кэшированных данных для этого состояния ботаиз контекста поворота.
CachedBotState	getCachedState(TurnContext turnContext) Возвращает экземпляр состояния кэшированного бота, который упаковывает необработанные кэшированные данные для этого ботасостояния из контекста поворота.
abstract java.lang.String	getStorageKey(TurnContext turnContext) При переопределении в производном классе получает ключ, используемый при чтении и записи состояния в хранилище и из него.
java.util.concurrent.CompletableFuture<java.lang.Void>	load(TurnContext turnContext) Заполняет кэш состояния для этого ботасостояние из уровня хранилища.
java.util.concurrent.CompletableFuture<java.lang.Void>	load(TurnContext turnContext, boolean force) Считывает текущий объект состояния и кэширует его в объекте контекста для этого шага.
java.util.concurrent.CompletableFuture<java.lang.Void>	saveChanges(TurnContext turnContext) Записывает кэш состояния для этого ботасостояние в уровень хранилища.
java.util.concurrent.CompletableFuture<java.lang.Void>	saveChanges(TurnContext turnContext, boolean force) Записывает кэш состояния для этого ботасостояние в уровень хранилища.
protected java.util.concurrent.CompletableFuture<java.lang.Void>	setPropertyValue(TurnContext turnContext, String propertyName, Object value) Задает значение свойства в кэше состояний для этогосостояния Бота.

Методы, унаследованные от java.lang.Object

java.lang.Object.clone java.lang.Object.equals java.lang.Object.finalize java.lang.Object.getClass java.lang.Object.hashCode java.lang.Object.notify java.lang.Object.notifyAll java.lang.Object.toString java.lang.Object.wait java.lang.Object.wait java.lang.Object.wait

Сведения о конструкторе

BotState

public BotState(Storage withStorage, String withContextServiceKey)

Инициализирует новый экземпляр класса BotState.

Параметры:

withStorage - Используемый поставщик хранилища.

withContextServiceKey - Ключ кэша состояния для этого BotState.

Активизирует исключение:

java.lang.IllegalArgumentException - Аргументы ключа службы NULL или пустого ключа службы.

Сведения о методе

<T>createProperty

public StatePropertyAccessor createProperty(String name)

Создает именованное свойство состояния в области BotState и возвращает метод доступа для свойства.

Параметры:

name - имя свойства.

Возвращаемое значение:

StatePropertyAccessor<T> для свойства.

Активизирует исключение:

java.lang.IllegalArgumentException - Пустое имя

<T>getPropertyValue

protected CompletableFuture getPropertyValue(TurnContext turnContext, String propertyName)

Возвращает значение свойства из кэша состояния для этого BotState.

Параметры:

turnContext - Объект контекста для этого поворота.

propertyName - Имя свойства, которое требуется получить.

Возвращаемое значение:

Задача, представляющая выполняемую рабочую очередь. Если задача выполнена успешно, результат содержит значение свойства.

clearState

public CompletableFuture clearState(TurnContext turnContext)

Очищает кэш состояния для этого BotState.

Этот метод очищает кэш состояния в контексте поворота. Вызовите saveChanges(TurnContext turnContext, boolean force), чтобы сохранить это изменение на уровне хранилища.

Параметры:

turnContext - Объект контекста для этого поворота.

Возвращаемое значение:

Задача, представляющая выполняемую рабочую очередь.

delete

public CompletableFuture delete(TurnContext turnContext)

Удалите любое состояние, хранящееся в этой области состояния.

Параметры:

turnContext - Объект контекста для этого поворота.

Возвращаемое значение:

Задача, представляющая выполняемую рабочую очередь.

deletePropertyValue

protected CompletableFuture deletePropertyValue(TurnContext turnContext, String propertyName)

Удаляет свойство из кэша состояния для этого BotState.

Параметры:

turnContext - Объект контекста для этого поворота.

propertyName - Имя свойства для удаления.

Возвращаемое значение:

Задача, представляющая выполняемую рабочую очередь.

get

public JsonNode get(TurnContext turnContext)

Возвращает копию необработанных кэшированных данных для этого BotState из контекста поворота.

Параметры:

turnContext - Объект контекста для этого поворота.

Возвращаемое значение:

Представление JSON кэшированного состояния.

getCachedState

public BotState.CachedBotState getCachedState(TurnContext turnContext)

Возвращает экземпляр состояния кэшированного бота, который упаковывает необработанные кэшированные данные для этого BotState из контекста поворота.

Параметры:

turnContext - Объект контекста для этого поворота.

Возвращаемое значение:

Кэшированный экземпляр состояния бота.

getStorageKey

public abstract String getStorageKey(TurnContext turnContext)

При переопределении в производном классе получает ключ, используемый при чтении и записи состояния в хранилище и из него.

Параметры:

turnContext - Объект контекста для этого поворота.

Возвращаемое значение:

Ключ хранилища.

Активизирует исключение:

java.lang.IllegalArgumentException - TurnContext не содержит все необходимые данные.

load

public CompletableFuture load(TurnContext turnContext)

Заполняет кэш состояния для этого BotState из уровня хранилища.

Параметры:

turnContext - Объект контекста для этого поворота.

Возвращаемое значение:

Задача, представляющая выполняемую рабочую очередь.

load

public CompletableFuture load(TurnContext turnContext, boolean force)

Считывает текущий объект состояния и кэширует его в объекте контекста для этого шага.

Параметры:

turnContext - Объект контекста для этого поворота.

force - значение true для перезаписи любого существующего кэша состояния; или false для загрузки состояния из хранилища только в том случае, если кэш еще не существует.

Возвращаемое значение:

Задача, представляющая выполняемую рабочую очередь.

saveChanges

public CompletableFuture saveChanges(TurnContext turnContext)

Записывает кэш состояния для этого BotState на уровень хранилища.

Параметры:

turnContext - Объект контекста для этого поворота.

Возвращаемое значение:

Задача, представляющая выполняемую рабочую очередь.

saveChanges

public CompletableFuture saveChanges(TurnContext turnContext, boolean force)

Записывает кэш состояния для этого BotState на уровень хранилища.

Параметры:

turnContext - Объект контекста для этого поворота.

force - значение true, чтобы сохранить кэш состояния в хранилище; или false, чтобы сохранить состояние в хранилище только в том случае, если свойство в кэше изменилось.

Возвращаемое значение:

Задача, представляющая выполняемую рабочую очередь.

setPropertyValue

protected CompletableFuture setPropertyValue(TurnContext turnContext, String propertyName, Object value)

Задает значение свойства в кэше состояний для этого BotState.

Параметры:

turnContext - Объект контекста для этого поворота.

propertyName - Имя заданного свойства.

value - Значение, заданное для свойства.

Возвращаемое значение:

Задача, представляющая выполняемую рабочую очередь.

BotState Класс

Сводка по конструктору

Сводка по методу

Методы, унаследованные от java.lang.Object

Сведения о конструкторе

BotState

Сведения о методе

<T>createProperty

<T>getPropertyValue

clearState

delete

deletePropertyValue

get

getCachedState

getStorageKey

load

load

saveChanges

saveChanges

setPropertyValue

Применяется к