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

Комментарии

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

Наследуется отDialog.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>

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

Комментарии

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

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

configure(Record<string, unknown>)

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

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

Параметры

config

Record<string, unknown>

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

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

this

Объект Configurable после завершения операции.

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

Наследуется отDialog.onDialogEvent