MDL-50853 mod_chat: New Web Service mod_chat_send_chat_message
[moodle.git] / mod / chat / 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  * Chat external functions and service definitions.
19  *
20  * @package    mod_chat
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 defined('MOODLE_INTERNAL') || die;
29 $functions = array(
31     'mod_chat_login_user' => array(
32         'classname'     => 'mod_chat_external',
33         'methodname'    => 'login_user',
34         'description'   => 'Log a user into a chat room in the given chat.',
35         'type'          => 'write',
36         'capabilities'  => 'mod/chat:chat'
37     ),
39     'mod_chat_get_chat_users' => array(
40         'classname'     => 'mod_chat_external',
41         'methodname'    => 'get_chat_users',
42         'description'   => 'Get the list of users in the given chat session.',
43         'type'          => 'read',
44         'capabilities'  => 'mod/chat:chat'
45     ),
47     'mod_chat_send_chat_message' => array(
48         'classname'     => 'mod_chat_external',
49         'methodname'    => 'send_chat_message',
50         'description'   => 'Send a message on the given chat session.',
51         'type'          => 'write',
52         'capabilities'  => 'mod/chat:chat'
53     ),
55 );