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

Inheritance diagram for core_xapi\external\delete_state:

Static Public Member Functions
static	execute (string $component, string $activityiri, string $agent, string $stateid, ?string $registration=null)
	Process a state delete request.

static	execute_parameters ()
	Parameters for execute.

static	execute_returns ()
	Return for execute.

Detailed Description

This is the external API for generic xAPI state deletion.

Member Function Documentation

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

static

Process a state delete request.

Parameters

string	$component	The component name in frankenstyle.
string	$activityiri	The activity IRI.
string	$agent	The agent JSON.
string	$stateid	The xAPI state id.
string \| null	$registration	The xAPI registration UUID.

Return values

bool	Whether the state has been removed or not.

static core_xapi\external\delete_state::execute_parameters ( )

static

Parameters for execute.

Return values

external_function_parameters

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