Templates class

Pacote:

botbuilder-lg

Entrada LG, incluindo as propriedades que o arquivo LG tem e as funções de avaliação.

Construtores

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

Cria uma nova instância da classe modelos de .

Propriedades

allDiagnostics	Obtém todos os diagnósticos do arquivo lg atual e referencia os arquivos lg.
allTemplates	Obtém todos os modelos do arquivo lg atual e referencia os arquivos lg.
content	Conteúdo LG.
diagnostics	Diagnostics.
enableFromFile	Indica se fromFile é permitido em modelos LG.
expressionParser	analisador de expressão.
id	ID do recurso lg.
importResolver	Delegar para resolver a ID de recurso do arquivo lg importado.
imports	importar elementos que esse arquivo LG contém diretamente.
inlineTemplateIdPrefix	ID do modelo temporário para conteúdo embutido.
lgOptions	Obtém as opções de evluation para o arquivo LG atual. @returns Um valor que indica se as opções ao avaliar modelos LG.
namedReferences	Mapeie do alias de importação para modelos.
namespace	Obtém o namespace a ser registrado para o arquivo LG atual. @returns um valor de cadeia de caracteres que representa o namespace a ser registrado para o arquivo LG atual.
options	Opções de arquivo LG.
references	todas as referências que esse arquivo LG tem de Imports otice: a referência inclui todas as importações filho do arquivo lg, não apenas as crianças pertencem diretamente a esse lgfile. portanto, a contagem de referências pode >= contagem de importações.
source	Origem do recurso lg. Caminho completo para o arquivo lg.

Métodos

addTemplate(string, string[], string)	Adicione um novo modelo e retorne o arquivo LG.
analyzeTemplate(string, AnalyzerOptions)	Analise um modelo para obter os resultados do analisador estático, incluindo variáveis e referências de modelo.
deleteTemplate(string)	Exclua um modelo existente.
evaluate(string, object, EvaluationOptions)	Avalie um modelo com determinado nome e escopo.
evaluateText(string, object, EvaluationOptions)	Use para avaliar um str de modelo embutido.
expandTemplate(string, object, EvaluationOptions)	Expanda um modelo com determinado nome e escopo. Retorne todas as respostas possíveis em vez de aleatórias.
parseFile(string, ImportResolverDelegate, ExpressionParser)	Analise um arquivo e retorne o arquivo LG.
parseResource(LGResource, ImportResolverDelegate, ExpressionParser)	Analisador para transformar o conteúdo lg em modelos.
parseText(string, string, ImportResolverDelegate, ExpressionParser)	Analisador para transformar o conteúdo lg em modelos.
push(Template[])	Acrescenta 1 ou mais modelos à coleção.
toArray()	Obtém a coleção de modelos.
toString()	Retorna uma representação de cadeia de caracteres de um Templates conteúdo.
updateTemplate(string, string, string[], string)	Atualize um modelo e retorne o arquivo LG.

Detalhes do construtor

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

Cria uma nova instância da classe modelos 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 instâncias de de modelo de .

imports

TemplateImport[]

Opcional. Lista de instâncias TemplateImport.

diagnostics

Diagnostic[]

Opcional. Lista de instâncias de de Diagnóstico de .

references

Templates[]

Opcional. Lista de modelos de instâncias.

content

string

Opcional. Conteúdo da instância de Modelos atual.

id

string

Opcional. ID da instância atual de Modelos.

expressionParser

ExpressionParser

Opcional. ExpressionParser para analisar as expressões no conteúdo.

importResolverDelegate

ImportResolverDelegate

Opcional. Resolver para resolver a ID de importação da LG para o texto do modelo.

options

string[]

Opcional. Lista de cadeias de caracteres que representam as opções durante a avaliação dos modelos.

source

string

Opcional. Fonte de modelos.

namedReferences

Record<string, Templates>

Opcional. eferências importadas com a sintaxe "as", por exemplo: importar como myAlias.

Detalhes da propriedade

allDiagnostics

Obtém todos os diagnósticos do arquivo lg atual e referencia os arquivos lg.

Diagnostic[] allDiagnostics

Valor da propriedade

Diagnostic[]

Todos os diagnósticos do arquivo lg atual e referenciam arquivos lg.

allTemplates

Obtém todos os modelos do arquivo lg atual e referencia os arquivos lg.

Template[] allTemplates

Valor da propriedade

Template[]

Todos os modelos do arquivo lg atual e referenciam arquivos lg.

content

Conteúdo LG.

content: string

Valor da propriedade

string

diagnostics

Diagnostics.

diagnostics: Diagnostic[]

Valor da propriedade

Diagnostic[]

enableFromFile

Indica se fromFile é permitido em modelos LG.

static enableFromFile: boolean = false

Valor da propriedade

boolean

expressionParser

analisador de expressão.

expressionParser: ExpressionParser

Valor da propriedade

ExpressionParser

id

ID do recurso lg.

id: string

Valor da propriedade

string

importResolver

Delegar para resolver a ID de recurso do arquivo lg importado.

importResolver: ImportResolverDelegate

Valor da propriedade

ImportResolverDelegate

imports

importar elementos que esse arquivo LG contém diretamente.

imports: TemplateImport[]

Valor da propriedade

TemplateImport[]

inlineTemplateIdPrefix

ID do modelo temporário para conteúdo embutido.

static inlineTemplateIdPrefix: string = "__temp__"

Valor da propriedade

string

lgOptions

