Compartir a través de

Templates class

  • Referencia
Paquete:
botbuilder-lg

Entrada lg, incluidas las propiedades que tiene el archivo LG y evaluar funciones.

Constructores

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

Crea una nueva instancia de la clase Plantillas de .

Propiedades

allDiagnostics

Obtiene todos los diagnósticos del archivo lg actual y los archivos lg de referencia.
allTemplates

Obtiene todas las plantillas del archivo lg actual y de los archivos lg de referencia.
content

Contenido LG.
diagnostics

diagnósticos.
enableFromFile

Indica si fromFile está permitido en plantillas LG.
expressionParser

analizador de expresiones.
id

Identificador del recurso lg.
importResolver

Delegado para resolver el identificador de recurso del archivo LG importado.
imports

importar elementos que este archivo LG contiene directamente.
inlineTemplateIdPrefix

Identificador de plantilla temporal para contenido insertado.
lgOptions

Obtiene las opciones de evluation para el archivo LG actual. @returns valor que indica si las opciones al evaluar plantillas LG.
namedReferences

Asignación de alias de importación a plantillas.
namespace

Obtiene el espacio de nombres que se va a registrar para el archivo LG actual. @returns valor de cadena que representa el espacio de nombres que se va a registrar para el archivo LG actual.
options

Opciones de archivo LG.
references

todas las referencias que tiene este archivo LG de Imports otice: hace referencia a todas las importaciones secundarias del archivo lg, no solo los elementos secundarios pertenecen directamente a este lgfile. por lo tanto, el recuento de referencias puede >= recuento de importaciones.
source

Origen del recurso lg. Ruta de acceso completa para el archivo lg.

Métodos

addTemplate(string, string[], string)

Agregue una nueva plantilla y devuelva el archivo LG.
analyzeTemplate(string, AnalyzerOptions)

Analice una plantilla para obtener los resultados del analizador estático, incluidas las variables y las referencias de plantilla.
deleteTemplate(string)

Elimine una plantilla existente.
evaluate(string, object, EvaluationOptions)

Evalúe una plantilla con el nombre y el ámbito especificados.
evaluateText(string, object, EvaluationOptions)

Use para evaluar una plantilla insertada str.
expandTemplate(string, object, EvaluationOptions)

Expanda una plantilla con el nombre y el ámbito especificados. Devuelve todas las respuestas posibles en lugar de una aleatoria.
parseFile(string, ImportResolverDelegate, ExpressionParser)

Analice un archivo y devuelva el archivo LG.
parseResource(LGResource, ImportResolverDelegate, ExpressionParser)

Analizador para convertir el contenido lg en plantillas.
parseText(string, string, ImportResolverDelegate, ExpressionParser)

Analizador para convertir el contenido lg en plantillas.
push(Template[])

Anexa 1 o más plantillas a la colección.
toArray()

Obtiene la colección de plantillas.
toString()

Devuelve una representación de cadena de un Plantillas contenido.
updateTemplate(string, string, string[], string)

Actualice una plantilla y devuelva el archivo LG.

Detalles del constructor

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

Crea una nueva instancia de la clase Plantillas de .

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

Parámetros

items

Template[]

Opcional. Lista de instancias de plantilla de .

imports

TemplateImport[]

Opcional. Lista de instancias de TemplateImport.

diagnostics

Diagnostic[]

Opcional. Lista de instancias de diagnóstico de .

references

Templates[]

Opcional. Lista de plantillas de instancias.

content

string

Opcional. Contenido de la instancia de plantillas actual.

id

string

Opcional. Identificador de la instancia de Plantillas actual.

expressionParser

ExpressionParser

Opcional. expressionParser para analizar las expresiones del contenido.

importResolverDelegate
ImportResolverDelegate

Opcional. Resolución para resolver el identificador de importación de LG al texto de la plantilla.

options

string[]

Opcional. Lista de cadenas que representan las opciones durante la evaluación de las plantillas.

source

string

Opcional. Origen de plantillas.

namedReferences

Record<string, Templates>

Opcional. eferences que se importaron con la sintaxis "as", por ejemplo: importar como myAlias.

Detalles de las propiedades

allDiagnostics

Obtiene todos los diagnósticos del archivo lg actual y los archivos lg de referencia.

Diagnostic[] allDiagnostics

Valor de propiedad

Diagnostic[]

Todos los diagnósticos del archivo lg actual y los archivos lg de referencia.

allTemplates

Obtiene todas las plantillas del archivo lg actual y de los archivos lg de referencia.

Template[] allTemplates

Valor de propiedad

Template[]

Todas las plantillas del archivo lg actual y los archivos lg de referencia.

content

Contenido LG.

content: string

Valor de propiedad

string

diagnostics

diagnósticos.

diagnostics: Diagnostic[]

Valor de propiedad

Diagnostic[]

enableFromFile

Indica si fromFile está permitido en plantillas LG.

static enableFromFile: boolean = false

Valor de propiedad

boolean

expressionParser

analizador de expresiones.

expressionParser: ExpressionParser

Valor de propiedad

ExpressionParser

id

Identificador del recurso lg.

id: string

Valor de propiedad

string

importResolver

Delegado para resolver el identificador de recurso del archivo LG importado.

importResolver: ImportResolverDelegate

Valor de propiedad

ImportResolverDelegate

imports

importar elementos que este archivo LG contiene directamente.

imports: TemplateImport[]

Valor de propiedad

TemplateImport[]

inlineTemplateIdPrefix

Identificador de plantilla temporal para contenido insertado.

static inlineTemplateIdPrefix: string = "__temp__"

Valor de propiedad

string

lgOptions

