core\external\moodlenet_auth_check Class Reference

The external API to check whether a user has authorized for a given MoodleNet OAuth 2 issuer. More...

Inheritance diagram for core\external\moodlenet_auth_check:

Static Public Member Functions
static	execute (int $issuerid, int $courseid)
	External function to check if the user is already authorized with MoodleNet.
static	execute_parameters ()
	Returns description of parameters.
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 check whether a user has authorized for a given MoodleNet OAuth 2 issuer.

Copyright

2023 Huong Nguyen huong.nosp@m.nv13.nosp@m.@gmai.nosp@m.l.co.nosp@m.m

License

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

Member Function Documentation

execute()

static core\external\moodlenet_auth_check::execute ( int $issuerid, int $courseid )

static

External function to check if the user is already authorized with MoodleNet.

Parameters

int	$issuerid	Issuer Id.
int	$courseid	The course ID that contains the activity which being shared

Return values

array

Since

Moodle 4.2

execute_parameters()

static core\external\moodlenet_auth_check::execute_parameters ( )

static

Returns description of parameters.

Return values

external_function_parameters

Since

Moodle 4.2

execute_returns()

static core\external\moodlenet_auth_check::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_auth_check::return_errors ( int $itemid, string $warningcode, string $message )

staticprotected

Handle return error.

Parameters

int	$itemid	Item id
string	$warningcode	Warning code
string	$message	Message

Return values

array

---

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

• lib/classes/external/moodlenet_auth_check.php