Skip to main content

Version: v2.1.0

BaseResponse

Defined in: parser/types.ts:159

The BaseResponse interface is used to define the required fields for all responses. Other Response interfaces inherit properties from the BaseResponse interface. Therefore, all responses must include these properties.

Extended by

Properties

Property	Type	Description	Defined in
`hidden?`	`boolean`	Controls whether the response is hidden.	parser/types.ts:177
`id`	`string`	The id of the response. This is used to identify the response in the data file.	parser/types.ts:161
`location?`	`ConfigResponseBlockLocation`	Controls the response location. These might be the same for all responses, or differ across responses. Defaults to `belowStimulus`	parser/types.ts:169
`paramCapture?`	`string`	Use to capture querystring parameters in answers such as participant_name. See the examples for how this is used, but prefer uiConfig.urlParticipantIdParam if you are capturing a participant ID.	parser/types.ts:175
`prompt`	`string`	The prompt that is displayed to the participant. You can use markdown here to render images, links, etc.	parser/types.ts:163
`required?`	`boolean`	Controls whether the response is required to be answered. Defaults to true.	parser/types.ts:167
`requiredLabel?`	`string`	You can provide a required label, which makes it so a participant has to answer with a response that matches label.	parser/types.ts:173
`requiredValue?`	`unknown`	You can provide a required value, which makes it so a participant has to answer with that value.	parser/types.ts:171
`secondaryText?`	`string`	The secondary text that is displayed to the participant under the prompt. This does not accept markdown.	parser/types.ts:165
`withDivider?`	`boolean`	Renders the response with a trailing divider.	parser/types.ts:179
`withDontKnow?`	`boolean`	Renders the response with an option for "I don't know". This counts as a completed answer for the validation.	parser/types.ts:181

Extended by
Properties