Error type object

In AskiaScript, the error type object provides information about an error that occurred during the interview. This object is accessible via a question's Errors property.

• Properties:
  • Blocking5.5.3.5
  • fromQuestion5.5.3.5
  • Id
  • Key
  • Message

• Methods:
  • ToString()
  • TypeOf()
• Error Keys

Properties

Blocking

Returns a Boolean with true or false is the error message is blocking or not).

Examples

CurrentQuestion.Errors[1].Blocking' => true

CurrentQuestion.Errors[1].Blocking' => false

↑ Top of page ↑

fromQuestion

Returns a Question object of the original question of the error.

Examples

CurrentQuestion.Errors[1].fromQuestion

↑ Top of page ↑

Id

Id of the error message.

Returns a Number.

See also: Table of errors

Examples

CurrentQuestion.Errors[1].Id ' => 2 (expected_0_answer)

CurrentQuestion.Errors[1].Id ' => 26 (expected_0_at_least_1_answer)

↑ Top of page ↑

Key

Key of the error message.

Also see: Table of errors.

Returns a String.

Examples

CurrentQuestion.Errors[1].Key  ' => "expected_0_answer"

CurrentQuestion.Errors[1].Key  ' => "expected_0_at_least_1_answer"

↑ Top of page ↑

Message

Returns the translated and formatted error message (using the current interview language).

Examples

CurrentQuestion.Errors[1].Message' => "A response is expected for question 'q1'"

CurrentQuestion.Errors[1].Message' => "You can only give one response for question 'q2'"

↑ Top of page ↑

Methods

ToString()

Returns a string which represents the error (expressed in JSON format).

Returns a String.

Example

 ' Output in a single line (broken here for the sake of readability)
gender.Errors[1].ToString() 
' => {
"key":"expected_0_answer",
"message":"A response is expected for question 'q1'" 
}

↑ Top of page ↑

TypeOf()

Always returns "error".

Returns a String.

Example

gender.Errors[1].TypeOf() ' => "error"

↑ Top of page ↑

Error Keys

↑ Top of page ↑