BeginSkill class

Paquet:

botbuilder-dialogs-adaptive

Commencez une compétence.

Extends

SkillDialog

Constructeurs

BeginSkill(SkillDialogOptions)

Crée une instance « BeginSkillDialog ».

Propriétés

$kind
activity	Modèle pour l’activité.
activityProcessed	Valeur indiquant si la nouvelle boîte de dialogue doit traiter l’activité.
allowInterruptions	Stratégie d’interruption.
botId	ID d’application Microsoft qui appellera la compétence.
connectionName	Optionnel. Nom de connexion OAuth pour le bot parent.
disabled	Expression facultative qui, si la valeur est true, désactive cette action.
resultProperty	Chemin de propriété facultatif pour stocker le résultat de la boîte de dialogue.
skillAppId	ID d’application Microsoft pour la compétence.
skillEndpoint	Point de terminaison /api/messages de la compétence.
skillHostEndpoint	URL de rappel de l’hôte de compétence.

Propriétés héritées

EndOfTurn	Obtient un résultat de fin de tour par défaut.
id
telemetryClient

Méthodes

beginDialog(DialogContext, BeginSkillDialogOptions)	Appelé lorsque le de dialogue est démarré et envoyé (push) sur la pile de dialogues.
continueDialog(DialogContext)	Appelé lorsque le dialogue est continu, où il s’agit du dialogue actif et que l’utilisateur répond avec une nouvelle activité.
endDialog(TurnContext, DialogInstance, DialogReason)	Appelé lorsque la boîte de dialogue se termine.
getConverter(Object)
repromptDialog(TurnContext, DialogInstance)	Appelé lorsque la boîte de dialogue doit inviter l’utilisateur à entrer une nouvelle fois.
resumeDialog(DialogContext, DialogReason, any)	Appelé lorsqu’un dialogue enfant terminé son tour, renvoyant le contrôle à ce dialogue.

Méthodes héritées

configure(Record<string, unknown>)	Méthode Fluent pour la configuration de l’objet.
getVersion()	Chaîne encodée utilisée pour faciliter la détection des modifications de bot lors du rééploiement.
onDialogEvent(DialogContext, DialogEvent)	Appelé lorsqu’un événement a été déclenché, à l’aide de DialogContext.emitEvent(), par la boîte de dialogue active ou par une boîte de dialogue que la boîte de dialogue active a démarré.

Détails du constructeur

BeginSkill(SkillDialogOptions)

Crée une instance « BeginSkillDialog ».

new BeginSkill(options?: SkillDialogOptions)

Paramètres

options

SkillDialogOptions

Options facultatives utilisées pour configurer la boîte de dialogue de compétence.

Détails de la propriété

$kind

static $kind: string

Valeur de propriété

string

activity

Modèle pour l’activité.

activity: TemplateInterface<Partial<Activity>, DialogStateManager>

Valeur de propriété

TemplateInterface<Partial<Activity>, DialogStateManager>

activityProcessed

Valeur indiquant si la nouvelle boîte de dialogue doit traiter l’activité.

activityProcessed: BoolExpression

Valeur de propriété

BoolExpression

Remarques

La valeur par défaut est true, ce qui signifie que la nouvelle boîte de dialogue ne doit pas examiner l’activité. Vous pouvez définir cette valeur sur false pour distribuer l’activité à la nouvelle boîte de dialogue.

allowInterruptions

Stratégie d’interruption.

allowInterruptions: BoolExpression

Valeur de propriété

BoolExpression

botId

ID d’application Microsoft qui appellera la compétence.

botId: StringExpression

Valeur de propriété

StringExpression

Remarques

Defauls à une valeur de =settings.MicrosoftAppId qui récupère l’ID des bots à partir de paramètres.

connectionName

Optionnel. Nom de connexion OAuth pour le bot parent.

connectionName: StringExpression

Valeur de propriété

StringExpression

disabled

Expression facultative qui, si la valeur est true, désactive cette action.

disabled?: BoolExpression

Valeur de propriété

BoolExpression

resultProperty

Chemin de propriété facultatif pour stocker le résultat de la boîte de dialogue.

resultProperty?: StringExpression

Valeur de propriété

StringExpression

skillAppId

ID d’application Microsoft pour la compétence.

skillAppId: StringExpression

Valeur de propriété

StringExpression

skillEndpoint

Point de terminaison /api/messages de la compétence.

skillEndpoint: StringExpression

Valeur de propriété

StringExpression

skillHostEndpoint

URL de rappel de l’hôte de compétence.

skillHostEndpoint: StringExpression

Valeur de propriété

StringExpression

Remarques

Defauls à une valeur de =settings.SkillHostEndpoint qui récupère le point de terminaison à partir des paramètres.

Détails de la propriété héritée

EndOfTurn

Obtient un résultat de fin de tour par défaut.

static EndOfTurn: DialogTurnResult

Valeur de propriété

DialogTurnResult

Remarques

Ce résultat indique qu’un dialogue (ou une étape logique dans un dialogue) a terminé le traitement du tour actuel, est toujours actif et attend plus d’entrée.

