Skip to main content

Screening.Response

Description​

The User.TappedContinue type defines an action that requires a client to The Screening.Response type defines an action that requires a client to set input from an end user against a specific key of a map that will be later be presented back to the Screening service. The map presented to the Screening service is used to determine the next state of the Screening.

This type is most commonly found within the event handler of a control.

Properties​

  • key (string, required) - The key with which some value should be associated.
  • value (boolean|number|string) - Whether or not some value should be associated with the key.

Example​

In this example a client would be expected to set the key meaning_of_life to the provided value in the payload that will later be presented back to the Screening service. For example, if this action was associated with a Button control then when the button is pressed a client would be expected to set meaning_of_life = 42 in the map of end user data it will later return to the Screening service.

{
  "key" : "meaning_of_life",
  "type" : "Screening.Response",
  "value" : 42
}