InspectionState class

Пакет:

botbuilder

Предупреждение

Теперь этот API является нерекомендуемым.

This class will be removed in a future version of the framework.

InspectionState для использования в InspectionMiddleware для проверки эмулятором действий среды выполнения и BotState.

Extends

BotState

Комментарии

InspectionState для использования в InspectionMiddleware для проверки эмулятором действий среды выполнения и BotState.

Конструкторы

InspectionState(Storage)

Создает новый экземпляр класса InspectionState .

Наследуемые методы

clear(TurnContext)	Очищает объект текущего состояния для поворота.
createProperty<T>(string)	Создает новый метод доступа к свойству для чтения и записи отдельного свойства в объект хранилища состояний бота.
delete(TurnContext)	Удалите объект резервного состояния для текущего поворота.
get(TurnContext)	Возвращает кэшированный объект состояния или неопределенный, если он не кэширован.
load(TurnContext, boolean)	Считывает и кэширует объект резервного состояния для поворота.
saveChanges(TurnContext, boolean)	Сохраняет кэшированный объект состояния, если он был изменен.

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

InspectionState(Storage)

Создает новый экземпляр класса InspectionState .

new InspectionState(storage: Storage)

Параметры

storage

Storage

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

Сведения о наследуемом методе

clear(TurnContext)

Очищает объект текущего состояния для поворота.

function clear(context: TurnContext): Promise<void>

Параметры

context

TurnContext

Контекст для текущего диалога с пользователем.

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

Promise<void>

Обещание, представляющее асинхронную операцию.

Комментарии

Очищенный объект состояния не будет сохранен до вызова saveChanges().

await botState.clear(context);
await botState.saveChanges(context);

Наследуется от BotState.clear

createProperty<T>(string)

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

function createProperty<T>(name: string): StatePropertyAccessor<T>

Параметры

name

string

Имя добавляемого свойства.

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

StatePropertyAccessor<T>

Метод доступа для свойства .

Наследуется от BotState.createProperty

delete(TurnContext)

Удалите объект резервного состояния для текущего поворота.

function delete(context: TurnContext): Promise<void>

Параметры

context

TurnContext

Контекст для текущего диалога с пользователем.

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

Promise<void>

Обещание, представляющее асинхронную операцию.

Комментарии

Объект состояния будет удален из хранилища, если он существует. Если объект состояния был считан и кэширован, кэш будет очищен.

await botState.delete(context);

Наследуется от BotState.delete

get(TurnContext)

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

function get(context: TurnContext): any | undefined

Параметры

context

TurnContext

Контекст для текущего диалога с пользователем.

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

any | undefined

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

Комментарии

В этом примере показано, как синхронно получить уже загруженный и кэшированный объект состояния:

const state = botState.get(context);

Наследуется от BotState.get

load(TurnContext, boolean)

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

function load(context: TurnContext, force?: boolean): Promise<any>

Параметры

context

TurnContext

Контекст для текущего диалога с пользователем.

force

boolean

(Необязательно) Если true кэш будет обходить и состояние всегда будет считываться непосредственно из хранилища. По умолчанию — false.

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

Promise<any>

Кэшированное состояние.

Комментарии

Последующие операции чтения возвращают кэшированный объект, если force не передается флаг , который принудительно перечитает объект состояния.

Этот метод автоматически вызывается при первом доступе к любому из созданных методов доступа к свойству.

const state = await botState.load(context);

Наследуется от BotState.load

saveChanges(TurnContext, boolean)

Сохраняет кэшированный объект состояния, если он был изменен.

function saveChanges(context: TurnContext, force?: boolean): Promise<void>

Параметры

context

TurnContext

Контекст для текущего диалога с пользователем.

force

boolean

(Необязательно), если true состояние всегда будет записываться независимо от состояния изменения. По умолчанию — false.

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

Promise<void>

Обещание, представляющее асинхронную операцию.

Комментарии

force Если флаг передается в кэшированном объекте состояния будет сохранен независимо от того, был ли он изменен или нет, и если объект не кэшировался, будет создан и сохранен пустой объект.

await botState.saveChanges(context);

Наследуется от BotState.saveChanges