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

This is the external API for this component. More...

Inheritance diagram for core_h5p\external:

Static Public Member Functions

static get_trusted_h5p_file (string $url, int $frame, int $export, int $embed, int $copyright)
 Return the H5P file trusted.
 
static get_trusted_h5p_file_parameters ()
 get_trusted_h5p_file parameters.
 
static get_trusted_h5p_file_returns ()
 get_trusted_h5p_file return
 

Detailed Description

This is the external API for this component.

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

Member Function Documentation

◆ get_trusted_h5p_file()

static core_h5p\external::get_trusted_h5p_file ( string $url,
int $frame,
int $export,
int $embed,
int $copyright )
static

Return the H5P file trusted.

The Mobile App needs to work with an H5P package which can trust. And this H5P package is only trusted by the Mobile App once it's been processed by the core checking the right caps, validating the H5P package and doing any clean-up process involved.

Since
Moodle 3.8
Parameters
string$urlH5P file url
int$frameThe frame allow to show the bar options below the content
int$exportThe export allow to download the package
int$embedThe embed allow to copy the code to your site
int$copyrightThe copyright option
Return values
array
Exceptions
moodle_exception

◆ get_trusted_h5p_file_parameters()

static core_h5p\external::get_trusted_h5p_file_parameters ( )
static

get_trusted_h5p_file parameters.

Since
Moodle 3.8
Return values
external_function_parameters

◆ get_trusted_h5p_file_returns()

static core_h5p\external::get_trusted_h5p_file_returns ( )
static

get_trusted_h5p_file return

Since
Moodle 3.8
Return values
core_external\external_description

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