DynamicBeginDialog class

Ссылка

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

Внутреннее BeginDialog действие, которое динамически привязывает x.schema/x.dialog для вызова ресурса x.dialog с свойствами в качестве параметров.

Extends: BeginDialog

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

DynamicBeginDialog(string, O)

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

Свойства

$kind

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

activityProcessed	Значение, указывающее, должен ли новый диалог обрабатывать действие.
dialog	Диалоговое окно для вызова.
disabled	Необязательное выражение, которое, если задано значение true, отключит это действие.
EndOfTurn	Возвращает результат конца по умолчанию.
id
options	Настраиваемые параметры диалогового окна.
resultProperty	(Необязательно) путь к свойству для хранения результата диалога.
telemetryClient

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

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

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

DynamicBeginDialog(string, O)

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

new DynamicBeginDialog(dialogIdToCall: string, options?: O)

Параметры

dialogIdToCall: string

Идентификатор вызываемого диалогового окна.

options: O

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

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

$kind

static $kind: string

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

string

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

activityProcessed

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

activityProcessed: BoolExpression

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

BoolExpression

наследуется отBaseInvokeDialog.activityProcessed

dialog

Диалоговое окно для вызова.

dialog: DialogExpression

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

DialogExpression

наследуется отBaseInvokeDialog.dialog

disabled

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

disabled?: BoolExpression

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

BoolExpression

унаследован отBeginDialog.disabled

EndOfTurn

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

static EndOfTurn: DialogTurnResult

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

DialogTurnResult

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

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

id

id: string

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

string

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

options

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

options: ObjectExpression<object>

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

ObjectExpression<object>

наследуется отBaseInvokeDialog.options

resultProperty

(Необязательно) путь к свойству для хранения результата диалога.

resultProperty?: StringExpression

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

StringExpression

унаследован отBeginDialog.resultProperty

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

унаследован отBeginDialog.beginDialog

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

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

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

Promise<DialogTurnResult>

Обещание разрешения результата поворота диалогового окна.

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

DialogContext вызывает этот метод при продолжении диалога.

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

См. также

DialogContext.continueDialog

наследуется от диалогового окна.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

getConverter(Object)

function getConverter(property: Object): Converter | ConverterFactory

Параметры

property: Object

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

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

Converter | ConverterFactory

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

унаследован отBeginDialog.getConverter

getDependencies()

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

function getDependencies(): Dialog<__type>[]

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

Dialog<__type>[]

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

унаследовано отBaseInvokeDialog.getDependencies

getVersion()

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

function getVersion(): string

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

string

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

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

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

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

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

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

Параметры

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

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

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

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

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

Комментарии

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

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

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

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

Параметры

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

Параметры

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

Параметры

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

Комментарии

Параметры

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

Комментарии

Параметры

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

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

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

Комментарии

Параметры

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

Параметры

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

Комментарии

Параметры

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