ChoicePrompt class

Ссылка

Пакет:: botbuilder-dialogs

Предложит пользователю выбрать из списка вариантов.

Extends: Prompt<FoundChoice>

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

ChoicePrompt(string, PromptValidator<FoundChoice>, string, ChoiceDefaultsChoicePrompt)

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

Свойства

choiceOptions	Дополнительные параметры, переданные в `ChoiceFactory` и используемые для настройки стиля выбора, отрисованного пользователю.
defaultLocale	Запрашивает языковой стандарт по умолчанию, который должен быть распознан.
id	Уникальный идентификатор диалогового окна. Задает уникальный идентификатор диалогового окна.
recognizerOptions	Дополнительные параметры, переданные базовой функции `recognizeChoices()`.
style	Стиль вариантов "да" и "нет", отображаемых пользователю при появлении запроса.
telemetryClient	Возвращает клиент телеметрии для этого диалогового окна. Задает клиент телеметрии для этого диалогового окна.

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

EndOfTurn

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

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

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

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

ChoicePrompt(string, PromptValidator<FoundChoice>, string, ChoiceDefaultsChoicePrompt)

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

new ChoicePrompt(dialogId: string, validator?: PromptValidator<FoundChoice>, defaultLocale?: string, choiceDefaults?: ChoiceDefaultsChoicePrompt)

Параметры

dialogId: string

Уникальный идентификатор диалогового окна в родительском DialogSet.

validator: PromptValidator<FoundChoice>

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

defaultLocale: string

(Необязательно) языковой стандарт, используемый, если dc.context.activity.locale не указано. По умолчанию используется значение en-us.

choiceDefaults: ChoiceDefaultsChoicePrompt

(Необязательно) Переопределяет словарь поддерживаемых пакетом SDK Bot Framework _choiceDefaults (для локализации запросов). Необходимо передать в каждый запрос ConfirmPrompt, который требует пользовательских значений по умолчанию.

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

choiceOptions

Дополнительные параметры, переданные в ChoiceFactory и используемые для настройки стиля выбора, отрисованного пользователю.

choiceOptions: ChoiceFactoryOptions | undefined

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

ChoiceFactoryOptions | undefined

defaultLocale

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

defaultLocale: string | undefined

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

string | undefined

id

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

string id

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

string

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

recognizerOptions

Дополнительные параметры, переданные базовой функции recognizeChoices().

recognizerOptions: FindChoicesOptions | undefined

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

FindChoicesOptions | undefined

style

Стиль вариантов "да" и "нет", отображаемых пользователю при появлении запроса.

style: ListStyle

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

ListStyle

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

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

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

наследуется отPrompt.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(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

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

унаследовано отPrompt.repromptDialog

resumeDialog(DialogContext, DialogReason, any)

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

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

Параметры

dc: DialogContext

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

_reason: DialogReason

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

_result: any

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

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

Promise<DialogTurnResult>

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

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

ChoicePrompt class

Комментарии

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

Свойства

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

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

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

ChoicePrompt(string, PromptValidator<FoundChoice>, string, ChoiceDefaultsChoicePrompt)

Параметры

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

choiceOptions

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

defaultLocale

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

id

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

Комментарии

recognizerOptions

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

style

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

Комментарии

telemetryClient

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

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

EndOfTurn

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

Комментарии

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

beginDialog(DialogContext, PromptOptions)

Параметры

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

Комментарии

configure(Record<string, unknown>)

Параметры

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

continueDialog(DialogContext)

Параметры

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

Комментарии

endDialog(TurnContext, DialogInstance, DialogReason)

Параметры

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

Комментарии

getConverter(string)

Параметры

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

getVersion()

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

Комментарии

onDialogEvent(DialogContext, DialogEvent)

Параметры

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

repromptDialog(TurnContext, DialogInstance)

Параметры

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

resumeDialog(DialogContext, DialogReason, any)

Параметры

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

Комментарии

Дополнительные ресурсы