Templates class

Paket:

botbuilder-lg

LG-Eingang, einschließlich Eigenschaften, die LG Datei hat, und bewerten Funktionen.

Konstruktoren

Templates(Template[], TemplateImport[], Diagnostic[], Templates[], string, string, ExpressionParser, ImportResolverDelegate, string[], string, Record<string, Templates>)

Erstellt eine neue Instanz der Templates Klasse.

Eigenschaften

allDiagnostics	Ruft alle Diagnosen aus der aktuellen LG-Datei und referenz lg Dateien ab.
allTemplates	Ruft alle Vorlagen aus der aktuellen lg-Datei und referenz lg Dateien ab.
content	LG-Inhalt.
diagnostics	Diagnostik.
enableFromFile	Gibt an, ob fromFile in LG-Vorlagen zulässig ist.
expressionParser	Ausdrucksparser.
id	ID der lg-Ressource.
importResolver	Delegat zum Auflösen der Ressourcen-ID der importierten LG-Datei.
imports	Importieren Sie Elemente, die diese LG-Datei direkt enthält.
inlineTemplateIdPrefix	Temp Template ID for inline content.
lgOptions	Ruft die Evluationsoptionen für die aktuelle LG-Datei ab. @returns Ein Wert, der angibt, ob die Optionen beim Auswerten von LG-Vorlagen verfügbar sind.
namedReferences	Zuordnen von Importalias zu Vorlagen.
namespace	Ruft den Namespace ab, der für die aktuelle LG-Datei registriert werden soll. @returns Ein Zeichenfolgenwert, der den Namespace darstellt, der für die aktuelle LG-Datei registriert werden soll.
options	LG-Dateioptionen.
references	alle Verweise, die diese LG-Datei von Imports otice hat: Verweis umfasst alle untergeordneten Importe aus der lg Datei, nicht nur die Kinder gehören direkt zu dieser lgfile. Die Referenzanzahl kann also >= Importanzahl.
source	Quelle der lg-Ressource. Vollständiger Pfad für lg-Datei.

Methoden

addTemplate(string, string[], string)	Fügen Sie eine neue Vorlage hinzu, und geben Sie die LG-Datei zurück.
analyzeTemplate(string, AnalyzerOptions)	Analysieren Sie eine Vorlage, um die Ergebnisse der statischen Analyse einschließlich Variablen und Vorlagenverweise abzurufen.
deleteTemplate(string)	Löschen Sie eine vorhandene Vorlage.
evaluate(string, object, EvaluationOptions)	Auswerten einer Vorlage mit angegebenem Namen und Bereich.
evaluateText(string, object, EvaluationOptions)	Wird verwendet, um eine Inlinevorlage str auszuwerten.
expandTemplate(string, object, EvaluationOptions)	Erweitern Sie eine Vorlage mit Dem angegebenen Namen und Bereich. Gibt alle möglichen Antworten statt zufällig zurück.
parseFile(string, ImportResolverDelegate, ExpressionParser)	Analysieren Sie eine Datei, und geben Sie die LG-Datei zurück.
parseResource(LGResource, ImportResolverDelegate, ExpressionParser)	Parser zum Umwandeln von lg-Inhalten in eine Vorlagen.
parseText(string, string, ImportResolverDelegate, ExpressionParser)	Parser zum Umwandeln von lg-Inhalten in eine Vorlagen.
push(Template[])	Fügt der Auflistung 1 oder mehr Vorlagen an.
toArray()	Ruft die Sammlung von Vorlagen ab.
toString()	Gibt eine Zeichenfolgendarstellung eines Templates Inhalt zurück.
updateTemplate(string, string, string[], string)	Aktualisieren Sie eine Vorlage, und geben Sie die LG-Datei zurück.

Details zum Konstruktor

Templates(Template[], TemplateImport[], Diagnostic[], Templates[], string, string, ExpressionParser, ImportResolverDelegate, string[], string, Record<string, Templates>)

Erstellt eine neue Instanz der Templates Klasse.

new Templates(items?: Template[], imports?: TemplateImport[], diagnostics?: Diagnostic[], references?: Templates[], content?: string, id?: string, expressionParser?: ExpressionParser, importResolverDelegate?: ImportResolverDelegate, options?: string[], source?: string, namedReferences?: Record<string, Templates>)

Parameter

items

Template[]

Wahlfrei. Liste der Vorlageninstanzen.

imports

TemplateImport[]

Wahlfrei. Liste der TemplateImport- Instanzen.

diagnostics

Diagnostic[]

Wahlfrei. Liste der Diagnose- Instanzen.

references

Templates[]

Wahlfrei. Liste der Vorlagen Instanzen.

content

string

Wahlfrei. Inhalt der aktuellen Vorlageninstanz.

id

string

Wahlfrei. ID der aktuellen Vorlageninstanz.

