DialogStateManager class

Пакет:

botbuilder-dialogs

DialogStateManager управляет областями памяти и сопоставителями путей.

Комментарии

MemoryScopes — это именованные объекты корневого уровня, которые могут существовать либо в контексте диалога, либо в состоянии выключения. Сопоставители путей позволяют использовать ярлыки для сопоставления таких элементов, как $foo —> dialog.foo

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

DialogStateManager(DialogContext, DialogStateManagerConfiguration)

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

Свойства

configuration

Возвращает или задает настроенные сопоставители путей и области памяти для диспетчера состояний диалогов.

Методы

anyPathChanged(number, string[])	Проверьте, изменился ли какой-либо путь с момента водяного знака.
deleteScopesMemory(string)	Удаляет всю резервную память для заданной области.
deleteValue(string)	Удаление свойства из памяти
getMemorySnapshot()	Возвращает все области памяти, подходящие для ведения журнала.
getValue<T>(string, T | () => T)	Получите значение из памяти с помощью выражения пути.
loadAllScopes()	Обеспечивает загрузку всех областей памяти для текущего поворота.
parsePath(string, boolean)	Нормализует сегменты пути, переданные в пути.
saveAllChanges()	Сохраняет все изменения, внесенные в области памяти.
setValue(string, any)	Задайте для параметра memory значение.
trackPaths(string[])	Отслеживание изменения определенных путей.
transformPath(string)	Преобразуйте путь с помощью зарегистрированных преобразователей пути.
version()	Возвращает номер версии.

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

DialogStateManager(DialogContext, DialogStateManagerConfiguration)

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

new DialogStateManager(dc: DialogContext, configuration?: DialogStateManagerConfiguration)

Параметры

dc

DialogContext

Контекст диалога для текущего шага диалога.

configuration

DialogStateManagerConfiguration

Конфигурация для диспетчера состояний диалогов.

Сведения о свойстве

configuration

Возвращает или задает настроенные сопоставители путей и области памяти для диспетчера состояний диалогов.

configuration: DialogStateManagerConfiguration

Значение свойства

DialogStateManagerConfiguration

Комментарии

Существует единый набор сведений о конфигурации для заданной цепочки контекстов диалогов. Назначение новой конфигурации любому объекту DialogStateManager в цепочке приведет к обновлению конфигурации для всей цепочки.

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

anyPathChanged(number, string[])

Проверьте, изменился ли какой-либо путь с момента водяного знака.

function anyPathChanged(counter: number, paths: string[]): boolean

Параметры

counter

number

Счетчик времени для сравнения.

paths

string[]

Пути из trackPaths() для проверки.

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

boolean

Значение true, если какой-либо путь изменился со времени счетчика.

deleteScopesMemory(string)

Удаляет всю резервную память для заданной области.

function deleteScopesMemory(name: string): Promise<void>

Параметры

name

string

Имя области.

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

Promise<void>

deleteValue(string)

Удаление свойства из памяти

function deleteValue(pathExpression: string)

Параметры

pathExpression

string

Удаляемое свойство leaf.

getMemorySnapshot()

Возвращает все области памяти, подходящие для ведения журнала.

function getMemorySnapshot(): object

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

object

Объект , представляющий все области памяти.

getValue<T>(string, T | () => T)

Получите значение из памяти с помощью выражения пути.

function getValue<T>(pathExpression: string, defaultValue?: T | () => T): T

Параметры

pathExpression

string

Выражение пути для использования.

defaultValue

T | () => T

(Необязательно) Значение по умолчанию, используемое, если путь не найден. Может быть функцией, возвращающей используемое значение по умолчанию.

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

T

Найденное значение или undefined, если значение не найдено и не defaultValue указано.

Комментарии

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

loadAllScopes()

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

function loadAllScopes(): Promise<void>

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

Promise<void>

Комментарии

Он должен вызываться в начале поворота.

parsePath(string, boolean)

Нормализует сегменты пути, переданные в пути.

function parsePath(pathExpression: string, allowNestedPaths?: boolean): string | number[]

Параметры

pathExpression

string

Путь для нормализации.

allowNestedPaths

boolean

Необязательный элемент. В false этом случае при обнаружении вложенного пути возвращается пустой путь. Значение по умолчанию — true.

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

string | number[]

Нормализованный путь.

Комментарии

Путь profile.address[0] будет нормализован в profile.address.0.

saveAllChanges()

Сохраняет все изменения, внесенные в области памяти.

function saveAllChanges(): Promise<void>

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

Promise<void>

Комментарии

Он должен вызываться в конце поворота.

setValue(string, any)

Задайте для параметра memory значение.

function setValue(pathExpression: string, value: any)

Параметры

pathExpression

string

Путь к памяти.

value

any

Задаваемое значение.

trackPaths(string[])

Отслеживание изменения определенных путей.

function trackPaths(paths: string[]): string[]

Параметры

paths

string[]

Пути для отслеживания.

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

string[]

Нормализованные пути для передачи в anyPathChanged().

transformPath(string)

Преобразуйте путь с помощью зарегистрированных преобразователей пути.

function transformPath(pathExpression: string): string

Параметры

pathExpression

string

Путь для преобразования.

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

string

Преобразованный путь.

version()

Возвращает номер версии.

function version(): string

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

string

Строка с номером версии.