Templates class

Paket:

botbuilder-lg

LG-Eingang, einschließlich Eigenschaften, die die LG-Datei hat, und Auswerten von 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 den LG-Referenzdateien ab.
allTemplates	Ruft alle Vorlagen aus der aktuellen LG-Datei und den LG-Referenzdateien ab.
content	LG-Inhalte.
diagnostics	Diagnose.
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 enthält, direkt.
inlineTemplateIdPrefix	Temporäre Vorlagen-ID für Inlineinhalte.
lgOptions	Ruft die Evluationsoptionen für die aktuelle LG-Datei ab. @returns Ein Wert, der angibt, ob die Optionen beim Auswerten von LG-Vorlagen verwendet werden.
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 aus Imports otice: Reference enthält alle untergeordneten Importe aus der lg-Datei, nicht nur die untergeordneten Dateien gehören direkt zu dieser lgfile. Die Verweisanzahl kann >also = Importanzahl sein.
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 statischen Analyseergebnisse einschließlich Variablen und Vorlagenverweise abzurufen.
deleteTemplate(string)	Löschen Sie eine vorhandene Vorlage.
evaluate(string, object, EvaluationOptions)	Werten Sie eine Vorlage mit angegebenem Namen und Bereich aus.
evaluateText(string, object, EvaluationOptions)	Verwenden Sie zum Auswerten einer Inlinevorlage str.
expandTemplate(string, object, EvaluationOptions)	Erweitern Sie eine Vorlage mit angegebenem 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, um lg content in Vorlagen umzuwandeln.
parseText(string, string, ImportResolverDelegate, ExpressionParser)	Parser, um lg content in Vorlagen umzuwandeln.
push(Template[])	Fügt der Auflistung mindestens 1 Vorlagen an.
toArray()	Ruft die Sammlung von Vorlagen ab.
toString()	Gibt eine Zeichenfolgendarstellung eines Vorlageninhalts 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[]

Optional. Liste der Vorlageninstanzen .

imports

TemplateImport[]

Optional. Liste der TemplateImport-Instanzen .

diagnostics

Diagnostic[]

Optional. Liste der Diagnoseinstanzen .

references

Templates[]

Optional. Liste der Vorlageninstanzen .

content

string

Optional. Inhalt der aktuellen Templates-Instanz.

id

string

Optional. ID der aktuellen Templates-Instanz.

expressionParser

ExpressionParser

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

importResolverDelegate

ImportResolverDelegate

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

options

string[]

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

source

string

Optional. Vorlagenquelle.

namedReferences

Record<string, Templates>

Optional. Eferences, die mit der Syntax "as" importiert wurden, z. B.: import as myAlias.

Details zur Eigenschaft

allDiagnostics

Ruft alle Diagnosen aus der aktuellen LG-Datei und den LG-Referenzdateien 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 den LG-Referenzdateien ab.

Template[] allTemplates

Eigenschaftswert

Template[]

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

content

LG-Inhalte.

content: string

Eigenschaftswert

string

diagnostics

Diagnose.

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 enthält, direkt.

imports: TemplateImport[]

Eigenschaftswert

TemplateImport[]

inlineTemplateIdPrefix

Temporäre Vorlagen-ID für Inlineinhalte.

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 verwendet werden.

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 aus Imports otice: Reference enthält alle untergeordneten Importe aus der lg-Datei, nicht nur die untergeordneten Dateien gehören direkt zu dieser lgfile. Die Verweisanzahl kann >also = Importanzahl sein.

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 Parameter.

templateBody

string

Neuer Vorlagentext.

Gibt zurück

Templates

Neue LG-Datei.

analyzeTemplate(string, AnalyzerOptions)

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

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

Parameter

templateName

string

Der auszuwertende Vorlagenname.

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)

Werten Sie eine Vorlage mit angegebenem Namen und Bereich aus.

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

Parameter

templateName

string

Der auszuwertende Vorlagenname.

scope

object

Der in der Auswertung sichtbare Zustand.

opt

EvaluationOptions

EvaluationOptions beim Auswerten einer Vorlage.

Gibt zurück

any

Bewerten Sie das Ergebnis.

evaluateText(string, object, EvaluationOptions)

Verwenden Sie zum Auswerten einer Inlinevorlage str.

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

Parameter

inlineStr

string

Inlinezeichenfolge, die ausgewertet wird.

scope

object

Bereichsobjekt oder JToken.

opt

EvaluationOptions

EvaluationOptions beim Auswerten einer Vorlage.

Gibt zurück

any

Ausgewertetes Ergebnisobjekt.

expandTemplate(string, object, EvaluationOptions)

Erweitern Sie eine Vorlage mit angegebenem 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

Der auszuwertende Vorlagenname.

scope

object

Der in der Auswertung sichtbare Zustand.

opt

EvaluationOptions

EvaluationOptions beim Erweitern einer Vorlage.

Gibt zurück

any[]

Erweitern Sie das Ergebnis.

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

ABSOLUTEr LG-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, um lg content in Vorlagen umzuwandeln.

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, um lg content in Vorlagen umzuwandeln.

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

Parameter

content

string

Textinhalt enthält lg-Vorlagen.

id

string

Id ist der Bezeichner des Inhalts. Wenn importResolver nicht definiert ist, muss 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 mindestens 1 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 Vorlageninhalts zurück.

function toString(): string

Gibt zurück

string

Eine Zeichenfolgendarstellung eines Vorlageninhalts .

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

Name der orignialen Vorlage.

newTemplateName

string

Neuer Vorlagenname.

parameters

string[]

Neue Params.

templateBody

string

Neuer Vorlagentext.

Gibt zurück

Templates

Neue lg-Datei.