BeginSkill class

Ссылка

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

Начните навык.

Extends: SkillDialog

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

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

Свойства

$kind
activity	Шаблон действия.
activityProcessed	Значение, указывающее, должен ли новый диалог обрабатывать действие.
allowInterruptions	Политика прерывания.
botId	Идентификатор приложения Майкрософт, который будет вызывать навык.
connectionName	Необязательный. Имя подключения OAuth для родительского бота.
disabled	Необязательное выражение, которое, если имеет значение true, отключит это действие.
resultProperty	Необязательный путь к свойству для хранения диалогового окна.
skillAppId	Идентификатор приложения Майкрософт для навыка.
skillEndpoint	Конечная точка `/api/messages` для навыка.
skillHostEndpoint	URL-адрес обратного вызова для узла навыка.

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

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

Методы

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

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

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

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

BeginSkill(SkillDialogOptions)

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

new BeginSkill(options?: SkillDialogOptions)

Параметры

options: SkillDialogOptions

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

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

$kind

static $kind: string

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

string

activity

Шаблон действия.

activity: TemplateInterface<Partial<Activity>, DialogStateManager>

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

TemplateInterface<Partial<Activity>, DialogStateManager>

activityProcessed

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

activityProcessed: BoolExpression

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

BoolExpression

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

allowInterruptions

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

allowInterruptions: BoolExpression

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

BoolExpression

botId

Идентификатор приложения Майкрософт, который будет вызывать навык.

botId: StringExpression

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

StringExpression

connectionName

Необязательный. Имя подключения OAuth для родительского бота.

connectionName: StringExpression

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

StringExpression

disabled

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

disabled?: BoolExpression

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

BoolExpression

resultProperty

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

resultProperty?: StringExpression

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

StringExpression

skillAppId

Идентификатор приложения Майкрософт для навыка.

skillAppId: StringExpression

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

StringExpression

skillEndpoint

Конечная точка /api/messages для навыка.

skillEndpoint: StringExpression

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

StringExpression

skillHostEndpoint

URL-адрес обратного вызова для узла навыка.

skillHostEndpoint: StringExpression

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

StringExpression

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

EndOfTurn

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

static EndOfTurn: DialogTurnResult

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

DialogTurnResult

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

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

id

id: string

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

string

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

telemetryClient

telemetryClient: BotTelemetryClient

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

BotTelemetryClient

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

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

beginDialog(DialogContext, BeginSkillDialogOptions)

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

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

Параметры

dc: DialogContext

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

options: BeginSkillDialogOptions

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

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

Promise<DialogTurnResult>

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

continueDialog(DialogContext)

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

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

Параметры

dc: DialogContext

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

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

Promise<DialogTurnResult>

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

endDialog(TurnContext, DialogInstance, DialogReason)

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

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

Параметры

turnContext: TurnContext

(xref:botbuilder-core. TurnContext), объект контекста для этого поворота.

instance: DialogInstance

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

reason: DialogReason

(xref:botbuilder-dialogs. DialogReason), причина окончания диалога.

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

Promise<void>

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

getConverter(Object)

function getConverter(property: Object): Converter | ConverterFactory

Параметры

property: Object

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

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

Converter | ConverterFactory

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

repromptDialog(TurnContext, DialogInstance)

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

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

Параметры

turnContext: 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<any>>

Параметры

dc: DialogContext

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

reason: DialogReason

(xref:botbuilder-dialogs. DialogReason), причина возобновления диалога.

result: any

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

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

Promise<DialogTurnResult<any>>

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

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

configure(Record<string, unknown>)

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

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

Параметры

config: Record<string, unknown>

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

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

this

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

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

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

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

Параметры

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

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

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

Комментарии

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

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

Комментарии

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

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

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

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

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

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

Комментарии

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

Комментарии

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

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

Параметры

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

Параметры

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

Параметры

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

Параметры

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

Параметры

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

Параметры

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

Параметры

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

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

Комментарии

Параметры

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