expressionParser

ExpressionParser

Wahlfrei. ExpressionParser, um die Ausdrücke im Inhalt zu analysieren.

importResolverDelegate

ImportResolverDelegate

Wahlfrei. Resolver zum Auflösen der LG-Import-ID in Vorlagentext.

options

string[]

Wahlfrei. Liste der Zeichenfolgen, die die Optionen während der Auswertung der Vorlagen darstellen.

source

string

Wahlfrei. Vorlagenquelle.

namedReferences

Record<string, Templates>

Wahlfrei. eferences that imported with the "as" syntax,for example: import as myAlias.

Details zur Eigenschaft

allDiagnostics

Ruft alle Diagnosen aus der aktuellen LG-Datei und referenz lg Dateien ab.

Diagnostic[] allDiagnostics

Eigenschaftswert

Diagnostic[]

Alle Diagnosen aus der aktuellen LG-Datei und verweisen auf lg-Dateien.

allTemplates

Ruft alle Vorlagen aus der aktuellen lg-Datei und referenz lg Dateien ab.

Template[] allTemplates

Eigenschaftswert

Template[]

Alle Vorlagen aus der aktuellen LG-Datei und verweisen auf lg-Dateien.

content

LG-Inhalt.

content: string

Eigenschaftswert

string

diagnostics

Diagnostik.

diagnostics: Diagnostic[]

Eigenschaftswert

Diagnostic[]

enableFromFile

Gibt an, ob fromFile in LG-Vorlagen zulässig ist.

static enableFromFile: boolean = false

Eigenschaftswert

boolean

expressionParser

Ausdrucksparser.

expressionParser: ExpressionParser

Eigenschaftswert

ExpressionParser

id

ID der lg-Ressource.

id: string

Eigenschaftswert

string

importResolver

Delegat zum Auflösen der Ressourcen-ID der importierten LG-Datei.

importResolver: ImportResolverDelegate

Eigenschaftswert

ImportResolverDelegate

imports

Importieren Sie Elemente, die diese LG-Datei direkt enthält.

imports: TemplateImport[]

Eigenschaftswert

TemplateImport[]

inlineTemplateIdPrefix

Temp Template ID for inline content.

static inlineTemplateIdPrefix: string = "__temp__"

Eigenschaftswert

string

lgOptions

Ruft die Evluationsoptionen für die aktuelle LG-Datei ab. @returns Ein Wert, der angibt, ob die Optionen beim Auswerten von LG-Vorlagen verfügbar sind.

EvaluationOptions lgOptions

Eigenschaftswert

EvaluationOptions

namedReferences

Zuordnen von Importalias zu Vorlagen.

namedReferences: Record<string, Templates>

Eigenschaftswert

Record<string, Templates>

namespace

Ruft den Namespace ab, der für die aktuelle LG-Datei registriert werden soll. @returns Ein Zeichenfolgenwert, der den Namespace darstellt, der für die aktuelle LG-Datei registriert werden soll.

string namespace

Eigenschaftswert

string

options

LG-Dateioptionen.

options: string[]

Eigenschaftswert

string[]

references

alle Verweise, die diese LG-Datei von Imports otice hat: Verweis umfasst alle untergeordneten Importe aus der lg Datei, nicht nur die Kinder gehören direkt zu dieser lgfile. Die Referenzanzahl kann also >= Importanzahl.

references: Templates[]

Eigenschaftswert

Templates[]

source

Quelle der lg-Ressource. Vollständiger Pfad für lg-Datei.

source: string

Eigenschaftswert

string

Details zur Methode

addTemplate(string, string[], string)

Fügen Sie eine neue Vorlage hinzu, und geben Sie die LG-Datei zurück.

function addTemplate(templateName: string, parameters: string[], templateBody: string): Templates

Parameter

templateName

string

Neuer Vorlagenname.

parameters

string[]

Neue Params.

templateBody

string

Neuer Vorlagentext.

Gibt zurück

Templates

Neue lg-Datei.

analyzeTemplate(string, AnalyzerOptions)

Analysieren Sie eine Vorlage, um die Ergebnisse der statischen Analyse einschließlich Variablen und Vorlagenverweise abzurufen.

function analyzeTemplate(templateName: string, analyzerOptions?: AnalyzerOptions): AnalyzerResult

Parameter

templateName

string

Vorlagenname, der ausgewertet werden soll.

analyzerOptions

AnalyzerOptions

Optionen für die Analyse der Vorlage.

Gibt zurück

AnalyzerResult

Analyseergebnis.

deleteTemplate(string)

Löschen Sie eine vorhandene Vorlage.

function deleteTemplate(templateName: string): Templates

Parameter

templateName

string

Welche Vorlage gelöscht werden soll.

Gibt zurück

Templates

