FormBuilderJson Klass

Definition

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)

Arv

Object

FormBuilderBase<Newtonsoft.Json.Linq.JObject>

FormBuilderJson

Kommentarer

Definiera ett formulär via JSON Schema med valfria tilläggsanteckningar som motsvarar attributen som tillhandahålls för C#.

%FormFlow använder ett antal standardnyckelord för JSON Schema inkluderar:

• type -- Definierar fälttypen. * enum -- Definierar de möjliga fältvärdena. * minimum -- Definierar det minsta tillåtna värdet som beskrivs i NumericAttribute. * maximum -- Definierar det maximalt tillåtna värdet som beskrivs i NumericAttribute. * required -- Definierar vilka fält som krävs. * pattern -- För strängfält kommer att användas för att validera det inmatade mönstret som beskrivs i PatternAttribute.

  Mallar och promptar använder samma vokabulär som TemplateAttribute och PromptAttribute. Egenskapsnamnen är desamma och värdena är desamma som i den underliggande C#-uppräkningen. Till exempel, för att definiera en mall som åsidosätter mallen NotUnderstood och ange en TemplateBaseAttribute.ChoiceStyle, skulle du lägga in detta i ditt schema: ~~~ "Templates":{ "NotUnderstood": { Patterns: ["I don't get it"], "ChoiceStyle":"Auto"}} ~~~

  %Extensions definierad vid roten av schemat * OnCompletion: script -- C#-skript med argument (IDialogContext kontext, JObject-tillstånd) för att komplettera formuläret. * References: [assemblyReference, ...] -- Definiera referenser att inkludera i skript. Vägar bör vara absoluta, eller relativa till den aktuella katalogen. Som standard ingår Microsoft.Bot.Builder.dll. * Imports: [import, ...] -- Definiera importer som inkluderas i skript med användning. Som standard ingår dessa namnrymder: Microsoft. Bot.Builder, Microsoft. Bot.Builder.Dialogs, Microsoft. Bot.Builder.FormFlow, Microsoft. Bot.Builder.FormFlow.Advanced, System.Collections.Generic, System.Linq

  %Extensions definierad vid roten av ett schema eller som en peer av egenskapen "typ". * Templates:{TemplateUsage: { Patterns:[string, ...], <args> }, ...} -- Definiera mallar. * Prompt: { Patterns:[string, ...] <args>} -- Definiera en prompt.

  %Extensions som finns i en egenskapsbeskrivning som peers till egenskapen "type" i ett JSON-schema. * DateTime:bool -- markerar ett fält som ett DateTime-fält. * Describe:string -- Beskrivning av ett fält som beskrivs i DescribeAttribute. * Terms:[string,...] -- Reguljära uttryck för att matcha ett fältvärde som beskrivs i TermsAttribute. * MaxPhrase:int -- Detta kommer att gå igenom GenerateTerms(String, Int32) dina villkor för att utöka dem. * Values:{ string: {Describe:string, Terms:[string, ...], MaxPhrase}, ...} -- Strängen måste hittas i typerna "enum" och detta gör att du kan åsidosätta de automatiskt genererade beskrivningarna och termerna. Om MaxPhrase anges skickas termerna genom GenerateTerms(String, Int32). * Active:script -- C#-skript med argument (JObject-tillstånd)->bool för att testa om fält/meddelande/bekräfta är aktivt. * Validate:script -- C#-skript med argument (JObject-tillstånd, objektvärde)->ValidateResult för att validera ett fältvärde. * Define:script -- C#-skript med argument (JObject-tillstånd, fält<JObject-fält> ) för dynamisk definiering av ett fält. * Before:[confirm|message, ...] -- Meddelanden eller bekräftelser före det innehållande fältet. * After:[confirm|message, ...] -- Meddelanden eller bekräftelser efter det innehållande fältet. * {Confirm:script|[string, ...], ...templateArgs} -- Med Före/Efter definiera en bekräftelse antingen genom ett C#-skript med argument (JObject-tillstånd) eller genom en uppsättning mönster som slumpmässigt väljs med valfria mallargument. * {Message:script|[string, ...] ...templateArgs} -- Med Före/Efter definierar du ett meddelande antingen genom ett C#-skript med argument (JObject-tillstånd) eller genom en uppsättning mönster som slumpmässigt väljs med valfria mallargument. * Dependencies:[sträng, ...]-- 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: *valtillstånd-- internal dispatch for script to execute. *-- JObject form state bound for all scripts. *ifield -- <xref data-throw-if-not-resolved="true" uid="Microsoft.Bot.Builder.FormFlow.Advanced.IField1"> för att möjliggöra resonemang över det aktuella fältet för alla skript utom %Message/Bekräfta promptbyggare. * value -- objektvärde som ska valideras för Validate. * field -- Field<T> för att möjliggöra dynamisk uppdatering av ett fält i Define. * context -- IDialogContext kontext för att möjliggöra publicering av resultat i OnCompletion.

  %Fields definierade genom denna klass har samma förmåga att utvidga eller åsidosätta definitionerna programatiskt som vilket annat fält som helst. De kan också lokaliseras på samma sätt.