MDL-51624 mod_lti: New Web Service mod_lti_view_lti
[moodle.git] / mod / lti / db / services.php
1 <?php
2 // This file is part of Moodle - http://moodle.org/
3 //
4 // Moodle is free software: you can redistribute it and/or modify
5 // it under the terms of the GNU General Public License as published by
6 // the Free Software Foundation, either version 3 of the License, or
7 // (at your option) any later version.
8 //
9 // Moodle is distributed in the hope that it will be useful,
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12 // GNU General Public License for more details.
13 //
14 // You should have received a copy of the GNU General Public License
15 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
17 /**
18  * External tool external functions and service definitions.
19  *
20  * @package    mod_lti
21  * @category   external
22  * @copyright  2015 Juan Leyva <juan@moodle.com>
23  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
24  * @since      Moodle 3.0
25  */
27 $functions = array(
29     'mod_lti_get_tool_launch_data' => array(
30         'classname'     => 'mod_lti_external',
31         'methodname'    => 'get_tool_launch_data',
32         'description'   => 'Return the launch data for a given external tool.',
33         'type'          => 'read',
34         'capabilities'  => 'mod/lti:view'
35     ),
37     'mod_lti_get_ltis_by_courses' => array(
38         'classname'     => 'mod_lti_external',
39         'methodname'    => 'get_ltis_by_courses',
40         'description'   => 'Returns a list of external tool instances in a provided set of courses, if
41                             no courses are provided then all the external tool instances the user has access to will be returned.',
42         'type'          => 'read',
43         'capabilities'  => 'mod/lti:view'
44     ),
46     'mod_lti_view_lti' => array(
47         'classname'     => 'mod_lti_external',
48         'methodname'    => 'view_lti',
49         'description'   => 'Trigger the course module viewed event and update the module completion status.',
50         'type'          => 'write',
51         'capabilities'  => 'mod/lti:view'
52     ),
53 );