Gibt die neue lg-Datei zurück.

evaluate(string, object, EvaluationOptions)

Auswerten einer Vorlage mit angegebenem Namen und Bereich.

function evaluate(templateName: string, scope?: object, opt: EvaluationOptions): any

Parameter

templateName

string

Vorlagenname, der ausgewertet werden soll.

scope

object

Der Status, der in der Auswertung sichtbar ist.

opt

EvaluationOptions

EvaluationOptions beim Auswerten einer Vorlage.

Gibt zurück

any

Ergebnis auswerten.

evaluateText(string, object, EvaluationOptions)

Wird verwendet, um eine Inlinevorlage str auszuwerten.

function evaluateText(inlineStr: string, scope?: object, opt: EvaluationOptions): any

Parameter

inlineStr

string

Inlinezeichenfolge, die ausgewertet wird.

scope

object

Scope-Objekt oder JToken.

opt

EvaluationOptions

EvaluationOptions beim Auswerten einer Vorlage.

Gibt zurück

any

Ausgewertetes Ergebnisobjekt.

expandTemplate(string, object, EvaluationOptions)

Erweitern Sie eine Vorlage mit Dem angegebenen Namen und Bereich. Gibt alle möglichen Antworten statt zufällig zurück.

function expandTemplate(templateName: string, scope?: object, opt: EvaluationOptions): any[]

Parameter

templateName

string

Vorlagenname, der ausgewertet werden soll.

scope

object

Der Status, der in der Auswertung sichtbar ist.

opt

EvaluationOptions

EvaluationOptions beim Erweitern einer Vorlage.

Gibt zurück

any[]

Ergebnis erweitern.

parseFile(string, ImportResolverDelegate, ExpressionParser)

Analysieren Sie eine Datei, und geben Sie die LG-Datei zurück.

static function parseFile(filePath: string, importResolver?: ImportResolverDelegate, expressionParser?: ExpressionParser): Templates

Parameter

filePath

string

LG absoluter Dateipfad..

importResolver

ImportResolverDelegate

Resolver zum Auflösen der LG-Import-ID in Vorlagentext.

expressionParser

ExpressionParser

Ausdrucksparser zum Auswerten von Ausdrücken.

Gibt zurück

Templates

Neue lg-Datei.

parseResource(LGResource, ImportResolverDelegate, ExpressionParser)

Parser zum Umwandeln von lg-Inhalten in eine Vorlagen.

static function parseResource(resource: LGResource, importResolver?: ImportResolverDelegate, expressionParser?: ExpressionParser): Templates

Parameter

resource

LGResource

LG-Ressource.

importResolver

ImportResolverDelegate

Resolver zum Auflösen der LG-Import-ID in Vorlagentext.

expressionParser

ExpressionParser

Ausdrucksparser zum Auswerten von Ausdrücken.

Gibt zurück

Templates

Entität.

parseText(string, string, ImportResolverDelegate, ExpressionParser)

Warnung

Diese API ist nun veraltet.

This method will soon be deprecated. Use ParseResource instead.

Parser zum Umwandeln von lg-Inhalten in eine Vorlagen.

static function parseText(content: string, id: string, importResolver?: ImportResolverDelegate, expressionParser?: ExpressionParser): Templates

Parameter

content

string

Textinhalt enthält lg-Vorlagen.

id

string

Die ID ist der Bezeichner des Inhalts. Wenn importResolver nicht definiert ist, muss die ID eine vollständige Pfadzeichenfolge sein.

importResolver

ImportResolverDelegate

Resolver zum Auflösen der LG-Import-ID in Vorlagentext.

expressionParser

ExpressionParser

Ausdrucksparser zum Auswerten von Ausdrücken.

Gibt zurück

Templates

Entität.

push(Template[])

Fügt der Auflistung 1 oder mehr Vorlagen an.

function push(args: Template[])

Parameter

args

Template[]

Liste der hinzuzufügenden Vorlagen.

toArray()

Ruft die Sammlung von Vorlagen ab.

function toArray(): Template[]

Gibt zurück

Template[]

Ein Verweis auf die interne Liste der Sammlungsvorlagen.

toString()

Gibt eine Zeichenfolgendarstellung eines Templates Inhalt zurück.

function toString(): string

Gibt zurück

string

Eine Zeichenfolgendarstellung eines Vorlagen Inhalt.

updateTemplate(string, string, string[], string)

Aktualisieren Sie eine Vorlage, und geben Sie die LG-Datei zurück.

function updateTemplate(templateName: string, newTemplateName: string, parameters: string[], templateBody: string): Templates

Parameter

templateName

string

Orignial template name.

newTemplateName

string

Neuer Vorlagenname.

parameters

string[]

Neue Params.

templateBody

string

Neuer Vorlagentext.

Gibt zurück

Templates

Neue lg-Datei.