EndTurn class

Ссылка

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

Эта команда завершает текущий поворот, не завершаядиалогового окна.

Extends: Dialog<O>

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

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

Свойства

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

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

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

Методы

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

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

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

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

EndTurn(string)

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

new EndTurn(dialogId?: string)

Параметры

dialogId: string

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

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

$kind

static $kind: string

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

string

disabled

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

disabled?: BoolExpression

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

BoolExpression

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

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

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

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

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

См. также

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

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

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

reason: DialogReason

Причина возобновления диалога. Обычно это будет DialogReason.endCalled

result: any

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

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

Promise<DialogTurnResult>

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

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

DialogContext вызывает этот метод при возобновлении диалога. Если предыдущее диалоговое окно в стеке вернуло значение, это значение находится в параметре result.

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

См. также

DialogContext.endDialog

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

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

Параметры

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

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

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

Комментарии

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

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

Параметры

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

Параметры

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

Параметры

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

Параметры

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

Параметры

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

Комментарии

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

Комментарии

Параметры

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

Параметры

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

Комментарии

Параметры

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

Комментарии