Templates class

參考

套件:: botbuilder-lg

LG 入口，包括 LG 檔案具有的屬性，以及評估函式。

建構函式

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

建立 Templates 類別的新實例。

屬性

allDiagnostics	從目前的 lg 檔案和參考 lg 檔案取得所有診斷。
allTemplates	從目前的 lg 檔案和參考 lg 檔案取得所有範本。
content	LG 內容。
diagnostics	診斷。
enableFromFile	指出 LG 範本中是否允許 fromFile。
expressionParser	表達式剖析器。
id	lg 資源的標識碼。
importResolver	委派，用於解析匯入lg檔案的資源標識碼。
imports	匯入此 LG 檔案直接包含的專案。
inlineTemplateIdPrefix	內嵌內容的暫存範本標識碼。
lgOptions	取得目前 LG 檔案的收回選項。 @returns 值，指出評估LG範本時的選項。
namedReferences	從匯入別名對應至範本。
namespace	取得要註冊目前 LG 檔案的命名空間。 @returns 代表要註冊目前 LG 檔案之命名空間的字串值。
options	LG 檔案選項。
references	此 LG 檔案從 Imports otice 取得的所有參考：參考不包括從 lg 檔案匯入的所有子系，而不只是子系直接屬於這個 lgfile。因此，參考計數可能會 >= 匯入計數。
source	lg 資源的來源。 lg 檔案的完整路徑。

方法

addTemplate(string, string[], string)	新增範本並傳回 LG 檔案。
analyzeTemplate(string, AnalyzerOptions)	分析範本以取得靜態分析器結果，包括變數和範本參考。
deleteTemplate(string)	刪除現有的範本。
evaluate(string, object, EvaluationOptions)	評估具有指定名稱和範圍的範本。
evaluateText(string, object, EvaluationOptions)	使用來評估內嵌範本 str。
expandTemplate(string, object, EvaluationOptions)	展開具有指定名稱和範圍的範本。傳回所有可能的回應，而不是隨機的回應。
parseFile(string, ImportResolverDelegate, ExpressionParser)	剖析檔案並傳回 LG 檔案。
parseResource(LGResource, ImportResolverDelegate, ExpressionParser)	剖析器，將lg內容轉換成範本。
parseText(string, string, ImportResolverDelegate, ExpressionParser)	剖析器，將lg內容轉換成範本。
push(Template[])	將1個以上的範本附加至集合。
toArray()	取得範本的集合。
toString()	傳回範本內容的字串表示。
updateTemplate(string, string, string[], string)	更新範本並傳回 LG 檔案。

建構函式詳細資料

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

建立 Templates 類別的新實例。

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

參數

items: Template[]

自選。範本實例的清單。

imports: TemplateImport[]

自選。 TemplateImport 實例清單。

diagnostics: Diagnostic[]

自選。診斷實例的清單。

references: Templates[]

自選。範本實例的清單。

content: string

自選。目前 Templates 實例的內容。

id: string

自選。目前 Templates 實例的標識碼。

expressionParser: ExpressionParser

自選。 ExpressionParser 來剖析內容中的運算式。

importResolverDelegate: ImportResolverDelegate

自選。解析程式，將 LG 匯入識別子解析為範本文字。

options: string[]

自選。字串清單，表示範本評估期間的選項。

source: string

自選。範本來源。

namedReferences: Record<string, Templates>

自選。使用「as」語法匯入的推斷，例如：匯入為 myAlias。

屬性詳細資料

allDiagnostics

從目前的 lg 檔案和參考 lg 檔案取得所有診斷。

Diagnostic[] allDiagnostics

屬性值

Diagnostic[]

來自目前lg檔案和參考lg檔案的所有診斷。

allTemplates

從目前的 lg 檔案和參考 lg 檔案取得所有範本。

Template[] allTemplates

屬性值

Template[]

來自目前lg檔案和參考lg檔案的所有範本。

content

LG 內容。

content: string

屬性值

string

diagnostics

診斷。

diagnostics: Diagnostic[]

屬性值

Diagnostic[]

enableFromFile

指出 LG 範本中是否允許 fromFile。

static enableFromFile: boolean = false

屬性值

boolean

expressionParser

表達式剖析器。

expressionParser: ExpressionParser

屬性值

ExpressionParser

id

lg 資源的標識碼。

id: string

屬性值

string

importResolver

委派，用於解析匯入lg檔案的資源標識碼。

importResolver: ImportResolverDelegate

屬性值

ImportResolverDelegate

imports

匯入此 LG 檔案直接包含的專案。

imports: TemplateImport[]

屬性值

TemplateImport[]

inlineTemplateIdPrefix

內嵌內容的暫存範本標識碼。

static inlineTemplateIdPrefix: string = "__temp__"

屬性值

string

lgOptions

取得目前 LG 檔案的收回選項。 @returns 值，指出評估LG範本時的選項。

EvaluationOptions lgOptions

屬性值

EvaluationOptions

namedReferences

從匯入別名對應至範本。

namedReferences: Record<string, Templates>

屬性值

Record<string, Templates>

namespace

取得要註冊目前 LG 檔案的命名空間。 @returns 代表要註冊目前 LG 檔案之命名空間的字串值。

string namespace

屬性值

string

options

LG 檔案選項。

options: string[]

屬性值

string[]

references

