OnSurveyDenied: Difference between revisions
From LimeSurvey Manual
No edit summary |
No edit summary |
||
| (5 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
{{FeatureStarting| | {{FeatureStarting|3.0.0}} | ||
'''When''' | '''When''' | ||
This event is fired when a survey taker is blocked from taking the survey. Several reasons can trigger this event, see below. | This event is fired when a survey taker is blocked from taking the survey. Several reasons can trigger this event, see below. | ||
'''Input''' | |||
The event receives the following information: | |||
{| class="wikitable" | |||
! Name !! Type !! Description | |||
|- | |||
| surveyId || integer || The id of the current survey | |||
|- | |||
| reason || string || One of the following: | |||
* noPreviewPermission | |||
* surveyNoLongerAvailable | |||
* surveyNotYetStarted | |||
* alreadyCompleted | |||
* sessionExpired | |||
* invalidToken | |||
* surveyDoesNotExist | |||
|} | |||
'''Possible output''' | |||
None. | |||
'''Example''' | |||
<syntaxhighlight lang="php"> | |||
// todo | |||
</syntaxhighlight> | |||
[[Category:Plugins events]] | |||
Latest revision as of 14:26, 10 October 2018
Hint: This features is available starting in version 3.0.0
When
This event is fired when a survey taker is blocked from taking the survey. Several reasons can trigger this event, see below.
Input
The event receives the following information:
| Name | Type | Description |
|---|---|---|
| surveyId | integer | The id of the current survey |
| reason | string | One of the following:
|
Possible output
None.
Example
// todo