Condividi tramite

Templates class

  • Riferimento
Pacchetto:
botbuilder-lg

Ingresso LG, incluse le proprietà che il file LG ha e valuta le funzioni.

Costruttori

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

Crea una nuova istanza della classe modelli di .

Proprietà

allDiagnostics

Ottiene tutta la diagnostica dal file lg corrente e dai file lg di riferimento.
allTemplates

Ottiene tutti i modelli dal file lg corrente e dai file lg di riferimento.
content

Contenuto LG.
diagnostics

Diagnostica.
enableFromFile

Indica se fromFile è consentito nei modelli LG.
expressionParser

parser di espressioni.
id

ID della risorsa lg.
importResolver

Delegato per la risoluzione dell'ID risorsa del file lg importato.
imports

importare elementi che questo file LG contiene direttamente.
inlineTemplateIdPrefix

ID modello temporaneo per il contenuto inline.
lgOptions

Ottiene le opzioni di evluazione per il file LG corrente. @returns Valore A che indica se le opzioni durante la valutazione dei modelli LG.
namedReferences

Eseguire il mapping dall'alias di importazione ai modelli.
namespace

Ottiene lo spazio dei nomi da registrare per il file LG corrente. @returns Valore stringa che rappresenta lo spazio dei nomi da registrare per il file LG corrente.
options

Opzioni del file LG.
references

tutti i riferimenti che questo file LG ha da Imports otice: riferimento includ tutte le importazioni figlio dal file lg, non solo gli elementi figlio appartengono direttamente a questo lgfile. quindi, il conteggio dei riferimenti può >= conteggio importazioni.
source

Origine della risorsa lg. Percorso completo per il file lg.

Metodi

addTemplate(string, string[], string)

Aggiungere un nuovo modello e restituire il file LG.
analyzeTemplate(string, AnalyzerOptions)

Analizzare un modello per ottenere i risultati dell'analizzatore statico, incluse le variabili e i riferimenti al modello.
deleteTemplate(string)

Eliminare un modello esistente.
evaluate(string, object, EvaluationOptions)

Valutare un modello con il nome e l'ambito specificati.
evaluateText(string, object, EvaluationOptions)

Usare per valutare un modello inline str.
expandTemplate(string, object, EvaluationOptions)

Espandere un modello con il nome e l'ambito specificati. Restituisce tutte le risposte possibili anziché una casuale.
parseFile(string, ImportResolverDelegate, ExpressionParser)

Analizzare un file e restituire il file LG.
parseResource(LGResource, ImportResolverDelegate, ExpressionParser)

Parser per trasformare il contenuto lg in un modello.
parseText(string, string, ImportResolverDelegate, ExpressionParser)

Parser per trasformare il contenuto lg in un modello.
push(Template[])

Aggiunge 1 o più modelli alla raccolta.
toArray()

Ottiene la raccolta di modelli.
toString()

Restituisce una rappresentazione di stringa di un modelli contenuto.
updateTemplate(string, string, string[], string)

Aggiornare un modello e restituire il file LG.

Dettagli costruttore

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

Crea una nuova istanza della classe modelli di .

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>)

Parametri

items

Template[]

Opzionale. Elenco delle istanze di modello di .

imports

TemplateImport[]

Opzionale. Elenco di istanze di TemplateImport.

diagnostics

Diagnostic[]

Opzionale. Elenco delle istanze di diagnostica di .

references

Templates[]

Opzionale. Elenco di istanze modelli di .

content

string

Opzionale. Contenuto dell'istanza modelli corrente.

id

string

Opzionale. ID dell'istanza modelli corrente.

expressionParser

ExpressionParser

Opzionale. ExpressionParser per analizzare le espressioni nel contenuto.

importResolverDelegate
ImportResolverDelegate

Opzionale. Resolver per risolvere l'ID di importazione LG nel testo del modello.

options

string[]

Opzionale. Elenco di stringhe che rappresentano le opzioni durante la valutazione dei modelli.

source

string

Opzionale. Origine modelli.

namedReferences

Record<string, Templates>

Opzionale. riferimenti importati con la sintassi "as", ad esempio: importare come myAlias.

Dettagli proprietà

allDiagnostics

Ottiene tutta la diagnostica dal file lg corrente e dai file lg di riferimento.

Diagnostic[] allDiagnostics

Valore della proprietà

Diagnostic[]

Tutta la diagnostica dal file lg corrente e dai file lg di riferimento.

allTemplates

Ottiene tutti i modelli dal file lg corrente e dai file lg di riferimento.

Template[] allTemplates

Valore della proprietà

Template[]

Tutti i modelli del file lg corrente e i file lg di riferimento.

content

Contenuto LG.

content: string

Valore della proprietà

string

diagnostics

Diagnostica.

diagnostics: Diagnostic[]

Valore della proprietà

Diagnostic[]

enableFromFile

Indica se fromFile è consentito nei modelli LG.

static enableFromFile: boolean = false

Valore della proprietà

boolean

expressionParser

parser di espressioni.

expressionParser: ExpressionParser

Valore della proprietà

ExpressionParser

id

ID della risorsa lg.

id: string

Valore della proprietà

string

importResolver

Delegato per la risoluzione dell'ID risorsa del file lg importato.

importResolver: ImportResolverDelegate

Valore della proprietà

ImportResolverDelegate

imports

importare elementi che questo file LG contiene direttamente.

imports: TemplateImport[]

Valore della proprietà

TemplateImport[]

inlineTemplateIdPrefix

ID modello temporaneo per il contenuto inline.