此 LG 檔案從 Imports otice 取得的所有參考：參考不包括從 lg 檔案匯入的所有子系，而不只是子系直接屬於這個 lgfile。因此，參考計數可能會 >= 匯入計數。

references: Templates[]

屬性值

Templates[]

source

lg 資源的來源。 lg 檔案的完整路徑。

source: string

屬性值

string

方法詳細資料

addTemplate(string, string[], string)

新增範本並傳回 LG 檔案。

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

參數

templateName: string

新的範本名稱。

parameters: string[]

新的參數。

templateBody: string

新的範本主體。

傳回

Templates

新增 lg 檔案。

analyzeTemplate(string, AnalyzerOptions)

分析範本以取得靜態分析器結果，包括變數和範本參考。

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

參數

templateName: string

要評估的範本名稱。

analyzerOptions: AnalyzerOptions

分析範本的選項。

傳回

AnalyzerResult

分析器結果。

deleteTemplate(string)

刪除現有的範本。

function deleteTemplate(templateName: string): Templates

參數

templateName: string

應該刪除哪一個範本。

傳回

Templates

傳回新的 lg 檔案。

evaluate(string, object, EvaluationOptions)

評估具有指定名稱和範圍的範本。

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

參數

templateName: string

要評估的範本名稱。

scope: object

評估中可見的狀態。

opt: EvaluationOptions

評估範本中的 EvaluationOptions。

傳回

any

評估結果。

evaluateText(string, object, EvaluationOptions)

使用來評估內嵌範本 str。

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

參數

inlineStr: string

將評估的內嵌字串。

scope: object

Scope 物件或 JToken。

opt: EvaluationOptions

評估範本中的 EvaluationOptions。

傳回

any

評估的結果物件。

expandTemplate(string, object, EvaluationOptions)

展開具有指定名稱和範圍的範本。傳回所有可能的回應，而不是隨機的回應。

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

參數

templateName: string

要評估的範本名稱。

scope: object

評估中可見的狀態。

opt: EvaluationOptions

展開範本中的 EvaluationOptions。

傳回

any[]

展開結果。

parseFile(string, ImportResolverDelegate, ExpressionParser)

剖析檔案並傳回 LG 檔案。

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

參數

filePath: string

LG 絕對檔案路徑。。

importResolver: ImportResolverDelegate

解析程式，將 LG 匯入識別子解析為範本文字。

expressionParser: ExpressionParser

用於評估表達式的表達式剖析器。

傳回

Templates

新增 lg 檔案。

parseResource(LGResource, ImportResolverDelegate, ExpressionParser)

剖析器，將lg內容轉換成範本。

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

參數

resource: LGResource

LG 資源。

importResolver: ImportResolverDelegate

解析程式，將 LG 匯入識別子解析為範本文字。

expressionParser: ExpressionParser

用於評估表達式的表達式剖析器。

傳回

Templates

實體。

parseText(string, string, ImportResolverDelegate, ExpressionParser)

警告

此 API 現已淘汰。

This method will soon be deprecated. Use ParseResource instead.

剖析器，將lg內容轉換成範本。

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

參數

content: string

文字內容包含 lg 範本。

id: string

標識碼是內容的標識碼。如果 importResolver 未定義，id 必須是完整路徑字串。

importResolver: ImportResolverDelegate

解析程式，將 LG 匯入識別子解析為範本文字。

expressionParser: ExpressionParser

用於評估表達式的表達式剖析器。

傳回

Templates

實體。

push(Template[])

將1個以上的範本附加至集合。

function push(args: Template[])

參數

args: Template[]

要新增的範本清單。

toArray()

取得範本的集合。

function toArray(): Template[]

傳回

Template[]

集合範本內部清單的參考。

toString()

傳回範本內容的字串表示。

function toString(): string

傳回

string

範本內容的字串表示。

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

更新範本並傳回 LG 檔案。

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

參數

templateName: string

Orignial 範本名稱。

newTemplateName: string

新的範本名稱。

parameters: string[]

新的參數。

templateBody: string

新的範本主體。

傳回

Templates

新增 lg 檔案。

共用方式為

Templates class

建構函式

屬性

方法

建構函式詳細資料

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

參數

屬性詳細資料

allDiagnostics

屬性值

allTemplates

屬性值

content

屬性值

diagnostics

屬性值

enableFromFile

屬性值

expressionParser

屬性值

id

屬性值

importResolver

屬性值

imports

屬性值

inlineTemplateIdPrefix

屬性值

lgOptions

屬性值

namedReferences

屬性值

namespace

屬性值

options

屬性值

references

屬性值

source

屬性值

方法詳細資料

addTemplate(string, string[], string)

參數

傳回

analyzeTemplate(string, AnalyzerOptions)

參數

傳回

deleteTemplate(string)

參數

傳回

evaluate(string, object, EvaluationOptions)

參數

傳回

evaluateText(string, object, EvaluationOptions)

參數

傳回

expandTemplate(string, object, EvaluationOptions)

參數

傳回

parseFile(string, ImportResolverDelegate, ExpressionParser)

參數

傳回

parseResource(LGResource, ImportResolverDelegate, ExpressionParser)

參數

傳回

parseText(string, string, ImportResolverDelegate, ExpressionParser)

參數

傳回

push(Template[])

參數

toArray()

傳回

toString()

傳回

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

參數

傳回

其他資源