Class to implement Resource Link services for a Canvas tool consumer via its proprietary API. More...

Inheritance diagram for CanvasApiResourceLink:

Public Member Functions
	getMemberships ($withGroups)
	Get memberships. More...

Public Member Functions inherited from ApiResourceLink
	__construct ($resourceLink)
	Class constructor. More...

	doOutcomesService ($action, $ltiOutcome, $userresult)
	Perform an Outcomes service request. More...

	getMemberships ($withGroups)
	Get memberships. More...

	getToolSettings ($mode=Service\ToolSettings::MODE_CURRENT_LEVEL, $simple=true)
	Get Tool Settings. More...

	setToolSettings ($settings=array())
	Perform a Tool Settings service request. More...

Additional Inherited Members
Protected Attributes inherited from ApiResourceLink
	$resourceLink = null
	Resource link object. More...

Detailed Description

Class to implement Resource Link services for a Canvas tool consumer via its proprietary API.

Author: Simon Booth s.p.b.nosp@m.ooth.nosp@m.@stir.nosp@m..ac..nosp@m.uk; Stephen P Vickers steph.nosp@m.en@s.nosp@m.pvsof.nosp@m.twar.nosp@m.eprod.nosp@m.ucts.nosp@m..com

Licence: http://www.gnu.org/licenses/lgpl.html GNU Lesser General Public License, version 3

Definition at line 17 of file CanvasApiResourceLink.php.

Member Function Documentation

getMemberships ( $withGroups )

Get memberships.

Parameters

bool $withGroups True is group information is to be requested as well

Returns: mixed Array of UserResult objects or False if the request was not successful

Definition at line 27 of file CanvasApiResourceLink.php.

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