ActionScope class

Пакет:

botbuilder-dialogs-adaptive

ActionScope управляет выполнением блока действий и поддерживает семантику Goto, Continue и Break.

Extends

Dialog<O>

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

ActionScope(Dialog[])

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

Свойства

actions

Выполняемые действия.

Унаследованные свойства

EndOfTurn	Возвращает результат конца по умолчанию.
id
telemetryClient

Методы

beginDialog(DialogContext, O)	Вызывается при запуске диалогового окна и отправке в стек диалогов.
continueDialog(DialogContext)	Вызывается, когда диалогового окна продолжается, где это активное диалоговое окно и пользователь отвечает с новым действием.
getConverter(Object)
getDependencies()	Получает дочерни е зависимости диалогового окна, чтобы их можно было добавить в контейнеры диалогового окна.
getVersion()	Возвращает уникальный string, представляющий версию этого диалогового окна. Если изменение версии между поворотами диалоговой системы приведет к возникновению события DialogChanged.
resumeDialog(DialogContext, DialogReason, any)	Вызывается, когда дочерний диалог завершил свою очередь, возвращая элемент управления в это диалоговое окно.

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

configure(Record<string, unknown>)	Метод Fluent для настройки объекта.
endDialog(TurnContext, DialogInstance, DialogReason)	При переопределении в производном классе выполняет очистку диалогового окна перед завершением.
onDialogEvent(DialogContext, DialogEvent)	Вызывается при возникновении события, используя DialogContext.emitEvent(), текущим диалогом или диалогом, запущенным текущим диалогом.
repromptDialog(TurnContext, DialogInstance)	При переопределении в производном классе переиздает пользователя для ввода.

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

ActionScope(Dialog[])

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

new ActionScope(actions?: Dialog[])

Параметры

actions

Dialog[]

Действия для области.

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

actions

Выполняемые действия.

actions: Dialog[]

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

Dialog[]

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

EndOfTurn

Возвращает результат конца по умолчанию.

static EndOfTurn: DialogTurnResult

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

DialogTurnResult

Комментарии

Этот результат указывает, что диалоговое окно (или логический шаг в диалоговом окне) завершило обработку текущего шага, по-прежнему активно и ожидает дополнительных входных данных.

унаследован от диалогового окна.EndOfTurn

id

id: string

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

string

унаследован от Dialog.id

telemetryClient

telemetryClient: BotTelemetryClient

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

BotTelemetryClient

наследуется от Dialog.telemetryClient

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

beginDialog(DialogContext, O)

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

function beginDialog(dc: DialogContext, _options?: O): Promise<DialogTurnResult>

Параметры

dc

DialogContext

DialogContext для текущей очереди беседы.

_options

O

Необязательный. Начальные сведения для передачи в диалоговое окно.

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

Promise<DialogTurnResult>

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

continueDialog(DialogContext)

Вызывается, когда диалогового окна продолжается, где это активное диалоговое окно и пользователь отвечает с новым действием.

function continueDialog(dc: DialogContext): Promise<DialogTurnResult>

Параметры

dc

DialogContext

DialogContext для текущей очереди беседы.

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

Promise<DialogTurnResult>

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

getConverter(Object)

function getConverter(property: Object): Converter | ConverterFactory

Параметры

property

Object

Ключ конфигурации условного селектора.

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

Converter | ConverterFactory

Преобразователь конфигурации селектора.

getDependencies()

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

function getDependencies(): Dialog[]

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

Dialog[]

Дочернее диалоговое окно зависимостей.

getVersion()

Возвращает уникальный string, представляющий версию этого диалогового окна. Если изменение версии между поворотами диалоговой системы приведет к возникновению события DialogChanged.

function getVersion(): string

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

string

Уникальный string, который должен изменяться только при изменении диалогового окна таким образом, чтобы перезапустить диалоговое окно.

resumeDialog(DialogContext, DialogReason, any)

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

function resumeDialog(dc: DialogContext, _reason: DialogReason, result?: any): Promise<DialogTurnResult>

Параметры

dc

DialogContext

DialogContext для текущей очереди беседы.

_reason

DialogReason

(xref:botbuilder-dialogs. DialogReason), причина возобновления диалога.

result

any

Необязательный. Значение, возвращаемое из вызываемого диалогового окна. Тип возвращаемого значения зависит от дочернего диалогового окна.

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

Promise<DialogTurnResult>

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

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

configure(Record<string, unknown>)

Метод Fluent для настройки объекта.

function configure(config: Record<string, unknown>): this

Параметры

config

Record<string, unknown>

Параметры конфигурации для применения.

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

this

После завершения операции настраиваемый.

наследуется от Configurable.configure

endDialog(TurnContext, DialogInstance, DialogReason)

При переопределении в производном классе выполняет очистку диалогового окна перед завершением.

function endDialog(_context: TurnContext, _instance: DialogInstance, _reason: DialogReason): Promise<void>

Параметры

_context

TurnContext

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

_instance

DialogInstance

Текущие сведения о состоянии для этого диалогового окна.

_reason

DialogReason

Причина окончания диалогового окна.

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

Promise<void>

Комментарии

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

DialogContext вызывает этот метод при завершении текущего диалога.

См. также

• DialogContext.cancelAllDialogs
• DialogContext.endDialog
• DialogContext.replaceDialog

унаследован от Dialog.endDialog

onDialogEvent(DialogContext, DialogEvent)

Вызывается при возникновении события, используя DialogContext.emitEvent(), текущим диалогом или диалогом, запущенным текущим диалогом.

function onDialogEvent(dc: DialogContext, e: DialogEvent): Promise<boolean>

Параметры

dc

DialogContext

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

e

DialogEvent

Возникает событие.

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

Promise<boolean>

Значение True, если событие обрабатывается текущим диалогом, а пузырьк должен остановиться.

унаследован от диалогового окна.onDialogEvent

repromptDialog(TurnContext, DialogInstance)

При переопределении в производном классе переиздает пользователя для ввода.

function repromptDialog(_context: TurnContext, _instance: DialogInstance): Promise<void>

Параметры

_context

TurnContext

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

_instance

DialogInstance

Текущие сведения о состоянии для этого диалогового окна.

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

Promise<void>

Комментарии

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

DialogContext вызывает этот метод, когда текущее диалоговое окно должно повторно запрашивать входные данные от пользователя. Этот метод реализуется для диалоговых окон запроса.

См. также

• DialogContext.repromptDialog
• запрос

унаследован от диалогового окна "Диалоговое окно.repromptDialog"