Obtém as opções de evluation para o arquivo LG atual. @returns Um valor que indica se as opções ao avaliar modelos LG.

EvaluationOptions lgOptions

Valor da propriedade

EvaluationOptions

namedReferences

Mapeie do alias de importação para modelos.

namedReferences: Record<string, Templates>

Valor da propriedade

Record<string, Templates>

namespace

Obtém o namespace a ser registrado para o arquivo LG atual. @returns um valor de cadeia de caracteres que representa o namespace a ser registrado para o arquivo LG atual.

string namespace

Valor da propriedade

string

options

Opções de arquivo LG.

options: string[]

Valor da propriedade

string[]

references

todas as referências que esse arquivo LG tem de Imports otice: a referência inclui todas as importações filho do arquivo lg, não apenas as crianças pertencem diretamente a esse lgfile. portanto, a contagem de referências pode >= contagem de importações.

references: Templates[]

Valor da propriedade

Templates[]

source

Origem do recurso lg. Caminho completo para o arquivo lg.

source: string

Valor da propriedade

string

Detalhes do método

addTemplate(string, string[], string)

Adicione um novo modelo e retorne o arquivo LG.

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

Parâmetros

templateName

string

Novo nome do modelo.

parameters

string[]

Novos parâmetros.

templateBody

string

Novo corpo do modelo.

Retornos

Templates

Novo arquivo lg.

analyzeTemplate(string, AnalyzerOptions)

Analise um modelo para obter os resultados do analisador estático, incluindo variáveis e referências de modelo.

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

Parâmetros

templateName

string

Nome do modelo a ser avaliado.

analyzerOptions

AnalyzerOptions

Opções para analisar o modelo.

Retornos

AnalyzerResult

Resultado do analisador.

deleteTemplate(string)

Exclua um modelo existente.

function deleteTemplate(templateName: string): Templates

Parâmetros

templateName

string

Qual modelo deve ser excluído.

Retornos

Templates

Retorne o novo arquivo lg.

evaluate(string, object, EvaluationOptions)

Avalie um modelo com determinado nome e escopo.

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

Parâmetros

templateName

string

Nome do modelo a ser avaliado.

scope

object

O estado visível na avaliação.

opt

EvaluationOptions

EvaluationOptions na avaliação de um modelo.

Retornos

any

Avaliar o resultado.

evaluateText(string, object, EvaluationOptions)

Use para avaliar um str de modelo embutido.

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

Parâmetros

inlineStr

string

Cadeia de caracteres embutida que será avaliada.

scope

object

Objeto de escopo ou JToken.

opt

EvaluationOptions

EvaluationOptions na avaliação de um modelo.

Retornos

any

Objeto de resultado avaliado.

expandTemplate(string, object, EvaluationOptions)

Expanda um modelo com determinado nome e escopo. Retorne todas as respostas possíveis em vez de aleatórias.

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

Parâmetros

templateName

string

Nome do modelo a ser avaliado.

scope

object

O estado visível na avaliação.

opt

EvaluationOptions

EvaluationOptions na expansão de um modelo.

Retornos

any[]

Expandir o resultado.

parseFile(string, ImportResolverDelegate, ExpressionParser)

Analise um arquivo e retorne o arquivo LG.

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

Parâmetros

filePath

string

Caminho de arquivo absoluto LG..

importResolver

ImportResolverDelegate

Resolver para resolver a ID de importação da LG para o texto do modelo.

expressionParser

ExpressionParser

Analisador de expressão para avaliar expressões.

Retornos

Templates

Novo arquivo lg.

parseResource(LGResource, ImportResolverDelegate, ExpressionParser)

Analisador para transformar o conteúdo lg em modelos.

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

Parâmetros

resource

LGResource

Recurso LG.

importResolver

ImportResolverDelegate

Resolver para resolver a ID de importação da LG para o texto do modelo.

expressionParser

ExpressionParser

Analisador de expressão para avaliar expressões.

Retornos

Templates

Entidade.

parseText(string, string, ImportResolverDelegate, ExpressionParser)

Aviso

Essa API foi preterida.

This method will soon be deprecated. Use ParseResource instead.

Analisador para transformar o conteúdo lg em modelos.

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

Parâmetros

content

string

O conteúdo do texto contém modelos lg.

id

string

A ID é o identificador do conteúdo. Se importResolver for indefinido, a ID deverá ser uma cadeia de caracteres de caminho completo.

importResolver

ImportResolverDelegate

Resolver para resolver a ID de importação da LG para o texto do modelo.

expressionParser

ExpressionParser

Analisador de expressão para avaliar expressões.

Retornos

Templates

Entidade.

push(Template[])

Acrescenta 1 ou mais modelos à coleção.

function push(args: Template[])

Parâmetros

args

Template[]

Lista de modelos a serem adicionados.

toArray()

Obtém a coleção de modelos.

function toArray(): Template[]

Retornos

Template[]

Uma referência à lista interna de modelos de coleção.

toString()

Retorna uma representação de cadeia de caracteres de um Templates conteúdo.

function toString(): string

Retornos

string

Uma representação de cadeia de caracteres de um Templates conteúdo.

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

Atualize um modelo e retorne o arquivo LG.

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

Parâmetros

templateName

string

Nome do modelo orignial.

newTemplateName

string

Novo nome do modelo.

parameters

string[]

Novos parâmetros.

templateBody

string

Novo corpo do modelo.

Retornos

Templates

Novo arquivo lg.