static inlineTemplateIdPrefix: string = "__temp__"

Valore della proprietà

string

lgOptions

Ottiene le opzioni di evluazione per il file LG corrente. @returns Valore A che indica se le opzioni durante la valutazione dei modelli LG.

EvaluationOptions lgOptions

Valore della proprietà

EvaluationOptions

namedReferences

Eseguire il mapping dall'alias di importazione ai modelli.

namedReferences: Record<string, Templates>

Valore della proprietà

Record<string, Templates>

namespace

Ottiene lo spazio dei nomi da registrare per il file LG corrente. @returns Valore stringa che rappresenta lo spazio dei nomi da registrare per il file LG corrente.

string namespace

Valore della proprietà

string

options

Opzioni del file LG.

options: string[]

Valore della proprietà

string[]

references

tutti i riferimenti che questo file LG ha da Imports otice: riferimento includ tutte le importazioni figlio dal file lg, non solo gli elementi figlio appartengono direttamente a questo lgfile. quindi, il conteggio dei riferimenti può >= conteggio importazioni.

references: Templates[]

Valore della proprietà

Templates[]

source

Origine della risorsa lg. Percorso completo per il file lg.

source: string

Valore della proprietà

string

Dettagli metodo

addTemplate(string, string[], string)

Aggiungere un nuovo modello e restituire il file LG.

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

Parametri

templateName

string

Nuovo nome del modello.

parameters

string[]

Nuovi parametri.

templateBody

string

Nuovo corpo del modello.

Restituisce

Templates

Nuovo file lg.

analyzeTemplate(string, AnalyzerOptions)

Analizzare un modello per ottenere i risultati dell'analizzatore statico, incluse le variabili e i riferimenti al modello.

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

Parametri

templateName

string

Nome del modello da valutare.

analyzerOptions
AnalyzerOptions

Opzioni per l'analisi del modello.

Restituisce

AnalyzerResult

Risultato dell'analizzatore.

deleteTemplate(string)

Eliminare un modello esistente.

function deleteTemplate(templateName: string): Templates

Parametri

templateName

string

Quale modello deve eliminare.

Restituisce

Templates

Restituisce il nuovo file lg.

evaluate(string, object, EvaluationOptions)

Valutare un modello con il nome e l'ambito specificati.

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

Parametri

templateName

string

Nome del modello da valutare.

scope

object

Stato visibile nella valutazione.

opt
EvaluationOptions

EvaluationOptions nella valutazione di un modello.

Restituisce

any

Valutare il risultato.

evaluateText(string, object, EvaluationOptions)

Usare per valutare un modello inline str.

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

Parametri

inlineStr

string

Stringa inline che verrà valutata.

scope

object

Oggetto Scope o JToken.

opt
EvaluationOptions

EvaluationOptions nella valutazione di un modello.

Restituisce

any

Oggetto risultato valutato.

expandTemplate(string, object, EvaluationOptions)

Espandere un modello con il nome e l'ambito specificati. Restituisce tutte le risposte possibili anziché una casuale.

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

Parametri

templateName

string

Nome del modello da valutare.

scope

object

Stato visibile nella valutazione.

opt
EvaluationOptions

EvaluationOptions nell'espansione di un modello.

Restituisce

any[]

Espandere il risultato.

parseFile(string, ImportResolverDelegate, ExpressionParser)

Analizzare un file e restituire il file LG.

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

Parametri

filePath

string

LG absolute file path..

importResolver
ImportResolverDelegate

Resolver per risolvere l'ID di importazione LG nel testo del modello.

expressionParser

ExpressionParser

Parser di espressioni per la valutazione delle espressioni.

Restituisce

Templates

Nuovo file lg.

parseResource(LGResource, ImportResolverDelegate, ExpressionParser)

Parser per trasformare il contenuto lg in un modello.

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

Parametri

resource
LGResource

Risorsa LG.

importResolver
ImportResolverDelegate

Resolver per risolvere l'ID di importazione LG nel testo del modello.

expressionParser

ExpressionParser

Parser di espressioni per la valutazione delle espressioni.

Restituisce

Templates

Entità.

parseText(string, string, ImportResolverDelegate, ExpressionParser)

Avviso

Questa API è ora deprecata.

This method will soon be deprecated. Use ParseResource instead.

Parser per trasformare il contenuto lg in un modello.

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

Parametri

content

string

Il contenuto del testo contiene modelli lg.

id

string

ID è l'identificatore del contenuto. Se importResolver non è definito, id deve essere una stringa di percorso completa.

importResolver
ImportResolverDelegate

Resolver per risolvere l'ID di importazione LG nel testo del modello.

expressionParser

ExpressionParser

Parser di espressioni per la valutazione delle espressioni.

Restituisce

Templates

Entità.

push(Template[])

Aggiunge 1 o più modelli alla raccolta.

function push(args: Template[])

Parametri

args

Template[]

Elenco di modelli da aggiungere.

toArray()

Ottiene la raccolta di modelli.

function toArray(): Template[]

Restituisce

Template[]

Riferimento all'elenco interno dei modelli di raccolta.

toString()

Restituisce una rappresentazione di stringa di un modelli contenuto.

function toString(): string

Restituisce

string

Rappresentazione di stringa di un Modelli contenuto.

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

Aggiornare un modello e restituire il file LG.

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

Parametri

templateName

string

Nome del modello orignale.

newTemplateName

string

Nuovo nome del modello.

parameters

string[]

Nuovi parametri.

templateBody

string

Nuovo corpo del modello.

Restituisce

Templates

Nuovo file lg.