Obtiene las opciones de evluation para el archivo LG actual. @returns valor que indica si las opciones al evaluar plantillas LG.

EvaluationOptions lgOptions

Valor de propiedad

EvaluationOptions

namedReferences

Asignación de alias de importación a plantillas.

namedReferences: Record<string, Templates>

Valor de propiedad

Record<string, Templates>

namespace

Obtiene el espacio de nombres que se va a registrar para el archivo LG actual. @returns valor de cadena que representa el espacio de nombres que se va a registrar para el archivo LG actual.

string namespace

Valor de propiedad

string

options

Opciones de archivo LG.

options: string[]

Valor de propiedad

string[]

references

todas las referencias que tiene este archivo LG de Imports otice: hace referencia a todas las importaciones secundarias del archivo lg, no solo los elementos secundarios pertenecen directamente a este lgfile. por lo tanto, el recuento de referencias puede >= recuento de importaciones.

references: Templates[]

Valor de propiedad

Templates[]

source

Origen del recurso lg. Ruta de acceso completa para el archivo lg.

source: string

Valor de propiedad

string

Detalles del método

addTemplate(string, string[], string)

Agregue una nueva plantilla y devuelva el archivo LG.

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

Parámetros

templateName

string

Nuevo nombre de plantilla.

parameters

string[]

Nuevos parámetros.

templateBody

string

Nuevo cuerpo de plantilla.

Devoluciones

Templates

Nuevo archivo lg.

analyzeTemplate(string, AnalyzerOptions)

Analice una plantilla para obtener los resultados del analizador estático, incluidas las variables y las referencias de plantilla.

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

Parámetros

templateName

string

Nombre de plantilla que se va a evaluar.

analyzerOptions
AnalyzerOptions

Opciones para analizar la plantilla.

Devoluciones

AnalyzerResult

Resultado del analizador.

deleteTemplate(string)

Elimine una plantilla existente.

function deleteTemplate(templateName: string): Templates

Parámetros

templateName

string

Qué plantilla debe eliminar.

Devoluciones

Templates

Devuelve el nuevo archivo LG.

evaluate(string, object, EvaluationOptions)

Evalúe una plantilla con el nombre y el ámbito especificados.

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

Parámetros

templateName

string

Nombre de plantilla que se va a evaluar.

scope

object

Estado visible en la evaluación.

opt
EvaluationOptions

EvaluationOptions para evaluar una plantilla.

Devoluciones

any

Evaluar el resultado.

evaluateText(string, object, EvaluationOptions)

Use para evaluar una plantilla insertada str.

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

Parámetros

inlineStr

string

Cadena insertada que se evaluará.

scope

object

Objeto scope o JToken.

opt
EvaluationOptions

EvaluationOptions para evaluar una plantilla.

Devoluciones

any

Objeto de resultado evaluado.

expandTemplate(string, object, EvaluationOptions)

Expanda una plantilla con el nombre y el ámbito especificados. Devuelve todas las respuestas posibles en lugar de una aleatoria.

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

Parámetros

templateName

string

Nombre de plantilla que se va a evaluar.

scope

object

Estado visible en la evaluación.

opt
EvaluationOptions

EvaluationOptions en la expansión de una plantilla.

Devoluciones

any[]

Expanda el resultado.

parseFile(string, ImportResolverDelegate, ExpressionParser)

Analice un archivo y devuelva el archivo LG.

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

Parámetros

filePath

string

Ruta de acceso absoluta del archivo LG..

importResolver
ImportResolverDelegate

Resolución para resolver el identificador de importación de LG al texto de la plantilla.

expressionParser

ExpressionParser

Analizador de expresiones para evaluar expresiones.

Devoluciones

Templates

Nuevo archivo lg.

parseResource(LGResource, ImportResolverDelegate, ExpressionParser)

Analizador para convertir el contenido lg en plantillas.

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

Parámetros

resource
LGResource

Recurso LG.

importResolver
ImportResolverDelegate

Resolución para resolver el identificador de importación de LG al texto de la plantilla.

expressionParser

ExpressionParser

Analizador de expresiones para evaluar expresiones.

Devoluciones

Templates

Entidad.

parseText(string, string, ImportResolverDelegate, ExpressionParser)

Advertencia

Esta API ya está en desuso.

This method will soon be deprecated. Use ParseResource instead.

Analizador para convertir el contenido lg en plantillas.

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

Parámetros

content

string

El contenido de texto contiene plantillas lg.

id

string

Id es el identificador del contenido. Si importResolver no está definido, id debe ser una cadena de ruta de acceso completa.

importResolver
ImportResolverDelegate

Resolución para resolver el identificador de importación de LG al texto de la plantilla.

expressionParser

ExpressionParser

Analizador de expresiones para evaluar expresiones.

Devoluciones

Templates

Entidad.

push(Template[])

Anexa 1 o más plantillas a la colección.

function push(args: Template[])

Parámetros

args

Template[]

Lista de plantillas que se van a agregar.

toArray()

Obtiene la colección de plantillas.

function toArray(): Template[]

Devoluciones

Template[]

Referencia a la lista interna de plantillas de colección.

toString()

Devuelve una representación de cadena de un Plantillas contenido.

function toString(): string

Devoluciones

string

Representación de cadena de un Plantillas contenido.

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

Actualice una plantilla y devuelva el archivo LG.

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

Parámetros

templateName

string

Nombre de plantilla orignial.

newTemplateName

string

Nuevo nombre de plantilla.

parameters

string[]

Nuevos parámetros.

templateBody

string

Nuevo cuerpo de plantilla.

Devoluciones

Templates

Nuevo archivo lg.