Moodle APIs 4.3
Moodle 4.3.6 (Build: 20240812)
mod_h5pactivity\external\get_results Class Reference

This is the external method for getting the information needed to present a results report. More...

Inheritance diagram for mod_h5pactivity\external\get_results:

Static Public Member Functions

static execute (int $h5pactivityid, array $attemptids=[])
 Return user attempts results information in a h5p activity.
 
static execute_parameters ()
 Webservice parameters.
 
static execute_returns ()
 Describes the get_h5pactivity_access_information return value.
 

Detailed Description

This is the external method for getting the information needed to present a results report.

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

Member Function Documentation

◆ execute()

static mod_h5pactivity\external\get_results::execute ( int $h5pactivityid,
array $attemptids = [] )
static

Return user attempts results information in a h5p activity.

In case an empty array of attempt ids is passed, the method will load all activity attempts from the current user.

Exceptions
moodle_exceptionif the user cannot see the report
Parameters
int$h5pactivityidThe h5p activity id
int[]$attemptidsThe attempt ids
Return values
stdClassreport data

◆ execute_parameters()

static mod_h5pactivity\external\get_results::execute_parameters ( )
static

Webservice parameters.

Return values
external_function_parameters

◆ execute_returns()

static mod_h5pactivity\external\get_results::execute_returns ( )
static

Describes the get_h5pactivity_access_information return value.

Return values
external_single_structure

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