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

The external API to send activity to MoodleNet. More...

Inheritance diagram for core\external\moodlenet_send_activity:

Static Public Member Functions

static execute (int $issuerid, int $cmid, int $shareformat)
 External function to send the activity to MoodleNet.
 
static execute_parameters ()
 Describes the parameters for sending the activity.
 
static execute_returns ()
 Describes the data returned from the external function.
 

Static Protected Member Functions

static return_errors (int $itemid, string $warningcode, string $message)
 Handle return error.
 

Detailed Description

The external API to send activity to MoodleNet.

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

Member Function Documentation

◆ execute()

static core\external\moodlenet_send_activity::execute ( int $issuerid,
int $cmid,
int $shareformat )
static

External function to send the activity to MoodleNet.

Parameters
int$issueridThe MoodleNet OAuth 2 issuer ID
int$cmidThe course module ID of the activity that being shared
int$shareformatThe share format being used, as defined by core\moodlenet\activity_sender
Return values
array
Since
Moodle 4.2

◆ execute_parameters()

static core\external\moodlenet_send_activity::execute_parameters ( )
static

Describes the parameters for sending the activity.

Return values
external_function_parameters
Since
Moodle 4.2

◆ execute_returns()

static core\external\moodlenet_send_activity::execute_returns ( )
static

Describes the data returned from the external function.

Return values
external_single_structure
Since
Moodle 4.2

◆ return_errors()

static core\external\moodlenet_send_activity::return_errors ( int $itemid,
string $warningcode,
string $message )
staticprotected

Handle return error.

Parameters
int$itemidItem id
string$warningcodeWarning code
string$messageMessage
Return values
array

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