Prompt class

Пакет:

botbuilder-dialogs

Базовый класс для всех запросов.

Extends

Dialog

Свойства

id	Уникальный идентификатор диалогового окна. Задает уникальный идентификатор диалогового окна.
telemetryClient	Возвращает клиент телеметрии для этого диалогового окна. Задает клиент телеметрии для этого диалогового окна.

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

EndOfTurn

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

Методы

beginDialog(DialogContext, PromptOptions)	Вызывается, когда диалоговое окно запроса отправляется в стек диалогов и активируется.
continueDialog(DialogContext)	Вызывается, когда диалоговое окно запроса является активным диалогом, и пользователь ответил на новое действие.
repromptDialog(TurnContext, DialogInstance)	Вызывается, когда диалоговое окно запроса запрашивается для повторного запроса пользователя на ввод.
resumeDialog(DialogContext, DialogReason, any)	Вызывается, когда диалоговое окно запроса возобновляется в качестве активного диалогового окна в стеке диалогов, например при завершении предыдущего активного диалогового окна в стеке.

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

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

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

id

Уникальный идентификатор диалогового окна. Задает уникальный идентификатор диалогового окна.

string id

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

string

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

Комментарии

Это будет автоматически создано, если не указано.

telemetryClient

Возвращает клиент телеметрии для этого диалогового окна. Задает клиент телеметрии для этого диалогового окна.

BotTelemetryClient telemetryClient

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

BotTelemetryClient

BotTelemetryClient для ведения журнала.

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

EndOfTurn

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

static EndOfTurn: DialogTurnResult

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

DialogTurnResult

Комментарии

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

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

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

beginDialog(DialogContext, PromptOptions)

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

function beginDialog(dc: DialogContext, options: PromptOptions): Promise<DialogTurnResult>

Параметры

dc

DialogContext

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

options

PromptOptions

Необязательный. PromptOptions, дополнительные сведения для передачи в запущенный запрос.

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

Promise<DialogTurnResult>

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

Комментарии

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

continueDialog(DialogContext)

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

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

Параметры

dc

DialogContext

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

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

Promise<DialogTurnResult>

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

Комментарии

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

repromptDialog(TurnContext, DialogInstance)

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

function repromptDialog(context: TurnContext, instance: DialogInstance): Promise<void>

Параметры

context

TurnContext

(xref:botbuilder-core. TurnContext), контекст для текущей очереди беседы с пользователем.

instance

DialogInstance

(xref:botbuilder-dialogs. DialogInstance), экземпляр диалогового окна в стеке.

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

Promise<void>

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

resumeDialog(DialogContext, DialogReason, any)

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

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

Параметры

dc

DialogContext

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

_reason

DialogReason

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

_result

any

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

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

Promise<DialogTurnResult>

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

Комментарии

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

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

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

getConverter(string)

function getConverter(_property: string): Converter | ConverterFactory

Параметры

_property

string

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

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

Converter | ConverterFactory

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

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

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