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)	Задайте значение памяти.
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

Конечное свойство, которое нужно удалить.

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

Найденное значение или не определено, если не найдено и не указано 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)

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

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

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