Moodle APIs 4.3
Moodle 4.3.6 (Build: 20240812)
mod_quiz\external\get_reopen_attempt_confirmation Class Reference

Web service to check a quiz attempt state, and return a confirmation message if it can be reopened now. More...

Inheritance diagram for mod_quiz\external\get_reopen_attempt_confirmation:

Static Public Member Functions

static execute (int $attemptid)
 Check a quiz attempt state, and return a confirmation message method implementation.
 
static execute_parameters ()
 Declare the method parameters.
 
static execute_returns ()
 Define the webservice response.
 

Detailed Description

Web service to check a quiz attempt state, and return a confirmation message if it can be reopened now.

The use must have the 'mod/quiz:reopenattempts' capability and the attempt must (at least for now) be in the 'Never submitted' state (quiz_attempt\ABANDONED).

License
http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

Member Function Documentation

◆ execute()

static mod_quiz\external\get_reopen_attempt_confirmation::execute ( int $attemptid)
static

Check a quiz attempt state, and return a confirmation message method implementation.

Parameters
int$attemptidthe id of the attempt to reopen.
Return values
stringa suitable confirmation message (HTML), if the attempt is suitable to be reopened.
Exceptions
Exceptionan appropriate exception if the attempt cannot be reopened now.

◆ execute_parameters()

static mod_quiz\external\get_reopen_attempt_confirmation::execute_parameters ( )
static

Declare the method parameters.

Return values
external_function_parameters

◆ execute_returns()

static mod_quiz\external\get_reopen_attempt_confirmation::execute_returns ( )
static

Define the webservice response.

Return values
external_description

The documentation for this class was generated from the following file: