ForEach class

Ссылка

Пакет:: botbuilder-dialogs-adaptive

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

Extends: ActionScope<O>

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

ForEach()	Инициализирует новый экземпляр класса Foreach.
ForEach(string, Dialog[])	Инициализирует новый экземпляр класса Foreach.

Свойства

$kind
disabled	Необязательное выражение, которое, если задано значение true, отключит это действие.
index	Выражение пути свойства к индексу элемента.
itemsProperty	Выражение пути свойства к коллекции элементов.
value	Выражение пути свойства к значению элемента.

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

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

Методы

beginDialog(DialogContext, O)	Запускает новый диалог и отправляет его в стек диалогов.
getConverter(Object)
getDependencies()	Получает дочерни е зависимости диалогового окна, чтобы их можно было добавить в контейнеры диалогового окна.

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

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

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

ForEach()

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

new ForEach()

ForEach(string, Dialog[])

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

new ForEach(itemsProperty: string, actions: Dialog[])

Параметры

itemsProperty: string

Выражение пути свойства к коллекции элементов.

actions: Dialog[]

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

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

$kind

static $kind: string

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

string

disabled

Необязательное выражение, которое, если задано значение true, отключит это действие.

disabled?: BoolExpression

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

BoolExpression

index

Выражение пути свойства к индексу элемента.

index: StringExpression

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

StringExpression

itemsProperty

Выражение пути свойства к коллекции элементов.

itemsProperty: StringExpression

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

StringExpression

value

Выражение пути свойства к значению элемента.

value: StringExpression

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

StringExpression

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

actions

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

actions: Dialog[]

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

Dialog[]

наследуется отActionScope.actions

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, представляющий асинхронную операцию.

getConverter(Object)

function getConverter(property: Object): Converter | ConverterFactory

Параметры

property: Object

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

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

Converter | ConverterFactory

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

getDependencies()

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

function getDependencies(): Dialog[]

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

Dialog[]

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

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

configure(Record<string, unknown>)

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

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

Параметры

config: Record<string, unknown>

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

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

this

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

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

continueDialog(DialogContext)

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

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

Параметры

dc: DialogContext

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

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

Promise<DialogTurnResult>

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

унаследовано отActionScope.continueDialog

endDialog(TurnContext, DialogInstance, DialogReason)

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

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

Параметры

_context: TurnContext

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

_instance: DialogInstance

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

_reason: DialogReason

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

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

Promise<void>

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

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

См. также

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

getVersion()

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

function getVersion(): string

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

string

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

унаследован отActionScope.getVersion

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 вызывает этот метод, когда текущее диалоговое окно должно повторно запрашивать входные данные от пользователя. Этот метод реализуется для диалоговых окон запроса.

См. также

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

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, представляющий асинхронную операцию.

унаследован отActionScope.resumeDialog

Поделиться через

Параметры

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

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

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

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

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

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

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

Комментарии

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

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

Параметры

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

Параметры

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

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

Параметры

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

Параметры

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

Параметры

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

Комментарии

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

Параметры

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

Параметры

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

Комментарии

Параметры

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