Display a pop-up survey to one or more user sessions.
The pop-up includes questions text followed by a set of selectable choices, and an optional free text box.
If set to true and free text is supplied in the user response, then it is returned in the
In synchronous mode the method will only return once all user sessions have responded or have timed out.
The table consists of rows of Text strings, and optionally a Color value may be associated with each entry.
Default value; "Anything more you'd like to tell us?"
This is used to uniquely identify the survey, and prevent repeat showing of the same survey.
The maximum value allowed is 129600 minutes (90 days). Default is 0 which means survey maximum validity period of 90 days will apply.
Response Validity is a way to avoid repeatedly presenting a user with the same survey. When a user provides an answer to a survey, the response they give is deemed to be "valid" for the duration specified here. You may then use the Interaction.GetActiveResponses method to test whether there is already a valid answer for a particular user/survey; if there is, you may wish to avoid calling Interaction.ShowSurvey and instead use their existing answer.
Once the response validity period has elapsed, the response is no longer marked as valid, and will not appear in the table returned by Interaction.GetActiveResponses.
You can force the one or more responses to be invalidated for a user/survey immediately by using the Interaction.InvalidateResponse method.
Minimum value is 30 seconds, maximum value is 900 seconds and default value is 60 seconds.
In synchronous mode this is not relevant and should not be supplied.
Values are: "dismissed", "responded", "snoozed", "timed out", "invalid".
The highest ordered choice (first in the table of choices) will have a response value of 1.
Available from v5.1.