SkillDialog class

Пакет:

botbuilder-dialogs

Специализированное диалоговое окно, которое может упаковывать удаленные вызовы к навыку.

Extends

Dialog<Partial<BeginSkillDialogOptions>>

Комментарии

Параметр параметров в beginDialog должен быть экземпляром BeginSkillDialogOptions с начальными параметрами для диалогового окна.

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

SkillDialog(SkillDialogOptions, string)

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

Свойства

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

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

EndOfTurn

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

Методы

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

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

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

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

SkillDialog(SkillDialogOptions, string)

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

new SkillDialog(dialogOptions: SkillDialogOptions, dialogId?: string)

Параметры

dialogOptions

SkillDialogOptions

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

dialogId

string

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

Комментарии

Параметр параметров в beginDialog() должен быть объектом SkillDialogArgs с начальными параметрами для диалогового окна.

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

id

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

string id

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

string

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

Комментарии

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

telemetryClient

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

BotTelemetryClient telemetryClient

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

BotTelemetryClient

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

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

EndOfTurn

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

static EndOfTurn: DialogTurnResult

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

DialogTurnResult

Комментарии

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

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

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

beginDialog(DialogContext, BeginSkillDialogOptions)

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

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

Параметры

dc

DialogContext

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

options

BeginSkillDialogOptions

Начальные сведения для передачи в диалоговое окно.

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

Promise<DialogTurnResult>

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

Комментарии

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

continueDialog(DialogContext)

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

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

Параметры

dc

DialogContext

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

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

Promise<DialogTurnResult>

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

Комментарии

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

endDialog(TurnContext, DialogInstance, DialogReason)

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

function endDialog(context: TurnContext, instance: DialogInstance, reason: DialogReason): Promise<void>

Параметры

context

TurnContext

Объект TurnContext для этого поворота.

instance

DialogInstance

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

reason

DialogReason

(xref:botbuilder-dialogs. DialogReason) почему диалоговое окно закончилось.

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

Promise<void>

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

repromptDialog(TurnContext, DialogInstance)

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

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

Параметры

context

TurnContext

Объект TurnContext для этого поворота.

instance

DialogInstance

Сведения о состоянии этого диалогового окна.

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

Promise<void>

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

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>

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

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

configure(Record<string, unknown>)

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

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

Параметры

config

Record<string, unknown>

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

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

this

После завершения операции настраиваемый.

наследуется отConfigurable.configure

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