Moodle PHP Documentation 4.2
Moodle 4.2.8 (Build: 20240610) (2d41ac46f45)
mod_bigbluebuttonbn\external\get_recordings Class Reference
Inheritance diagram for mod_bigbluebuttonbn\external\get_recordings:

Static Public Member Functions

static execute (int $bigbluebuttonbnid=0, ?string $tools='protect, unprotect, publish, unpublish, delete', ?int $groupid=null)
 Get a list of recordings.
 
static execute_parameters ()
 Returns description of method parameters.
 
static execute_returns ()
 Describe the return structure of the external service.
 

Detailed Description

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

Member Function Documentation

◆ execute()

static mod_bigbluebuttonbn\external\get_recordings::execute ( int $bigbluebuttonbnid = 0,
?string $tools = 'protect,
unprotect ,
publish ,
unpublish ,
delete' ,
?int $groupid = null )
static

Get a list of recordings.

Parameters
int$bigbluebuttonbnidthe bigbluebuttonbn instance id to which the recordings are referred.
string | null$tools
int | null$groupid
Return values
arrayof warnings and status result
Exceptions
invalid_parameter_exception
restricted_context_exception

◆ execute_parameters()

static mod_bigbluebuttonbn\external\get_recordings::execute_parameters ( )
static

Returns description of method parameters.

Return values
external_function_parameters

◆ execute_returns()

static mod_bigbluebuttonbn\external\get_recordings::execute_returns ( )
static

Describe the return structure of the external service.

Return values
external_single_structure
Since
Moodle 3.0

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