FormBuilderJson Classe
Définition
Important
Certaines informations portent sur la préversion du produit qui est susceptible d’être en grande partie modifiée avant sa publication. Microsoft exclut toute garantie, expresse ou implicite, concernant les informations fournies ici.
Créez un formulaire en spécifiant des messages, des champs et des confirmations via un schéma JSON ou programmatiquement.
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
Remarques
Définissez un formulaire via un schéma JSON avec des annotations supplémentaires facultatives qui correspondent aux attributs fournis pour C#.
%FormFlow utilise un certain nombre de mots clés de schéma JSON standard, notamment :
-
type
-- Définit le type de champs. *enum
-- Définit les valeurs de champ possibles. *minimum
-- Définit la valeur minimale autorisée comme décrit dans NumericAttribute. *maximum
-- Définit la valeur maximale autorisée comme décrit dans NumericAttribute. *required
-- Définit les champs requis. *pattern
-- Pour les champs de chaîne seront utilisés pour valider le modèle entré comme décrit dans PatternAttribute.Les modèles et les invites utilisent le même vocabulaire que TemplateAttribute et PromptAttribute. Les noms de propriété 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 pour remplacer le NotUnderstood modèle et spécifier un TemplateBaseAttribute.ChoiceStyle, vous devez le placer dans votre schéma : ~~~ « Templates » :{ « NotUnderstood » : { Patterns : ["I don’t get it"], « ChoiceStyle » :"Auto"}} ~~~
%Extensions définies à la racine du schéma *
OnCompletion: script
-- Script C# avec des arguments (IDialogContext contexte, état JObject) pour remplir le formulaire. *References: [assemblyReference, ...]
-- Définissez les références à inclure dans les scripts. Les chemins d’accès doivent être absolus ou relatifs au répertoire actif. Par défaut, Microsoft.Bot.Builder.dll est inclus. *Imports: [import, ...]
-- Définissez les importations à inclure dans les scripts avec des utilisations. Par défaut, ces espaces de noms sont inclus : Microsoft.Bot.Builder, Microsoft.Bot.Builder.Dialogs, Microsoft.Bot.Builder.FormFlow, Microsoft.Bot.Builder.FormFlow.Advanced, System.Collections.Generic, System.Linq%Extensions définies à la racine d’un schéma ou en tant qu’homologue de la propriété « type ». *
Templates:{TemplateUsage: { Patterns:[string, ...], <args> }, ...}
-- Définir des modèles. *Prompt: { Patterns:[string, ...] <args>}
-- Définissez une invite.%Extensions trouvées dans une description de propriété en tant qu’homologues 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 champ comme décrit dans DescribeAttribute. *Terms:[string,...]
-- Expressions régulières pour la correspondance d’une valeur de champ, comme décrit dans TermsAttribute. *MaxPhrase:int
-- Cela exécutera vos termes GenerateTerms(String, Int32) pour les développer. *Values:{ string: {Describe:string, Terms:[string, ...], MaxPhrase}, ...}
-- La chaîne doit se trouver dans les types « enum », ce qui vous permet de remplacer les descriptions et les termes générés automatiquement. Si MaxPhrase est spécifié, les termes sont transmis via GenerateTerms(String, Int32). *Active:script
-- Script C# avec des arguments (état JObject)->bool à tester pour voir si champ/message/confirm est actif. *Validate:script
-- Script C# avec des arguments (état JObject, valeur de l’objet)->ValidateResult pour la validation d’une valeur de champ. *Define:script
-- Script C# avec des arguments (état JObject, champ<JObject> champ) pour définir dynamiquement un champ. *Before:[confirm|message, ...]
-- Messages ou confirmations avant le champ contenant. *After:[confirm|message, ...]
-- Messages ou confirmations après le champ contenant. *{Confirm:script|[string, ...], ...templateArgs}
-- Avec Avant/Après, définissez une confirmation par le biais d’un script C# avec argument (état JObject) ou d’un ensemble de modèles qui seront sélectionnés de manière aléatoire avec des arguments de modèle facultatifs. *{Message:script|[string, ...] ...templateArgs}
-- Avec Avant/Après, définissez un message par le biais d’un script C# avec argument (état JObject) ou d’un ensemble de modèles qui seront sélectionnés de manière aléatoire avec des arguments de modèle facultatifs. *Dependencies
:[string, ...]-- 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: *
-- JObject form state bound for all scripts. *
état de choix-- internal dispatch for script to execute. *
ifield-- <xref data-throw-if-not-resolved="true" uid="Microsoft.Bot.Builder.FormFlow.Advanced.IField
1 »> pour permettre le raisonnement sur le champ actuel pour tous les scripts, à l’exception des générateurs d’invite %Message/Confirm. *value
-- valeur de l’objet à valider pour Validate. *field
-- Field<T> pour permettre la mise à jour dynamique d’un champ dans Définir. *context
-- IDialogContext context pour autoriser la publication des résultats dans OnCompletion.%Les champs définis par le biais de cette classe ont la même capacité d’étendre ou de remplacer les définitions de manière programmatique que tout autre champ. Ils peuvent également être localisés de la même façon.
Constructeurs
FormBuilderJson(JObject) |
Créez un générateur de formulaires JSON. |
Champs
_form |
Créez un formulaire en spécifiant des messages, des champs et des confirmations via un schéma JSON ou programmatiquement. (Hérité de FormBuilderBase<T>) |
Propriétés
Configuration |
Créez un formulaire en spécifiant des messages, des champs et des confirmations via un schéma JSON ou programmatiquement. (Hérité de FormBuilderBase<T>) |
Schema |
Créez un formulaire en spécifiant des messages, des champs et des confirmations via un schéma JSON ou programmatiquement. |
Méthodes
AddRemainingFields(IEnumerable<String>) |
Créez un formulaire en spécifiant des messages, des champs et des confirmations via un schéma JSON ou programmatiquement. |
Build(Assembly, String) |
Créez un formulaire en spécifiant des messages, des champs et des confirmations via un schéma JSON ou programmatiquement. |
Confirm(MessageDelegate<T>, ActiveDelegate<T>, IEnumerable<String>) |
Créez un formulaire en spécifiant des messages, des champs et des confirmations via un schéma JSON ou programmatiquement. (Hérité de FormBuilderBase<T>) |
Confirm(PromptAttribute, ActiveDelegate<T>, IEnumerable<String>) |
Créez un formulaire en spécifiant des messages, des champs et des confirmations via un schéma JSON ou programmatiquement. (Hérité de FormBuilderBase<T>) |
Confirm(String, ActiveDelegate<T>, IEnumerable<String>) |
Créez un formulaire en spécifiant des messages, des champs et des confirmations via un schéma JSON ou programmatiquement. (Hérité de FormBuilderBase<T>) |
Field(IField<T>) |
Créez un formulaire en spécifiant des messages, des champs et des confirmations via un schéma JSON ou programmatiquement. (Hérité de FormBuilderBase<T>) |
Field(String, ActiveDelegate<JObject>, ValidateAsyncDelegate<JObject>) |
Créez un formulaire en spécifiant des messages, des champs et des confirmations via un schéma JSON ou programmatiquement. |
Field(String, ActiveDelegate<T>, ValidateAsyncDelegate<T>) |
Créez un formulaire en spécifiant des messages, des champs et des confirmations via un schéma JSON ou programmatiquement. (Hérité de FormBuilderBase<T>) |
Field(String, PromptAttribute, ActiveDelegate<JObject>, ValidateAsyncDelegate<JObject>) |
Créez un formulaire en spécifiant des messages, des champs et des confirmations via un schéma JSON ou programmatiquement. |
Field(String, PromptAttribute, ActiveDelegate<T>, ValidateAsyncDelegate<T>) |
Créez un formulaire en spécifiant des messages, des champs et des confirmations via un schéma JSON ou programmatiquement. (Hérité de FormBuilderBase<T>) |
Field(String, String, ActiveDelegate<JObject>, ValidateAsyncDelegate<JObject>) |
Créez un formulaire en spécifiant des messages, des champs et des confirmations via un schéma JSON ou programmatiquement. |
Field(String, String, ActiveDelegate<T>, ValidateAsyncDelegate<T>) |
Créez un formulaire en spécifiant des messages, des champs et des confirmations via un schéma JSON ou programmatiquement. (Hérité de FormBuilderBase<T>) |
HasField(String) |
Créez un formulaire en spécifiant des messages, des champs et des confirmations via un schéma JSON ou programmatiquement. (Hérité de FormBuilderBase<T>) |
Message(MessageDelegate<T>, ActiveDelegate<T>, IEnumerable<String>) |
Créez un formulaire en spécifiant des messages, des champs et des confirmations via un schéma JSON ou programmatiquement. (Hérité de FormBuilderBase<T>) |
Message(PromptAttribute, ActiveDelegate<T>, IEnumerable<String>) |
Créez un formulaire en spécifiant des messages, des champs et des confirmations via un schéma JSON ou programmatiquement. (Hérité de FormBuilderBase<T>) |
Message(String, ActiveDelegate<T>, IEnumerable<String>) |
Créez un formulaire en spécifiant des messages, des champs et des confirmations via un schéma JSON ou programmatiquement. (Hérité de FormBuilderBase<T>) |
OnCompletion(OnCompletionAsyncDelegate<T>) |
Créez un formulaire en spécifiant des messages, des champs et des confirmations via un schéma JSON ou programmatiquement. (Hérité de FormBuilderBase<T>) |
Prompter(PromptAsyncDelegate<T>) |
Créez un formulaire en spécifiant des messages, des champs et des confirmations via un schéma JSON ou programmatiquement. (Hérité de FormBuilderBase<T>) |