FormBuilderJson Classe

Définition

public sealed class FormBuilderJson : Microsoft.Bot.Builder.FormFlow.FormBuilderBase<Newtonsoft.Json.Linq.JObject>

type FormBuilderJson = class
    inherit FormBuilderBase<JObject>

Public NotInheritable Class FormBuilderJson
Inherits FormBuilderBase(Of JObject)

Héritage

Object

FormBuilderBase<Newtonsoft.Json.Linq.JObject>

FormBuilderJson

Remarques

Définir un formulaire via un schéma JSON avec des annotations supplémentaires optionnelles correspondant aux attributs fournis pour C#.

%FormFlow utilise plusieurs mots-clés standards pour le schéma JSON , notamment :

• type -- Définit le type de champs. * enum -- Définit les valeurs possibles des champs. * minimum -- Définit la valeur minimale autorisée telle que décrite dans NumericAttribute. * maximum -- Définit la valeur maximale autorisée telle que décrite dans NumericAttribute. * required -- Définit quels champs sont requis. * pattern -- Pour les chaînes, les champs seront utilisés pour valider le motif saisi tel que décrit dans PatternAttribute.

  Les modèles et prompts utilisent le même vocabulaire que TemplateAttribute et PromptAttribute. Les noms des propriétés sont les mêmes et les valeurs sont les mêmes que celles de l’énumération C# sous-jacente. Par exemple, pour définir un modèle qui le supplie NotUnderstood et spécifie un TemplateBaseAttribute.ChoiceStyle, vous mettriez ceci dans votre schéma : ~~~ « Templates » :{ « NotUnderstood » : { Patterns : ["I don’t get it"], « ChoiceStyle » :"Auto"}} ~~~

  %Extensions défini à la racine du schéma * OnCompletion: script -- script C# avec arguments (IDialogContext contexte, état JObject) pour compléter le formulaire. * References: [assemblyReference, ...] -- Définir les références à inclure dans les scripts. Les chemins doivent être absolus, ou relatifs au répertoire actuel. Par défaut, Microsoft.Bot.Builder.dll est inclus. * Imports: [import, ...] -- Définir les importations à inclure dans les scripts avec les usages. Par défaut, ces espaces de noms sont inclus : Microsoft. Bot.Builder, Microsoft. Bot.Builder.Dialogues, Microsoft. Bot.Builder.FormFlow, Microsoft. Bot.Builder.FormFlow.Advanced, System.Collections.Generic, System.Linq

  %Extensions défini à la racine d’un schéma ou comme pair de la propriété « type ». * Templates:{TemplateUsage: { Patterns:[string, ...], <args> }, ...} -- Définir des modèles. * Prompt: { Patterns:[string, ...] <args>} -- Définissez une consigne.

  %Extensions qui se trouvent dans une description de propriété en tant que pairs de la propriété « type » d’un schéma JSON. * DateTime:bool -- Marque un champ comme étant un champ DateTime. * Describe:string -- Description d’un corps tel que décrit dans DescribeAttribute. * Terms:[string,...] -- Expressions régulières pour faire correspondre une valeur de champ telle que décrite dans TermsAttribute. * MaxPhrase:int -- Cela fera passer vos conditions GenerateTerms(String, Int32) pour les étendre. * Values:{ string: {Describe:string, Terms:[string, ...], MaxPhrase}, ...} -- La chaîne doit se trouver dans les types « enum », ce qui permet de passer outre les descriptions et termes générés automatiquement. Si MaxPhrase est spécifié, les termes sont transmis à GenerateTerms(String, Int32). * Active:script -- script C# avec arguments (état JObject) -> bool pour tester si champ/message/confirmation est actif. * Validate:script -- Script C# avec arguments (état JObject, valeur d’objet) -> ValidateResult pour valider une valeur de champ. * Define:script-- script C# avec arguments (état JObject, champ JObject> de champ<) pour définir dynamiquement un corps. * Before:[confirm|message, ...] -- Messages ou confirmations avant le champ de contenance. * After:[confirm|message, ...] -- Messages ou confirmations après le champ contenant. * {Confirm:script|[string, ...], ...templateArgs} -- Avec Avant/Après définissez une confirmation soit par un script C# avec argument (état JObject), soit par un ensemble de motifs sélectionnés aléatoirement avec des arguments modèles optionnels. * {Message:script|[string, ...] ...templateArgs} -- Avec Avant/Après définir un message soit via un script C# avec argument (état JObject), soit par un ensemble de motifs sélectionnés aléatoirement avec des arguments modèles optionnels. * Dependencies:[corde, ...]-- Fields that this field, message or confirm depends on.</p><p>Scripts can be any C# code you would find in a method body. You can add references through "References" and using through "Imports". Special global variables include: *choice-- internal dispatch for script to execute. *state-- JObject form state bound for all scripts. *ifield -- <xref data-throw-if-not-resolved="true" uid="Microsoft.Bot.Builder.FormFlow.Advanced.IField1"> pour permettre le raisonnement sur le champ actuel pour tous les scripts sauf %Message/Confirm prompt builders. * value -- valeur d’objet à valider pour Validate. * field -- Field<T> pour permettre la mise à jour dynamique d’un champ dans Define. * context -- IDialogContext contexte pour permettre la publication de résultats dans OnCompletion.

  %Fields définis par cette classe ont la même capacité d’étendre ou de surpasser les définitions de manière programmatique que tout autre domaine. Ils peuvent aussi être localisés de la même manière.