Edit

Share via

TemplateErrors class

  • Reference
Package:
botbuilder-lg

Centralized LG errors.

Properties

emptyStrucContent
extraExpressionInCondition
extraExpressionInSwitchCase
importFormatError
invalidExpressionInCondition
invalidExpressionInSwiathCase
invalidMemory
invalidMiddleInCondition
invalidStatementInMiddlerOfSwitchCase
invalidTemplateBody
invalidTemplateNameType
invalidWhitespaceInCondition
invalidWhitespaceInSwitchCase
loopDetected
missingCaseInSwitchCase
missingStrucEnd
missingTemplateBodyInCondition
missingTemplateBodyInSwitchCase
multipleIfInCondition
multipleSwithStatementInSwitchCase
noCloseBracket
noEndingInMultiline
noTemplate
notEndWithDefaultInSwitchCase
notEndWithElseInCondition
notStartWithIfInCondition
notStartWithSwitchInSwitchCase
staticFailure

Methods

argumentMismatch(string, number, number)
duplicatedTemplateInDiffTemplate(string, string)
duplicatedTemplateInSameTemplate(string)
errorExpression(string, string, string)
expressionParseError(string)
invalidParameter(string)
invalidStrucBody(string)
invalidStrucName(string)
invalidTemplateName(string)
noTemplateBody(string)
nullExpression(string)
syntaxError(string)
templateExist(string)
templateNotExist(string)

Property Details

emptyStrucContent 

static emptyStrucContent: string = "Invalid structure body. Body cannot be empty."

Property Value

string

extraExpressionInCondition 

static extraExpressionInCondition: string = "Invalid condition. 'ELSE' definition cannot include an expression."

Property Value

string

extraExpressionInSwitchCase 

static extraExpressionInSwitchCase: string = "Invalid condition. 'DEFAULT' statement cannot include an expression."

Property Value

string

importFormatError 

static importFormatError: string = "Import format should follow '[x](y)' or '[x](y) as z'."

Property Value

string

invalidExpressionInCondition 

static invalidExpressionInCondition: string = "Invalid condition. 'IF', 'ELSEIF' definitions must include a valid expression."

Property Value

string

invalidExpressionInSwiathCase 

static invalidExpressionInSwiathCase: string = "Invalid condition. 'SWITCH' and 'CASE' statements must include a valid expression."

Property Value

string

invalidMemory 

static invalidMemory: string = "Scope is not a LG customized memory."

Property Value

string

invalidMiddleInCondition 

static invalidMiddleInCondition: string = "Invalid template body. Expecting 'ELSEIF'."

Property Value

string

invalidStatementInMiddlerOfSwitchCase 

static invalidStatementInMiddlerOfSwitchCase: string = "Invalid template body. Expecting a 'CASE' statement."

Property Value

string

invalidTemplateBody 

static invalidTemplateBody: string = "Invalid template body. Expecting '-' prefix."

Property Value

string

invalidTemplateNameType 

static invalidTemplateNameType: string = "Expected string type for the parameter of template function."

Property Value

string

invalidWhitespaceInCondition 

static invalidWhitespaceInCondition: string = "Invalid condition: At most 1 whitespace allowed between 'IF/ELSEIF/ELSE' and ':'."

Property Value

string

invalidWhitespaceInSwitchCase 

static invalidWhitespaceInSwitchCase: string = "Invalid condition: At most 1 whitespace allowed between 'SWITCH/CASE/DEFAULT' and ':'."

Property Value

string

loopDetected 

static loopDetected: string = "Loop detected:"

Property Value

string

missingCaseInSwitchCase 

static missingCaseInSwitchCase: string = "Invalid template body. Expecting at least one 'CASE' statement."

Property Value

string

missingStrucEnd 

static missingStrucEnd: string = "Invalid structure body. Expecting ']' at the end of the body."

Property Value

string

missingTemplateBodyInCondition 

static missingTemplateBodyInCondition: string = "Invalid condition body. Conditions must include a valid body."

Property Value

string

missingTemplateBodyInSwitchCase 

static missingTemplateBodyInSwitchCase: string = "Invalid condition body. Expecing valid body inside a 'CASE' or 'DEFAULT' block."

Property Value

string

multipleIfInCondition 

static multipleIfInCondition: string = "Invalid template body. There cannot be more than one 'IF' condition. Expecting 'IFELSE' or 'ELSE' statement."

Property Value

string

multipleSwithStatementInSwitchCase 

static multipleSwithStatementInSwitchCase: string = "Invalid template body. There cannot be more than one 'SWITCH' statement. Expecting 'CASE' or 'DEFAULT' statement."

Property Value

string

noCloseBracket 

static noCloseBracket: string = "Close } is missing in Expression."

Property Value

string

noEndingInMultiline 

static noEndingInMultiline: string = "Expecting "```" to close the multi-line block."

Property Value

string

noTemplate 

static noTemplate: string = "LG file must have at least one template definition."

Property Value

string

notEndWithDefaultInSwitchCase 

static notEndWithDefaultInSwitchCase: string = "Conditional response template does not end with 'DEFAULT' condition."

Property Value

string

notEndWithElseInCondition 

static notEndWithElseInCondition: string = "Conditional response template does not end with 'ELSE' condition."

Property Value

string

notStartWithIfInCondition 

static notStartWithIfInCondition: string = "Invalid condition: Conditions must start with 'IF/ELSEIF/ELSE' prefix."

Property Value

string

notStartWithSwitchInSwitchCase 

static notStartWithSwitchInSwitchCase: string = "Invalid conditional response template. Expecting a 'SWITCH' statement?"

Property Value

string

staticFailure 

static staticFailure: string = "Static failure with the following error."

Property Value

string

Method Details

argumentMismatch(string, number, number) 

static function argumentMismatch(templateName: string, expectedCount: number, actualCount: number): string

Parameters

templateName

string

expectedCount

number

actualCount

number

Returns

string

duplicatedTemplateInDiffTemplate(string, string) 

static function duplicatedTemplateInDiffTemplate(templateName: string, source: string): string

Parameters

templateName

string

source

string

Returns

string

duplicatedTemplateInSameTemplate(string) 

static function duplicatedTemplateInSameTemplate(templateName: string): string

Parameters

templateName

string

Returns

string

errorExpression(string, string, string) 

static function errorExpression(refFullText: string, templateName: string, prefixText: string): string

Parameters

refFullText

string

templateName

string

prefixText

string

Returns

string

expressionParseError(string) 

static function expressionParseError(exp: string): string

Parameters

exp

string

Returns

string

invalidParameter(string) 

static function invalidParameter(invalidParameter: string): string

Parameters

invalidParameter

string

Returns

string

invalidStrucBody(string) 

static function invalidStrucBody(invalidBody: string): string

Parameters

invalidBody

string

Returns

string

invalidStrucName(string) 

static function invalidStrucName(invalidName: string): string

Parameters

invalidName

string

Returns

string

invalidTemplateName(string) 

static function invalidTemplateName(invalidTemplateName: string): string

Parameters

invalidTemplateName

string

Returns

string

noTemplateBody(string) 

static function noTemplateBody(templateName: string): string

Parameters

templateName

string

Returns

string

nullExpression(string) 

static function nullExpression(expression: string): string

Parameters

expression

string

Returns

string

syntaxError(string) 

static function syntaxError(unexpectedContent: string): string

Parameters

unexpectedContent

string

Returns

string

templateExist(string) 

static function templateExist(templateName: string): string

Parameters

templateName

string

Returns

string

templateNotExist(string) 

static function templateNotExist(templateName: string): string

Parameters

templateName

string

Returns

string