héritée de Dialog.EndOfTurn

id

id: string

Valeur de propriété

string

héritée de Dialog.id

telemetryClient

telemetryClient: BotTelemetryClient

Valeur de propriété

BotTelemetryClient

héritée de Dialog.telemetryClient

Détails de la méthode

beginDialog(DialogContext, BeginSkillDialogOptions)

Appelé lorsque le de dialogue est démarré et envoyé (push) sur la pile de dialogues.

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

Paramètres

dc

DialogContext

DialogContext pour le tour de conversation actuel.

options

BeginSkillDialogOptions

Optionnel. Informations initiales à transmettre à la boîte de dialogue.

Retours

Promise<DialogTurnResult>

Un Promise représentant l’opération asynchrone.

continueDialog(DialogContext)

Appelé lorsque le dialogue est continu, où il s’agit du dialogue actif et que l’utilisateur répond avec une nouvelle activité.

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

Paramètres

dc

DialogContext

DialogContext pour le tour de conversation actuel.

Retours

Promise<DialogTurnResult>

Un Promise représentant l’opération asynchrone.

endDialog(TurnContext, DialogInstance, DialogReason)

Appelé lorsque la boîte de dialogue se termine.

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

Paramètres

turnContext

TurnContext

(xref :botbuilder-core. TurnContext), l’objet de contexte de ce tour.

instance

DialogInstance

(xref :botbuilder-dialogs. DialogInstance), informations d’état associées à l’instance de ce dialogue sur la pile de dialogues.

reason

DialogReason

(xref :botbuilder-dialogs. DialogReason), raison pour laquelle le dialogue s’est terminé.

Retours

Promise<void>

Un Promise représentant l’opération asynchrone.

getConverter(Object)

function getConverter(property: Object): Converter | ConverterFactory

Paramètres

property

Object

Clé de la configuration du sélecteur conditionnel.

Retours

Converter | ConverterFactory

Convertisseur de la configuration du sélecteur.

repromptDialog(TurnContext, DialogInstance)

Appelé lorsque la boîte de dialogue doit inviter l’utilisateur à entrer une nouvelle fois.

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

Paramètres

turnContext

TurnContext

(xref :botbuilder-core. TurnContext), l’objet de contexte de ce tour.

instance

DialogInstance

(xref :botbuilder-dialogs. DialogInstance), informations d’état pour ce dialogue.

Retours

Promise<void>

Un Promise représentant l’opération asynchrone.

resumeDialog(DialogContext, DialogReason, any)

Appelé lorsqu’un dialogue enfant terminé son tour, renvoyant le contrôle à ce dialogue.

function resumeDialog(dc: DialogContext, reason: DialogReason, result?: any): Promise<DialogTurnResult<any>>

Paramètres

dc

DialogContext

DialogContext pour le tour de conversation actuel.

reason

DialogReason

(xref :botbuilder-dialogs. DialogReason), raison pour laquelle le dialogue a repris.

result

any

Optionnel. Valeur retournée par la boîte de dialogue qui a été appelée. Le type de la valeur retournée dépend de la boîte de dialogue enfant.

Retours

Promise<DialogTurnResult<any>>

Un Promise représentant l’opération asynchrone.

Détails de la méthode héritée

configure(Record<string, unknown>)

Méthode Fluent pour la configuration de l’objet.

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

Paramètres

config

Record<string, unknown>

Paramètres de configuration à appliquer.

Retours

this

configurable une fois l’opération terminée.

héritée de Configurable.configure

getVersion()

Chaîne encodée utilisée pour faciliter la détection des modifications de bot lors du rééploiement.

function getVersion(): string

Retours

string

Chaîne unique qui ne doit changer que lorsque la boîte de dialogue a changé de manière à redémarrer la boîte de dialogue.

Remarques

Cela permet par défaut de retourner les dialogues id, mais peut être substitué pour fournir une logique de détection des modifications plus précise. Toute boîte de dialogue sur la pile qui a sa modification de version entraîne un événement versionChanged sera déclenché. Si cet événement n’est pas géré par le bot, une erreur est générée, ce qui entraîne l’exécution de la logique du gestionnaire d’erreurs des bots.

Le renvoi d’une chaîne vide désactive le suivi des versions pour le composant tous ensemble.

héritée de Dialog.getVersion

onDialogEvent(DialogContext, DialogEvent)

Appelé lorsqu’un événement a été déclenché, à l’aide de DialogContext.emitEvent(), par la boîte de dialogue active ou par une boîte de dialogue que la boîte de dialogue active a démarré.

function onDialogEvent(dc: DialogContext, e: DialogEvent): Promise<boolean>

Paramètres

dc

DialogContext

Contexte de boîte de dialogue pour le tour de conversation actuel.

e

DialogEvent

Événement déclenché.

Retours

Promise<boolean>

True si l’événement est géré par la boîte de dialogue actuelle et que le bouglage doit s’arrêter.

héritée de Dialog.onDialogEvent