Extends

• ArchBaseActionAsk

Members

static, readonly answer :ArchValueCommunication

A communication value explaining the answer options to the caller.

static, readonly displayTypeName :string

Returns the display type name string 'ArchActionAskSurveyQuestion'.

readonly followUpQuestion :ArchValueCommunication

The question to ask after the original question has been answered.

readonly isArchActionAskSurveyQuestion :boolean

Returns true indicating that this is an ArchActionAskSurveyQuestion instance.

readonly notApplicable :ArchValueString

The DTMF character to configure for Not Applicable. This may not be the same as the flow setting for the DTMF terminating character or any of the answer options associated with this survey question.

question :ArchValueString

The question text for the action.

Inherited From:

• ArchBaseActionAsk#question

readonly questionCondition :ArchValueBoolean

These are the conditions under which the question is available as configured by the survey form. This is not something that can be changed and is intended for informational purposes. If this value is NOT_SET, the question will always be presented to the caller.

readonly surveyQuestion :ArchValueSurveyQuestion

The survey question you would like to ask. See ArchActionAskSurveyQuestion#configureFromQuestionText or ArchActionAskSurveyQuestion#configureFromQuestionId to configure the question on the ArchActionAskSurveyQuestion

readonly surveyQuestionResult :ArchValueSurveyQuestion

The variable associated with the question.

Methods

configureFromQuestionId(questionId) → {void}

Configures the ask survey question action with the specified survey form question identifier. The question ID must be valid for the survey form associated with the flow or this method will throw.

Parameters:

Name	Type	Description
questionId	string	the survey form question identifier to set on this value.

Throws:

the survey question identifier provided is not valid for this voice survey flow. Make sure that it is valid for the survey form associated with this flow.

Returns:

void

configureFromQuestionText(questionText) → {void}

Configures the ask survey question action with the specified survey form question text. The question text must be valid for the survey form associated with the flow or this method will throw.

Parameters:

Name	Type	Description
questionText	string	the survey form question identifier to set on this value.

Throws:

the survey question with the provided question text could not be found on the survey form associated with this flow.

Returns:

void