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

This is the external API for generic xAPI state post. More...

Inheritance diagram for core_xapi\external\post_state:

Static Public Member Functions

static execute (string $component, string $activityiri, string $agent, string $stateid, string $statedata, ?string $registration=null)
 Process a state post request.
 
static execute_parameters ()
 Parameters for execute.
 
static execute_returns ()
 Return for execute.
 

Detailed Description

This is the external API for generic xAPI state post.

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

Member Function Documentation

◆ execute()

static core_xapi\external\post_state::execute ( string $component,
string $activityiri,
string $agent,
string $stateid,
string $statedata,
?string $registration = null )
static

Process a state post request.

Parameters
string$componentThe component name in frankenstyle.
string$activityiriThe activity IRI.
string$agentThe agent JSON.
string$stateidThe xAPI state id.
string$statedataJSON object with the state data
string | null$registrationThe xAPI registration UUID.
Return values
bool

◆ execute_parameters()

static core_xapi\external\post_state::execute_parameters ( )
static

Parameters for execute.

Return values
external_function_parameters

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