CanvasApiTool Class Reference

Class to implement canvas-specific functions for LTI messages. More...

Inheritance diagram for CanvasApiTool:

Public Member Functions
string	getUserId ()
	Get the User ID.
Public Member Functions inherited from ApiTool
	__construct (?Tool $tool)
	Class constructor.
bool	isConfigured ()
	Check if the API hook has been configured.
string	getContextId ()
	Get the Context ID.

Additional Inherited Members
Protected Attributes inherited from ApiTool
Tool	$tool = null
	Tool object.

Detailed Description

Class to implement canvas-specific functions for LTI messages.

Author

Stephen P Vickers steph.nosp@m.en@s.nosp@m.pvsof.nosp@m.twar.nosp@m.eprod.nosp@m.ucts.nosp@m..com

Copyright

SPV Software Products

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

Member Function Documentation

getUserId()

string getUserId

(

)

Get the User ID.

Returns

string User ID value, or empty string if not available.

Reimplemented from ApiTool.