Class

SurveyQuestion

SurveyQuestion

Encapsulates the definition of a SurveyQuestion.

Classes

SurveyQuestion

Members

string

# id

Question's ID.

string

# name

Question’s friendly name. This name is internal and helps to keep track if the question text needs to be changed.

Array.<SurveyChoice>

# nullable options

Single choice values for a case when question has a type SINGLE_CHOICE. See SurveyChoice for more info.

Example

Choices format

[
  {id: "uuid", label: "Choice 1", is_default: false, position: 0},
  {id: "uuid", label: "Choice 2", is_default: true, position: 1},
  {id: "uuid", label: "Choice 3", is_default: false, position: 2}
]

 
number

# position

Position of the question among other questions in a survey. Counting starts with 0.

boolean

# required

If true, the question cannot be left without an answer. Default is false.

string

# text

Question's text. Being the actual question that the engagement's participant is asked to answer.

string

# type

Question type. One of Survey#QUESTION_TYPES