MDL-54687 core_message: remove contact from DOM if no messages remain
[moodle.git] / lib / db / services.php
CommitLineData
9a0df45a 1<?php
9a0df45a 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/>.
16
a0a07014 17
9a0df45a 18/**
19 * Core external functions and service definitions.
20 *
39b90b51
EL
21 * The functions and services defined on this file are
22 * processed and registered into the Moodle DB after any
23 * install or upgrade operation. All plugins support this.
24 *
25 * For more information, take a look to the documentation available:
26 * - Webservices API: {@link http://docs.moodle.org/dev/Web_services_API}
27 * - External API: {@link http://docs.moodle.org/dev/External_functions_API}
28 * - Upgrade API: {@link http://docs.moodle.org/dev/Upgrade_API}
29 *
a0a07014
JM
30 * @package core_webservice
31 * @category webservice
32 * @copyright 2009 Petr Skodak
9a0df45a 33 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
34 */
35
36$functions = array(
83e4dc17
JL
37 'core_auth_confirm_user' => array(
38 'classname' => 'core_auth_external',
39 'methodname' => 'confirm_user',
40 'description' => 'Confirm a user account.',
41 'type' => 'write',
42 'ajax' => true,
43 'loginrequired' => false,
44 ),
f23e9b6b
CB
45 'core_badges_get_user_badges' => array(
46 'classname' => 'core_badges_external',
47 'methodname' => 'get_user_badges',
48 'description' => 'Returns the list of badges awarded to a user.',
49 'type' => 'read',
ee7295ee
JL
50 'capabilities' => 'moodle/badges:viewotherbadges',
51 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
088645e2 52 ),
f23e9b6b
CB
53 'core_calendar_create_calendar_events' => array(
54 'classname' => 'core_calendar_external',
55 'methodname' => 'create_calendar_events',
56 'description' => 'Create calendar events',
57 'classpath' => 'calendar/externallib.php',
58 'type' => 'write',
59 'capabilities' => 'moodle/calendar:manageentries, moodle/calendar:manageownentries, moodle/calendar:managegroupentries'
088645e2 60 ),
f23e9b6b
CB
61 'core_calendar_delete_calendar_events' => array(
62 'classname' => 'core_calendar_external',
63 'methodname' => 'delete_calendar_events',
64 'description' => 'Delete calendar events',
65 'classpath' => 'calendar/externallib.php',
66 'type' => 'write',
67 'capabilities' => 'moodle/calendar:manageentries, moodle/calendar:manageownentries, moodle/calendar:managegroupentries'
088645e2 68 ),
f23e9b6b
CB
69 'core_calendar_get_calendar_events' => array(
70 'classname' => 'core_calendar_external',
71 'methodname' => 'get_calendar_events',
72 'description' => 'Get calendar events',
73 'classpath' => 'calendar/externallib.php',
74 'type' => 'read',
ee7295ee
JL
75 'capabilities' => 'moodle/calendar:manageentries, moodle/calendar:manageownentries, moodle/calendar:managegroupentries',
76 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
088645e2 77 ),
088645e2 78 'core_cohort_add_cohort_members' => array(
f23e9b6b
CB
79 'classname' => 'core_cohort_external',
80 'methodname' => 'add_cohort_members',
81 'classpath' => 'cohort/externallib.php',
088645e2 82 'description' => 'Adds cohort members.',
f23e9b6b
CB
83 'type' => 'write',
84 'capabilities' => 'moodle/cohort:assign'
85 ),
86 'core_cohort_create_cohorts' => array(
87 'classname' => 'core_cohort_external',
88 'methodname' => 'create_cohorts',
89 'classpath' => 'cohort/externallib.php',
90 'description' => 'Creates new cohorts.',
91 'type' => 'write',
92 'capabilities' => 'moodle/cohort:manage'
088645e2 93 ),
088645e2 94 'core_cohort_delete_cohort_members' => array(
f23e9b6b
CB
95 'classname' => 'core_cohort_external',
96 'methodname' => 'delete_cohort_members',
97 'classpath' => 'cohort/externallib.php',
088645e2 98 'description' => 'Deletes cohort members.',
0a4f3eb2 99 'type' => 'write',
f23e9b6b
CB
100 'capabilities' => 'moodle/cohort:assign'
101 ),
102 'core_cohort_delete_cohorts' => array(
103 'classname' => 'core_cohort_external',
104 'methodname' => 'delete_cohorts',
105 'classpath' => 'cohort/externallib.php',
106 'description' => 'Deletes all specified cohorts.',
0a4f3eb2 107 'type' => 'write',
f23e9b6b 108 'capabilities' => 'moodle/cohort:manage'
088645e2 109 ),
088645e2 110 'core_cohort_get_cohort_members' => array(
f23e9b6b
CB
111 'classname' => 'core_cohort_external',
112 'methodname' => 'get_cohort_members',
113 'classpath' => 'cohort/externallib.php',
088645e2 114 'description' => 'Returns cohort members.',
f23e9b6b
CB
115 'type' => 'read',
116 'capabilities' => 'moodle/cohort:view'
e77a0f36 117 ),
f23e9b6b
CB
118 'core_cohort_get_cohorts' => array(
119 'classname' => 'core_cohort_external',
120 'methodname' => 'get_cohorts',
121 'classpath' => 'cohort/externallib.php',
122 'description' => 'Returns cohort details.',
123 'type' => 'read',
124 'capabilities' => 'moodle/cohort:view'
d3549931 125 ),
f23e9b6b
CB
126 'core_cohort_update_cohorts' => array(
127 'classname' => 'core_cohort_external',
128 'methodname' => 'update_cohorts',
129 'classpath' => 'cohort/externallib.php',
130 'description' => 'Updates existing cohorts.',
131 'type' => 'write',
132 'capabilities' => 'moodle/cohort:manage'
d3549931 133 ),
f23e9b6b
CB
134 'core_comment_get_comments' => array(
135 'classname' => 'core_comment_external',
136 'methodname' => 'get_comments',
137 'description' => 'Returns comments.',
138 'type' => 'read',
ee7295ee
JL
139 'capabilities' => 'moodle/comment:view',
140 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
5d1017e1 141 ),
f23e9b6b
CB
142 'core_completion_get_activities_completion_status' => array(
143 'classname' => 'core_completion_external',
144 'methodname' => 'get_activities_completion_status',
145 'description' => 'Return the activities completion status for a user in a course.',
146 'type' => 'read',
ee7295ee 147 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
9a0df45a 148 ),
f23e9b6b
CB
149 'core_completion_get_course_completion_status' => array(
150 'classname' => 'core_completion_external',
151 'methodname' => 'get_course_completion_status',
152 'description' => 'Returns course completion status.',
153 'type' => 'read',
ee7295ee
JL
154 'capabilities' => 'report/completion:view',
155 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
5d1017e1 156 ),
f23e9b6b
CB
157 'core_completion_mark_course_self_completed' => array(
158 'classname' => 'core_completion_external',
159 'methodname' => 'mark_course_self_completed',
160 'description' => 'Update the course completion status for the current user (if course self-completion is enabled).',
161 'type' => 'write',
ee7295ee 162 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
9a0df45a 163 ),
f23e9b6b
CB
164 'core_completion_update_activity_completion_status_manually' => array(
165 'classname' => 'core_completion_external',
166 'methodname' => 'update_activity_completion_status_manually',
167 'description' => 'Update completion status for the current user in an activity, only for activities with manual tracking.',
168 'type' => 'write',
ee7295ee 169 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
5d1017e1 170 ),
f23e9b6b
CB
171 'core_course_create_categories' => array(
172 'classname' => 'core_course_external',
173 'methodname' => 'create_categories',
174 'classpath' => 'course/externallib.php',
175 'description' => 'Create course categories',
176 'type' => 'write',
177 'capabilities' => 'moodle/category:manage'
246f6da2 178 ),
f23e9b6b
CB
179 'core_course_create_courses' => array(
180 'classname' => 'core_course_external',
181 'methodname' => 'create_courses',
182 'classpath' => 'course/externallib.php',
183 'description' => 'Create new courses',
184 'type' => 'write',
185 'capabilities' => 'moodle/course:create, moodle/course:visibility'
5d1017e1 186 ),
f23e9b6b
CB
187 'core_course_delete_categories' => array(
188 'classname' => 'core_course_external',
189 'methodname' => 'delete_categories',
190 'classpath' => 'course/externallib.php',
191 'description' => 'Delete course categories',
192 'type' => 'write',
193 'capabilities' => 'moodle/category:manage'
9a0df45a 194 ),
f23e9b6b
CB
195 'core_course_delete_courses' => array(
196 'classname' => 'core_course_external',
197 'methodname' => 'delete_courses',
198 'classpath' => 'course/externallib.php',
199 'description' => 'Deletes all specified courses',
200 'type' => 'write',
201 'capabilities' => 'moodle/course:delete'
5d1017e1 202 ),
f23e9b6b
CB
203 'core_course_delete_modules' => array(
204 'classname' => 'core_course_external',
205 'methodname' => 'delete_modules',
206 'classpath' => 'course/externallib.php',
207 'description' => 'Deletes all specified module instances',
208 'type' => 'write',
209 'capabilities' => 'moodle/course:manageactivities'
9a0df45a 210 ),
f23e9b6b
CB
211 'core_course_duplicate_course' => array(
212 'classname' => 'core_course_external',
213 'methodname' => 'duplicate_course',
214 'classpath' => 'course/externallib.php',
215 'description' => 'Duplicate an existing course (creating a new one), without user data',
216 'type' => 'write',
217 'capabilities' => 'moodle/backup:backupcourse, moodle/restore:restorecourse, moodle/course:create'
5d1017e1 218 ),
f23e9b6b
CB
219 'core_course_get_categories' => array(
220 'classname' => 'core_course_external',
221 'methodname' => 'get_categories',
222 'classpath' => 'course/externallib.php',
223 'description' => 'Return category details',
224 'type' => 'read',
331e038b
JL
225 'capabilities' => 'moodle/category:viewhiddencategories',
226 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
9a0df45a 227 ),
f23e9b6b
CB
228 'core_course_get_contents' => array(
229 'classname' => 'core_course_external',
230 'methodname' => 'get_course_contents',
231 'classpath' => 'course/externallib.php',
232 'description' => 'Get course contents',
233 'type' => 'read',
ee7295ee
JL
234 'capabilities' => 'moodle/course:update, moodle/course:viewhiddencourses',
235 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
9a0df45a 236 ),
f23e9b6b
CB
237 'core_course_get_course_module' => array(
238 'classname' => 'core_course_external',
239 'methodname' => 'get_course_module',
240 'classpath' => 'course/externallib.php',
241 'description' => 'Return information about a course module',
242 'type' => 'read',
ee7295ee 243 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
5d1017e1 244 ),
f23e9b6b
CB
245 'core_course_get_course_module_by_instance' => array(
246 'classname' => 'core_course_external',
247 'methodname' => 'get_course_module_by_instance',
248 'classpath' => 'course/externallib.php',
249 'description' => 'Return information about a given module name and instance id',
250 'type' => 'read',
ee7295ee 251 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
7ce23590 252 ),
f23e9b6b
CB
253 'core_course_get_courses' => array(
254 'classname' => 'core_course_external',
255 'methodname' => 'get_courses',
256 'classpath' => 'course/externallib.php',
257 'description' => 'Return course details',
258 'type' => 'read',
259 'capabilities' => 'moodle/course:view, moodle/course:update, moodle/course:viewhiddencourses',
5041600d 260 'ajax' => true,
ee7295ee 261 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
7ce23590 262 ),
f23e9b6b
CB
263 'core_course_import_course' => array(
264 'classname' => 'core_course_external',
265 'methodname' => 'import_course',
266 'classpath' => 'course/externallib.php',
267 'description' => 'Import course data from a course into another course. Does not include any user data.',
268 'type' => 'write',
269 'capabilities' => 'moodle/backup:backuptargetimport, moodle/restore:restoretargetimport'
7ce23590 270 ),
f23e9b6b
CB
271 'core_course_search_courses' => array(
272 'classname' => 'core_course_external',
273 'methodname' => 'search_courses',
274 'classpath' => 'course/externallib.php',
275 'description' => 'Search courses by (name, module, block, tag)',
276 'type' => 'read',
5041600d 277 'ajax' => true,
ee7295ee 278 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
7ce23590 279 ),
f23e9b6b
CB
280 'core_course_update_categories' => array(
281 'classname' => 'core_course_external',
282 'methodname' => 'update_categories',
283 'classpath' => 'course/externallib.php',
284 'description' => 'Update categories',
285 'type' => 'write',
286 'capabilities' => 'moodle/category:manage',
7ce23590 287 ),
f23e9b6b
CB
288 'core_course_update_courses' => array(
289 'classname' => 'core_course_external',
290 'methodname' => 'update_courses',
291 'classpath' => 'course/externallib.php',
292 'description' => 'Update courses',
293 'type' => 'write',
294 'capabilities' => 'moodle/course:update, moodle/course:changecategory, moodle/course:changefullname, '
295 . 'moodle/course:changeshortname, moodle/course:changeidnumber, moodle/course:changesummary, moodle/course:visibility'
7ce23590 296 ),
f23e9b6b
CB
297 'core_course_view_course' => array(
298 'classname' => 'core_course_external',
299 'methodname' => 'view_course',
300 'classpath' => 'course/externallib.php',
301 'description' => 'Log that the course was viewed',
302 'type' => 'write',
ee7295ee 303 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
7ce23590 304 ),
7c4e686f
JL
305 'core_course_get_activities_overview' => array(
306 'classname' => 'core_course_external',
307 'methodname' => 'get_activities_overview',
308 'classpath' => 'course/externallib.php',
309 'description' => 'Return activities overview for the given courses.',
310 'type' => 'read',
311 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
312 ),
c115ff6a
JL
313 'core_course_get_user_navigation_options' => array(
314 'classname' => 'core_course_external',
315 'methodname' => 'get_user_navigation_options',
316 'classpath' => 'course/externallib.php',
317 'description' => 'Return a list of navigation options in a set of courses that are avaialable or not for the current user.',
318 'type' => 'read',
319 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
320 ),
b9050b10
JL
321 'core_course_get_user_administration_options' => array(
322 'classname' => 'core_course_external',
323 'methodname' => 'get_user_administration_options',
324 'classpath' => 'course/externallib.php',
325 'description' => 'Return a list of administration options in a set of courses that are avaialable or not for the current
326 user.',
327 'type' => 'read',
328 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
329 ),
80adabef
JL
330 'core_course_get_courses_by_field' => array(
331 'classname' => 'core_course_external',
332 'methodname' => 'get_courses_by_field',
333 'classpath' => 'course/externallib.php',
334 'description' => 'Get courses matching a specific field (id/s, shortname, idnumber, category)',
335 'type' => 'read',
336 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
337 ),
f23e9b6b
CB
338 'core_enrol_get_course_enrolment_methods' => array(
339 'classname' => 'core_enrol_external',
340 'methodname' => 'get_course_enrolment_methods',
341 'classpath' => 'enrol/externallib.php',
342 'description' => 'Get the list of course enrolment methods',
343 'type' => 'read',
ee7295ee 344 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
5d62e813 345 ),
f23e9b6b
CB
346 'core_enrol_get_enrolled_users' => array(
347 'classname' => 'core_enrol_external',
348 'methodname' => 'get_enrolled_users',
349 'classpath' => 'enrol/externallib.php',
350 'description' => 'Get enrolled users by course id.',
351 'type' => 'read',
352 'capabilities' => 'moodle/user:viewdetails, moodle/user:viewhiddendetails, moodle/course:useremail, moodle/user:update, '
ee7295ee
JL
353 . 'moodle/site:accessallgroups',
354 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
7107c2f0 355 ),
f23e9b6b
CB
356 'core_enrol_get_enrolled_users_with_capability' => array(
357 'classname' => 'core_enrol_external',
358 'methodname' => 'get_enrolled_users_with_capability',
359 'classpath' => 'enrol/externallib.php',
360 'description' => 'For each course and capability specified, return a list of the users that are enrolled in the course
361 and have that capability',
362 'type' => 'read',
c0ef63eb 363 ),
f23e9b6b
CB
364 'core_enrol_get_users_courses' => array(
365 'classname' => 'core_enrol_external',
366 'methodname' => 'get_users_courses',
367 'classpath' => 'enrol/externallib.php',
368 'description' => 'Get the list of courses where a user is enrolled in',
369 'type' => 'read',
ee7295ee
JL
370 'capabilities' => 'moodle/course:viewparticipants',
371 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
9857381d 372 ),
f23e9b6b
CB
373 'core_fetch_notifications' => array(
374 'classname' => 'core_external',
375 'methodname' => 'fetch_notifications',
376 'classpath' => 'lib/external/externallib.php',
377 'description' => 'Return a list of notifications for the current session',
378 'type' => 'read',
5041600d
RT
379 'loginrequired' => false,
380 'ajax' => true,
5d1017e1 381 ),
5d1017e1 382 'core_files_get_files' => array(
f23e9b6b
CB
383 'classname' => 'core_files_external',
384 'methodname' => 'get_files',
249c4f60 385 'description' => 'browse moodle files',
f23e9b6b
CB
386 'type' => 'read',
387 'classpath' => 'files/externallib.php',
ee7295ee 388 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
5d1017e1 389 ),
5d1017e1 390 'core_files_upload' => array(
f23e9b6b
CB
391 'classname' => 'core_files_external',
392 'methodname' => 'upload',
249c4f60
DC
393 'description' => 'upload a file to moodle',
394 'type' => 'write',
395 'classpath' => 'files/externallib.php',
396 ),
f23e9b6b
CB
397 'core_get_component_strings' => array(
398 'classname' => 'core_external',
399 'methodname' => 'get_component_strings',
400 'classpath' => 'lib/external/externallib.php',
faeca20d
DM
401 'description' => 'Return all raw strings (with {$a->xxx}), for a specific component ' .
402 '- similar to core get_component_strings(), call',
f23e9b6b 403 'type' => 'read',
5041600d
RT
404 'loginrequired' => false,
405 'ajax' => true,
ee7295ee 406 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
3364dbb5 407 ),
f23e9b6b
CB
408 'core_get_fragment' => array(
409 'classname' => 'core_external',
410 'methodname' => 'get_fragment',
411 'classpath' => 'lib/external/externallib.php',
412 'description' => 'Return a fragment for inclusion, such as a JavaScript page.',
413 'type' => 'read',
5041600d 414 'ajax' => true,
5d1017e1 415 ),
f23e9b6b
CB
416 'core_get_string' => array(
417 'classname' => 'core_external',
418 'methodname' => 'get_string',
419 'classpath' => 'lib/external/externallib.php',
420 'description' => 'Return a translated string - similar to core get_string(), call',
421 'type' => 'read',
5041600d
RT
422 'loginrequired' => false,
423 'ajax' => true,
be9bf94e 424 ),
f23e9b6b
CB
425 'core_get_strings' => array(
426 'classname' => 'core_external',
427 'methodname' => 'get_strings',
428 'classpath' => 'lib/external/externallib.php',
429 'description' => 'Return some translated strings - like several core get_string(), calls',
430 'type' => 'read',
5041600d
RT
431 'loginrequired' => false,
432 'ajax' => true,
5d1017e1 433 ),
f23e9b6b
CB
434 'core_grades_get_grades' => array(
435 'classname' => 'core_grades_external',
436 'methodname' => 'get_grades',
aa7e371a
JL
437 'description' => '** DEPRECATED ** Please do not call this function any more.
438 Returns student course total grade and grades for activities.
f23e9b6b
CB
439 This function does not return category or manual items.
440 This function is suitable for managers or teachers not students.',
441 'type' => 'read',
442 'capabilities' => 'moodle/grade:view, moodle/grade:viewall, moodle/grade:viewhidden'
e9b66095 443 ),
f23e9b6b
CB
444 'core_grades_update_grades' => array(
445 'classname' => 'core_grades_external',
446 'methodname' => 'update_grades',
447 'description' => 'Update a grade item and associated student grades.',
448 'type' => 'write',
5d1017e1 449 ),
f23e9b6b
CB
450 'core_grading_get_definitions' => array(
451 'classname' => 'core_grading_external',
452 'methodname' => 'get_definitions',
453 'description' => 'Get grading definitions',
454 'type' => 'read',
e9b66095 455 ),
f23e9b6b
CB
456 'core_grading_get_gradingform_instances' => array(
457 'classname' => 'core_grading_external',
458 'methodname' => 'get_gradingform_instances',
459 'description' => 'Get grading form instances',
460 'type' => 'read',
f2229c68 461 ),
f23e9b6b
CB
462 'core_grading_save_definitions' => array(
463 'classname' => 'core_grading_external',
464 'methodname' => 'save_definitions',
465 'description' => 'Save grading definitions',
466 'type' => 'write',
5d1017e1 467 ),
f23e9b6b
CB
468 'core_group_add_group_members' => array(
469 'classname' => 'core_group_external',
470 'methodname' => 'add_group_members',
471 'classpath' => 'group/externallib.php',
472 'description' => 'Adds group members.',
473 'type' => 'write',
474 'capabilities' => 'moodle/course:managegroups',
6bb31e40 475 ),
f23e9b6b
CB
476 'core_group_assign_grouping' => array(
477 'classname' => 'core_group_external',
478 'methodname' => 'assign_grouping',
479 'classpath' => 'group/externallib.php',
480 'description' => 'Assing groups from groupings',
481 'type' => 'write',
740c354f 482 ),
f23e9b6b
CB
483 'core_group_create_groupings' => array(
484 'classname' => 'core_group_external',
485 'methodname' => 'create_groupings',
486 'classpath' => 'group/externallib.php',
487 'description' => 'Creates new groupings',
488 'type' => 'write',
5d1017e1 489 ),
f23e9b6b
CB
490 'core_group_create_groups' => array(
491 'classname' => 'core_group_external',
492 'methodname' => 'create_groups',
493 'classpath' => 'group/externallib.php',
494 'description' => 'Creates new groups.',
495 'type' => 'write',
496 'capabilities' => 'moodle/course:managegroups'
6bb31e40 497 ),
f23e9b6b
CB
498 'core_group_delete_group_members' => array(
499 'classname' => 'core_group_external',
500 'methodname' => 'delete_group_members',
501 'classpath' => 'group/externallib.php',
502 'description' => 'Deletes group members.',
0a4f3eb2 503 'type' => 'write',
f23e9b6b 504 'capabilities' => 'moodle/course:managegroups'
63a85dc7 505 ),
f23e9b6b
CB
506 'core_group_delete_groupings' => array(
507 'classname' => 'core_group_external',
508 'methodname' => 'delete_groupings',
509 'classpath' => 'group/externallib.php',
510 'description' => 'Deletes all specified groupings.',
79949c1b 511 'type' => 'write',
79949c1b 512 ),
f23e9b6b
CB
513 'core_group_delete_groups' => array(
514 'classname' => 'core_group_external',
515 'methodname' => 'delete_groups',
516 'classpath' => 'group/externallib.php',
517 'description' => 'Deletes all specified groups.',
0a4f3eb2 518 'type' => 'write',
f23e9b6b 519 'capabilities' => 'moodle/course:managegroups'
3dc1d76e 520 ),
f23e9b6b
CB
521 'core_group_get_activity_allowed_groups' => array(
522 'classname' => 'core_group_external',
523 'methodname' => 'get_activity_allowed_groups',
524 'classpath' => 'group/externallib.php',
525 'description' => 'Gets a list of groups that the user is allowed to access within the specified activity.',
526 'type' => 'read',
ee7295ee 527 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
791723c3 528 ),
f23e9b6b
CB
529 'core_group_get_activity_groupmode' => array(
530 'classname' => 'core_group_external',
531 'methodname' => 'get_activity_groupmode',
532 'classpath' => 'group/externallib.php',
533 'description' => 'Returns effective groupmode used in a given activity.',
534 'type' => 'read',
ee7295ee 535 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
c4f7bf29 536 ),
f23e9b6b
CB
537 'core_group_get_course_groupings' => array(
538 'classname' => 'core_group_external',
539 'methodname' => 'get_course_groupings',
540 'classpath' => 'group/externallib.php',
541 'description' => 'Returns all groupings in specified course.',
542 'type' => 'read',
c5158499 543 ),
f23e9b6b
CB
544 'core_group_get_course_groups' => array(
545 'classname' => 'core_group_external',
546 'methodname' => 'get_course_groups',
547 'classpath' => 'group/externallib.php',
548 'description' => 'Returns all groups in specified course.',
549 'type' => 'read',
550 'capabilities' => 'moodle/course:managegroups'
13bb6819 551 ),
f23e9b6b
CB
552 'core_group_get_course_user_groups' => array(
553 'classname' => 'core_group_external',
554 'methodname' => 'get_course_user_groups',
555 'classpath' => 'group/externallib.php',
556 'description' => 'Returns all groups in specified course for the specified user.',
557 'type' => 'read',
ee7295ee
JL
558 'capabilities' => 'moodle/course:managegroups',
559 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
3ec163dd 560 ),
f23e9b6b
CB
561 'core_group_get_group_members' => array(
562 'classname' => 'core_group_external',
563 'methodname' => 'get_group_members',
564 'classpath' => 'group/externallib.php',
565 'description' => 'Returns group members.',
566 'type' => 'read',
567 'capabilities' => 'moodle/course:managegroups'
479a5db1 568 ),
f23e9b6b
CB
569 'core_group_get_groupings' => array(
570 'classname' => 'core_group_external',
571 'methodname' => 'get_groupings',
572 'classpath' => 'group/externallib.php',
573 'description' => 'Returns groupings details.',
574 'type' => 'read',
3ec163dd 575 ),
f23e9b6b
CB
576 'core_group_get_groups' => array(
577 'classname' => 'core_group_external',
578 'methodname' => 'get_groups',
579 'classpath' => 'group/externallib.php',
580 'description' => 'Returns group details.',
581 'type' => 'read',
582 'capabilities' => 'moodle/course:managegroups'
2f951d86 583 ),
f23e9b6b
CB
584 'core_group_unassign_grouping' => array(
585 'classname' => 'core_group_external',
586 'methodname' => 'unassign_grouping',
587 'classpath' => 'group/externallib.php',
588 'description' => 'Unassing groups from groupings',
589 'type' => 'write',
8430d87b 590 ),
f23e9b6b
CB
591 'core_group_update_groupings' => array(
592 'classname' => 'core_group_external',
593 'methodname' => 'update_groupings',
594 'classpath' => 'group/externallib.php',
595 'description' => 'Updates existing groupings',
596 'type' => 'write',
5d1017e1 597 ),
f23e9b6b
CB
598 'core_message_block_contacts' => array(
599 'classname' => 'core_message_external',
600 'methodname' => 'block_contacts',
601 'classpath' => 'message/externallib.php',
602 'description' => 'Block contacts',
603 'type' => 'write',
c6e97f54 604 'ajax' => true,
ee7295ee 605 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
a623b6b8 606 ),
d6731600 607 'core_message_create_contacts' => array(
f23e9b6b
CB
608 'classname' => 'core_message_external',
609 'methodname' => 'create_contacts',
610 'classpath' => 'message/externallib.php',
d6731600 611 'description' => 'Add contacts to the contact list',
f23e9b6b 612 'type' => 'write',
c6e97f54 613 'ajax' => true,
ee7295ee 614 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
12d8c7b2 615 'ajax' => true,
d6731600 616 ),
d6731600 617 'core_message_delete_contacts' => array(
f23e9b6b
CB
618 'classname' => 'core_message_external',
619 'methodname' => 'delete_contacts',
620 'classpath' => 'message/externallib.php',
d6731600 621 'description' => 'Remove contacts from the contact list',
f23e9b6b 622 'type' => 'write',
c6e97f54 623 'ajax' => true,
ee7295ee 624 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
12d8c7b2 625 'ajax' => true,
d6731600 626 ),
dec0cd99
MN
627 'core_message_delete_conversation' => array(
628 'classname' => 'core_message_external',
629 'methodname' => 'delete_conversation',
630 'classpath' => 'message/externallib.php',
631 'description' => 'Deletes a conversation.',
632 'type' => 'write',
633 'capabilities' => 'moodle/site:deleteownmessage',
634 'ajax' => true,
635 ),
f23e9b6b
CB
636 'core_message_delete_message' => array(
637 'classname' => 'core_message_external',
638 'methodname' => 'delete_message',
639 'classpath' => 'message/externallib.php',
640 'description' => 'Deletes a message.',
641 'type' => 'write',
ee7295ee 642 'capabilities' => 'moodle/site:deleteownmessage',
3090f52f 643 'ajax' => true,
ee7295ee 644 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
d6731600 645 ),
f23e9b6b
CB
646 'core_message_get_blocked_users' => array(
647 'classname' => 'core_message_external',
648 'methodname' => 'get_blocked_users',
649 'classpath' => 'message/externallib.php',
650 'description' => 'Retrieve a list of users blocked',
651 'type' => 'read',
ee7295ee 652 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
d6731600 653 ),
9aa012b5
MN
654 'core_message_data_for_messagearea_conversations' => array(
655 'classname' => 'core_message_external',
656 'methodname' => 'data_for_messagearea_conversations',
657 'classpath' => 'message/externallib.php',
658 'description' => 'Retrieve the template data for the conversation list',
659 'type' => 'read',
660 'ajax' => true,
661 ),
662 'core_message_data_for_messagearea_contacts' => array(
663 'classname' => 'core_message_external',
664 'methodname' => 'data_for_messagearea_contacts',
665 'classpath' => 'message/externallib.php',
666 'description' => 'Retrieve the template data for the contact list',
667 'type' => 'read',
668 'ajax' => true,
669 ),
3cd13828
MN
670 'core_message_data_for_messagearea_messages' => array(
671 'classname' => 'core_message_external',
672 'methodname' => 'data_for_messagearea_messages',
673 'classpath' => 'message/externallib.php',
674 'description' => 'Retrieve the template data for the messages',
675 'type' => 'read',
676 'ajax' => true,
677 ),
c060cd49
MN
678 'core_message_data_for_messagearea_get_most_recent_message' => array(
679 'classname' => 'core_message_external',
680 'methodname' => 'data_for_messagearea_get_most_recent_message',
681 'classpath' => 'message/externallib.php',
682 'description' => 'Retrieve the template data for the most recent message',
683 'type' => 'read',
684 'ajax' => true,
685 ),
c6e97f54
MN
686 'core_message_data_for_messagearea_get_profile' => array(
687 'classname' => 'core_message_external',
688 'methodname' => 'data_for_messagearea_get_profile',
689 'classpath' => 'message/externallib.php',
690 'description' => 'Retrieve the template data for the users\'s profile',
691 'type' => 'read',
692 'ajax' => true,
693 ),
d6731600 694 'core_message_get_contacts' => array(
f23e9b6b
CB
695 'classname' => 'core_message_external',
696 'methodname' => 'get_contacts',
697 'classpath' => 'message/externallib.php',
d6731600 698 'description' => 'Retrieve the contact list',
f23e9b6b 699 'type' => 'read',
ee7295ee 700 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
d6731600 701 ),
aff9da17 702 'core_message_get_messages' => array(
f23e9b6b
CB
703 'classname' => 'core_message_external',
704 'methodname' => 'get_messages',
705 'classpath' => 'message/externallib.php',
706 'description' => 'Retrieve a list of messages sent and received by a user (conversations, notifications or both)',
707 'type' => 'read',
ee7295ee 708 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
3274d5ca
RW
709 'ajax' => true,
710 ),
ada7695d 711 'core_message_get_popup_notifications' => array(
3274d5ca 712 'classname' => 'core_message_external',
ada7695d 713 'methodname' => 'get_popup_notifications',
3274d5ca 714 'classpath' => 'message/externallib.php',
ada7695d 715 'description' => 'Retrieve a list of popup notifications for a user',
3274d5ca
RW
716 'type' => 'read',
717 'ajax' => true,
718 ),
ada7695d 719 'core_message_get_unread_popup_notification_count' => array(
3274d5ca 720 'classname' => 'core_message_external',
ada7695d 721 'methodname' => 'get_unread_popup_notification_count',
3274d5ca 722 'classpath' => 'message/externallib.php',
ada7695d 723 'description' => 'Retrieve the count of unread popup notifications for a given user',
3274d5ca
RW
724 'type' => 'read',
725 'ajax' => true,
726 ),
8c55bd6c
RW
727 'core_message_get_unread_conversations_count' => array(
728 'classname' => 'core_message_external',
729 'methodname' => 'get_unread_conversations_count',
730 'classpath' => 'message/externallib.php',
731 'description' => 'Retrieve the count of unread conversations for a given user',
732 'type' => 'read',
733 'ajax' => true,
734 ),
3274d5ca
RW
735 'core_message_mark_all_notifications_as_read' => array(
736 'classname' => 'core_message_external',
737 'methodname' => 'mark_all_notifications_as_read',
738 'classpath' => 'message/externallib.php',
8c55bd6c
RW
739 'description' => 'Mark all notifications as read for a given user',
740 'type' => 'write',
741 'ajax' => true,
742 ),
743 'core_message_mark_all_messages_as_read' => array(
744 'classname' => 'core_message_external',
745 'methodname' => 'mark_all_messages_as_read',
746 'classpath' => 'message/externallib.php',
747 'description' => 'Mark all messages as read for a given user',
3274d5ca
RW
748 'type' => 'write',
749 'ajax' => true,
60ab2e1b 750 ),
a84f89ca 751 'core_message_mark_message_read' => array(
f23e9b6b
CB
752 'classname' => 'core_message_external',
753 'methodname' => 'mark_message_read',
754 'classpath' => 'message/externallib.php',
755 'description' => 'Mark a single message as read, trigger message_viewed event.',
756 'type' => 'write',
ee7295ee 757 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
a84f89ca 758 ),
a0eabdd3
RW
759 'core_message_message_processor_config_form' => array(
760 'classname' => 'core_message_external',
761 'methodname' => 'message_processor_config_form',
762 'classpath' => 'message/externallib.php',
763 'description' => 'Process the message processor config form',
764 'type' => 'write',
765 'ajax' => true,
766 ),
f23e9b6b
CB
767 'core_message_search_contacts' => array(
768 'classname' => 'core_message_external',
769 'methodname' => 'search_contacts',
770 'classpath' => 'message/externallib.php',
771 'description' => 'Search for contacts',
772 'type' => 'read',
ee7295ee 773 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
419b1128 774 ),
f23e9b6b
CB
775 'core_message_send_instant_messages' => array(
776 'classname' => 'core_message_external',
777 'methodname' => 'send_instant_messages',
778 'classpath' => 'message/externallib.php',
779 'description' => 'Send instant messages',
780 'type' => 'write',
ee7295ee 781 'capabilities' => 'moodle/site:sendmessage',
c060cd49 782 'ajax' => true,
ee7295ee 783 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
f23e9b6b
CB
784 ),
785 'core_message_unblock_contacts' => array(
786 'classname' => 'core_message_external',
787 'methodname' => 'unblock_contacts',
788 'classpath' => 'message/externallib.php',
789 'description' => 'Unblock contacts',
790 'type' => 'write',
c6e97f54 791 'ajax' => true,
ee7295ee 792 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
5d1017e1 793 ),
5d1017e1 794 'core_notes_create_notes' => array(
f23e9b6b
CB
795 'classname' => 'core_notes_external',
796 'methodname' => 'create_notes',
797 'classpath' => 'notes/externallib.php',
8d46dabb 798 'description' => 'Create notes',
f23e9b6b 799 'type' => 'write',
ee7295ee
JL
800 'capabilities' => 'moodle/notes:manage',
801 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
8d46dabb 802 ),
34348b2b 803 'core_notes_delete_notes' => array(
f23e9b6b
CB
804 'classname' => 'core_notes_external',
805 'methodname' => 'delete_notes',
806 'classpath' => 'notes/externallib.php',
34348b2b 807 'description' => 'Delete notes',
f23e9b6b 808 'type' => 'write',
ee7295ee
JL
809 'capabilities' => 'moodle/notes:manage',
810 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
f23e9b6b
CB
811 ),
812 'core_notes_get_course_notes' => array(
813 'classname' => 'core_notes_external',
814 'methodname' => 'get_course_notes',
815 'classpath' => 'notes/externallib.php',
816 'description' => 'Returns all notes in specified course (or site), for the specified user.',
817 'type' => 'read',
ee7295ee
JL
818 'capabilities' => 'moodle/notes:view',
819 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
34348b2b 820 ),
34348b2b 821 'core_notes_get_notes' => array(
f23e9b6b
CB
822 'classname' => 'core_notes_external',
823 'methodname' => 'get_notes',
824 'classpath' => 'notes/externallib.php',
34348b2b 825 'description' => 'Get notes',
f23e9b6b
CB
826 'type' => 'read',
827 'capabilities' => 'moodle/notes:view'
34348b2b 828 ),
34348b2b 829 'core_notes_update_notes' => array(
f23e9b6b
CB
830 'classname' => 'core_notes_external',
831 'methodname' => 'update_notes',
832 'classpath' => 'notes/externallib.php',
34348b2b 833 'description' => 'Update notes',
f23e9b6b
CB
834 'type' => 'write',
835 'capabilities' => 'moodle/notes:manage'
34348b2b 836 ),
a80b5518 837 'core_notes_view_notes' => array(
f23e9b6b
CB
838 'classname' => 'core_notes_external',
839 'methodname' => 'view_notes',
840 'classpath' => 'notes/externallib.php',
841 'description' => 'Simulates the web interface view of notes/index.php: trigger events.',
842 'type' => 'write',
ee7295ee
JL
843 'capabilities' => 'moodle/notes:view',
844 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
9028d9b5 845 ),
f23e9b6b
CB
846 'core_output_load_template' => array(
847 'classname' => 'core\output\external',
848 'methodname' => 'load_template',
849 'description' => 'Load a template for a renderable',
850 'type' => 'read',
5041600d
RT
851 'loginrequired' => false,
852 'ajax' => true,
0ff4ebb4 853 ),
f23e9b6b
CB
854 // Question related functions.
855 'core_question_update_flag' => array(
856 'classname' => 'core_question_external',
857 'methodname' => 'update_flag',
858 'description' => 'Update the flag state of a question attempt.',
859 'type' => 'write',
860 'capabilities' => 'moodle/question:flag',
ee7295ee 861 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
3f0ea6d8 862 ),
f23e9b6b
CB
863 'core_rating_get_item_ratings' => array(
864 'classname' => 'core_rating_external',
865 'methodname' => 'get_item_ratings',
866 'description' => 'Retrieve all the ratings for an item.',
867 'type' => 'read',
ee7295ee
JL
868 'capabilities' => 'moodle/rating:view',
869 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
5d1017e1 870 ),
afb7799a
JL
871 'core_rating_add_rating' => array(
872 'classname' => 'core_rating_external',
873 'methodname' => 'add_rating',
874 'description' => 'Rates an item.',
875 'type' => 'write',
876 'capabilities' => 'moodle/rating:rate',
877 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
878 ),
f23e9b6b
CB
879 'core_role_assign_roles' => array(
880 'classname' => 'core_role_external',
881 'methodname' => 'assign_roles',
882 'classpath' => 'enrol/externallib.php',
883 'description' => 'Manual role assignments.',
884 'type' => 'write',
885 'capabilities' => 'moodle/role:assign'
0bf486a6 886 ),
f23e9b6b
CB
887 'core_role_unassign_roles' => array(
888 'classname' => 'core_role_external',
889 'methodname' => 'unassign_roles',
890 'classpath' => 'enrol/externallib.php',
891 'description' => 'Manual role unassignments.',
892 'type' => 'write',
893 'capabilities' => 'moodle/role:assign'
11e76602 894 ),
f23e9b6b
CB
895 'core_tag_get_tagindex' => array(
896 'classname' => 'core_tag_external',
897 'methodname' => 'get_tagindex',
898 'description' => 'Gets tag index page for one tag and one tag area',
899 'type' => 'read',
5041600d 900 'ajax' => true,
11e76602 901 ),
f23e9b6b
CB
902 'core_tag_get_tags' => array(
903 'classname' => 'core_tag_external',
904 'methodname' => 'get_tags',
905 'description' => 'Gets tags by their ids',
906 'type' => 'read',
5041600d 907 'ajax' => true,
11e76602 908 ),
f23e9b6b
CB
909 'core_tag_update_tags' => array(
910 'classname' => 'core_tag_external',
911 'methodname' => 'update_tags',
912 'description' => 'Updates tags',
913 'type' => 'write',
5041600d 914 'ajax' => true,
cc73ea07 915 ),
cdc5f978 916 'core_update_inplace_editable' => array(
f23e9b6b
CB
917 'classname' => 'core_external',
918 'methodname' => 'update_inplace_editable',
919 'classpath' => 'lib/external/externallib.php',
cdc5f978 920 'description' => 'Generic service to update title',
f23e9b6b 921 'type' => 'write',
5041600d
RT
922 'loginrequired' => true,
923 'ajax' => true,
c66dc3df 924 ),
f23e9b6b
CB
925 'core_user_add_user_device' => array(
926 'classname' => 'core_user_external',
927 'methodname' => 'add_user_device',
928 'classpath' => 'user/externallib.php',
929 'description' => 'Store mobile user devices information for PUSH Notifications.',
930 'type' => 'write',
ee7295ee 931 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
9bdcf579 932 ),
f23e9b6b
CB
933 'core_user_add_user_private_files' => array(
934 'classname' => 'core_user_external',
935 'methodname' => 'add_user_private_files',
936 'classpath' => 'user/externallib.php',
937 'description' => 'Copy files from a draft area to users private files area.',
938 'type' => 'write',
ee7295ee
JL
939 'capabilities' => 'moodle/user:manageownfiles',
940 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
25c49a85 941 ),
f23e9b6b
CB
942 'core_user_create_users' => array(
943 'classname' => 'core_user_external',
944 'methodname' => 'create_users',
945 'classpath' => 'user/externallib.php',
946 'description' => 'Create users.',
947 'type' => 'write',
948 'capabilities' => 'moodle/user:create'
23b398fc 949 ),
f23e9b6b
CB
950 'core_user_delete_users' => array(
951 'classname' => 'core_user_external',
952 'methodname' => 'delete_users',
953 'classpath' => 'user/externallib.php',
954 'description' => 'Delete users.',
955 'type' => 'write',
956 'capabilities' => 'moodle/user:delete'
6c785afa 957 ),
f23e9b6b
CB
958 'core_user_get_course_user_profiles' => array(
959 'classname' => 'core_user_external',
960 'methodname' => 'get_course_user_profiles',
961 'classpath' => 'user/externallib.php',
962 'description' => 'Get course user profiles (each of the profils matching a course id and a user id),.',
963 'type' => 'read',
964 'capabilities' => 'moodle/user:viewdetails, moodle/user:viewhiddendetails, moodle/course:useremail, moodle/user:update, '
ee7295ee
JL
965 . 'moodle/site:accessallgroups',
966 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
6c785afa 967 ),
f23e9b6b
CB
968 'core_user_get_users' => array(
969 'classname' => 'core_user_external',
970 'methodname' => 'get_users',
971 'classpath' => 'user/externallib.php',
972 'description' => 'search for users matching the parameters',
973 'type' => 'read',
974 'capabilities' => 'moodle/user:viewdetails, moodle/user:viewhiddendetails, moodle/course:useremail, moodle/user:update'
db5b6971 975 ),
f23e9b6b
CB
976 'core_user_get_users_by_field' => array(
977 'classname' => 'core_user_external',
978 'methodname' => 'get_users_by_field',
979 'classpath' => 'user/externallib.php',
980 'description' => 'Retrieve users\' information for a specified unique field - If you want to do a user search, use '
981 . 'core_user_get_users()',
982 'type' => 'read',
ee7295ee 983 'capabilities' => 'moodle/user:viewdetails, moodle/user:viewhiddendetails, moodle/course:useremail, moodle/user:update',
5041600d 984 'ajax' => true,
ee7295ee 985 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
8e355853 986 ),
f23e9b6b
CB
987 'core_user_remove_user_device' => array(
988 'classname' => 'core_user_external',
989 'methodname' => 'remove_user_device',
990 'classpath' => 'user/externallib.php',
991 'description' => 'Remove a user device from the Moodle database.',
992 'type' => 'write',
ee7295ee 993 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
ef4c23cc 994 ),
a0eabdd3
RW
995 'core_user_update_user' => array(
996 'classname' => 'core_user_external',
997 'methodname' => 'update_user',
998 'classpath' => 'user/externallib.php',
999 'description' => 'Update logged in user',
1000 'type' => 'write',
1001 'capabilities' => 'moodle/user:update',
1002 'ajax' => true,
1003 ),
f23e9b6b
CB
1004 'core_user_update_users' => array(
1005 'classname' => 'core_user_external',
1006 'methodname' => 'update_users',
1007 'classpath' => 'user/externallib.php',
1008 'description' => 'Update users.',
1009 'type' => 'write',
1010 'capabilities' => 'moodle/user:update',
a0eabdd3 1011 'ajax' => true,
c026a28d 1012 ),
f23e9b6b
CB
1013 'core_user_view_user_list' => array(
1014 'classname' => 'core_user_external',
1015 'methodname' => 'view_user_list',
1016 'classpath' => 'user/externallib.php',
1017 'description' => 'Simulates the web-interface view of user/index.php (triggering events),.',
1018 'type' => 'write',
1019 'capabilities' => 'moodle/course:viewparticipants',
ee7295ee 1020 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
7361b968 1021 ),
f23e9b6b
CB
1022 'core_user_view_user_profile' => array(
1023 'classname' => 'core_user_external',
1024 'methodname' => 'view_user_profile',
1025 'classpath' => 'user/externallib.php',
1026 'description' => 'Simulates the web-interface view of user/view.php and user/profile.php (triggering events),.',
1027 'type' => 'write',
1028 'capabilities' => 'moodle/user:viewdetails',
ee7295ee 1029 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
f4fb827e 1030 ),
45fec983
JL
1031 'core_user_get_user_preferences' => array(
1032 'classname' => 'core_user_external',
1033 'methodname' => 'get_user_preferences',
1034 'classpath' => 'user/externallib.php',
1035 'description' => 'Return user preferences.',
1036 'type' => 'read',
1037 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
1038 ),
d44e2e42
JL
1039 'core_user_update_picture' => array(
1040 'classname' => 'core_user_external',
1041 'methodname' => 'update_picture',
1042 'classpath' => 'user/externallib.php',
1043 'description' => 'Update or delete the user picture in the site',
1044 'type' => 'write',
1045 'capabilities' => 'moodle/user:editownprofile, moodle/user:editprofile',
1046 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
1047 ),
649777fb
JL
1048 'core_user_set_user_preferences' => array(
1049 'classname' => 'core_user_external',
1050 'methodname' => 'set_user_preferences',
1051 'classpath' => 'user/externallib.php',
1052 'description' => 'Set user preferences.',
1053 'type' => 'write',
1054 'capabilities' => 'moodle/site:config',
1055 ),
3e8145a3
JL
1056 'core_user_agree_site_policy' => array(
1057 'classname' => 'core_user_external',
1058 'methodname' => 'agree_site_policy',
1059 'classpath' => 'user/externallib.php',
1060 'description' => 'Agree the site policy for the current user.',
1061 'type' => 'write',
1062 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
1063 ),
649777fb 1064
81de839f
FM
1065 // Competencies functions.
1066 'core_competency_create_competency_framework' => array(
1067 'classname' => 'core_competency\external',
1068 'methodname' => 'create_competency_framework',
1069 'classpath' => '',
1070 'description' => 'Creates new competency frameworks.',
1071 'type' => 'write',
1072 'capabilities' => 'moodle/competency:competencymanage',
1073 'ajax' => true,
1074 ),
1075 'core_competency_read_competency_framework' => array(
1076 'classname' => 'core_competency\external',
1077 'methodname' => 'read_competency_framework',
1078 'classpath' => '',
1079 'description' => 'Load a summary of a competency framework.',
1080 'type' => 'read',
1081 'capabilities' => 'moodle/competency:competencyview',
1082 'ajax' => true,
1083 ),
1084 'core_competency_duplicate_competency_framework' => array(
1085 'classname' => 'core_competency\external',
1086 'methodname' => 'duplicate_competency_framework',
1087 'classpath' => '',
1088 'description' => 'Duplicate a competency framework.',
1089 'type' => 'write',
1090 'capabilities' => 'moodle/competency:competencymanage',
1091 'ajax' => true,
1092 ),
1093 'core_competency_delete_competency_framework' => array(
1094 'classname' => 'core_competency\external',
1095 'methodname' => 'delete_competency_framework',
1096 'classpath' => '',
1097 'description' => 'Delete a competency framework.',
1098 'type' => 'write',
1099 'capabilities' => 'moodle/competency:competencymanage',
1100 'ajax' => true,
1101 ),
1102 'core_competency_update_competency_framework' => array(
1103 'classname' => 'core_competency\external',
1104 'methodname' => 'update_competency_framework',
1105 'classpath' => '',
1106 'description' => 'Update a competency framework.',
1107 'type' => 'write',
1108 'capabilities' => 'moodle/competency:competencymanage',
1109 'ajax' => true,
1110 ),
1111 'core_competency_list_competency_frameworks' => array(
1112 'classname' => 'core_competency\external',
1113 'methodname' => 'list_competency_frameworks',
1114 'classpath' => '',
1115 'description' => 'Load a list of a competency frameworks.',
1116 'type' => 'read',
1117 'capabilities' => 'moodle/competency:competencyview',
1118 'ajax' => true,
1119 ),
1120 'core_competency_count_competency_frameworks' => array(
1121 'classname' => 'core_competency\external',
1122 'methodname' => 'count_competency_frameworks',
1123 'classpath' => '',
1124 'description' => 'Count a list of a competency frameworks.',
1125 'type' => 'read',
1126 'capabilities' => 'moodle/competency:competencyview',
1127 'ajax' => true,
1128 ),
1129 'core_competency_competency_framework_viewed' => array(
1130 'classname' => 'core_competency\external',
1131 'methodname' => 'competency_framework_viewed',
1132 'classpath' => '',
1133 'description' => 'Log event competency framework viewed',
1134 'type' => 'read',
1135 'capabilities' => 'moodle/competency:competencyview',
1136 'ajax' => true,
1137 ),
1138 'core_competency_create_competency' => array(
1139 'classname' => 'core_competency\external',
1140 'methodname' => 'create_competency',
1141 'classpath' => '',
1142 'description' => 'Creates new competencies.',
1143 'type' => 'write',
1144 'capabilities' => 'moodle/competency:competencymanage',
1145 'ajax' => true,
1146 ),
1147 'core_competency_read_competency' => array(
1148 'classname' => 'core_competency\external',
1149 'methodname' => 'read_competency',
1150 'classpath' => '',
1151 'description' => 'Load a summary of a competency.',
1152 'type' => 'read',
1153 'capabilities' => 'moodle/competency:competencyview',
1154 'ajax' => true,
1155 ),
1156 'core_competency_competency_viewed' => array(
1157 'classname' => 'core_competency\external',
1158 'methodname' => 'competency_viewed',
1159 'classpath' => '',
1160 'description' => 'Log event competency viewed',
1161 'type' => 'read',
1162 'capabilities' => 'moodle/competency:competencyview',
1163 'ajax' => true,
3123c2cf 1164 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
81de839f
FM
1165 ),
1166 'core_competency_delete_competency' => array(
1167 'classname' => 'core_competency\external',
1168 'methodname' => 'delete_competency',
1169 'classpath' => '',
1170 'description' => 'Delete a competency.',
1171 'type' => 'write',
1172 'capabilities' => 'moodle/competency:competencymanage',
1173 'ajax' => true,
1174 ),
1175 'core_competency_update_competency' => array(
1176 'classname' => 'core_competency\external',
1177 'methodname' => 'update_competency',
1178 'classpath' => '',
1179 'description' => 'Update a competency.',
1180 'type' => 'write',
1181 'capabilities' => 'moodle/competency:competencymanage',
1182 'ajax' => true,
1183 ),
1184 'core_competency_list_competencies' => array(
1185 'classname' => 'core_competency\external',
1186 'methodname' => 'list_competencies',
1187 'classpath' => '',
1188 'description' => 'Load a list of a competencies.',
1189 'type' => 'read',
1190 'capabilities' => 'moodle/competency:competencyview',
1191 'ajax' => true,
1192 ),
1193 'core_competency_list_competencies_in_template' => array(
1194 'classname' => 'core_competency\external',
1195 'methodname' => 'list_competencies_in_template',
1196 'classpath' => '',
1197 'description' => 'Load a list of a competencies for a given template.',
1198 'type' => 'read',
1199 'capabilities' => 'moodle/competency:competencyview',
1200 'ajax' => true,
1201 ),
1202 'core_competency_count_competencies' => array(
1203 'classname' => 'core_competency\external',
1204 'methodname' => 'count_competencies',
1205 'classpath' => '',
1206 'description' => 'Count a list of a competencies.',
1207 'type' => 'read',
1208 'capabilities' => 'moodle/competency:competencyview',
1209 'ajax' => true,
1210 ),
1211 'core_competency_count_competencies_in_template' => array(
1212 'classname' => 'core_competency\external',
1213 'methodname' => 'count_competencies_in_template',
1214 'classpath' => '',
1215 'description' => 'Count a list of a competencies for a given template.',
1216 'type' => 'read',
1217 'capabilities' => 'moodle/competency:competencyview',
1218 'ajax' => true,
1219 ),
1220 'core_competency_search_competencies' => array(
1221 'classname' => 'core_competency\external',
1222 'methodname' => 'search_competencies',
1223 'classpath' => '',
1224 'description' => 'Search a list of a competencies.',
1225 'type' => 'read',
1226 'capabilities' => 'moodle/competency:competencyview',
1227 'ajax' => true,
1228 ),
1229 'core_competency_set_parent_competency' => array(
1230 'classname' => 'core_competency\external',
1231 'methodname' => 'set_parent_competency',
1232 'classpath' => '',
1233 'description' => 'Set a new parent for a competency.',
1234 'type' => 'write',
1235 'capabilities' => 'moodle/competency:competencymanage',
1236 'ajax' => true,
1237 ),
1238 'core_competency_move_up_competency' => array(
1239 'classname' => 'core_competency\external',
1240 'methodname' => 'move_up_competency',
1241 'classpath' => '',
1242 'description' => 'Re-order a competency.',
1243 'type' => 'write',
1244 'capabilities' => 'moodle/competency:competencymanage',
1245 'ajax' => true,
1246 ),
1247 'core_competency_move_down_competency' => array(
1248 'classname' => 'core_competency\external',
1249 'methodname' => 'move_down_competency',
1250 'classpath' => '',
1251 'description' => 'Re-order a competency.',
1252 'type' => 'write',
1253 'capabilities' => 'moodle/competency:competencymanage',
1254 'ajax' => true,
1255 ),
1256 'core_competency_list_course_competencies' => array(
1257 'classname' => 'core_competency\external',
1258 'methodname' => 'list_course_competencies',
1259 'classpath' => '',
1260 'description' => 'List the competencies in a course',
1261 'type' => 'read',
1262 'capabilities' => 'moodle/competency:coursecompetencyview',
1263 'ajax' => true,
3123c2cf 1264 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
81de839f
FM
1265 ),
1266 'core_competency_count_competencies_in_course' => array(
1267 'classname' => 'core_competency\external',
1268 'methodname' => 'count_competencies_in_course',
1269 'classpath' => '',
1270 'description' => 'List the competencies in a course',
1271 'type' => 'read',
1272 'capabilities' => 'moodle/competency:coursecompetencyview',
1273 'ajax' => true,
1274 ),
1275 'core_competency_count_courses_using_competency' => array(
1276 'classname' => 'core_competency\external',
1277 'methodname' => 'count_courses_using_competency',
1278 'classpath' => '',
1279 'description' => 'List the courses using a competency',
1280 'type' => 'read',
1281 'capabilities' => 'moodle/competency:coursecompetencyview',
1282 'ajax' => true,
1283 ),
1284 'core_competency_add_competency_to_course' => array(
1285 'classname' => 'core_competency\external',
1286 'methodname' => 'add_competency_to_course',
1287 'classpath' => '',
1288 'description' => 'Add the competency to a course',
1289 'type' => 'write',
1290 'capabilities' => 'moodle/competency:coursecompetencymanage',
1291 'ajax' => true,
1292 ),
1293 'core_competency_add_competency_to_template' => array(
1294 'classname' => 'core_competency\external',
1295 'methodname' => 'add_competency_to_template',
1296 'classpath' => '',
1297 'description' => 'Add the competency to a template',
1298 'type' => 'write',
1299 'capabilities' => 'moodle/competency:templatemanage',
1300 'ajax' => true,
1301 ),
1302 'core_competency_remove_competency_from_course' => array(
1303 'classname' => 'core_competency\external',
1304 'methodname' => 'remove_competency_from_course',
1305 'classpath' => '',
1306 'description' => 'Remove a competency from a course',
1307 'type' => 'write',
1308 'capabilities' => 'moodle/competency:coursecompetencymanage',
1309 'ajax' => true,
1310 ),
1311 'core_competency_set_course_competency_ruleoutcome' => array(
1312 'classname' => 'core_competency\external',
1313 'methodname' => 'set_course_competency_ruleoutcome',
1314 'classpath' => '',
1315 'description' => 'Modify the ruleoutcome value for course competency',
1316 'type' => 'write',
1317 'capabilities' => 'moodle/competency:coursecompetencymanage',
1318 'ajax' => true,
1319 ),
1320 'core_competency_remove_competency_from_template' => array(
1321 'classname' => 'core_competency\external',
1322 'methodname' => 'remove_competency_from_template',
1323 'classpath' => '',
1324 'description' => 'Remove a competency from a template',
1325 'type' => 'write',
1326 'capabilities' => 'moodle/competency:templatemanage',
1327 'ajax' => true,
1328 ),
1329 'core_competency_reorder_course_competency' => array(
1330 'classname' => 'core_competency\external',
1331 'methodname' => 'reorder_course_competency',
1332 'classpath' => '',
1333 'description' => 'Move a course competency to a new relative sort order.',
1334 'type' => 'write',
1335 'capabilities' => 'moodle/competency:coursecompetencymanage',
1336 'ajax' => true,
1337 ),
1338 'core_competency_reorder_template_competency' => array(
1339 'classname' => 'core_competency\external',
1340 'methodname' => 'reorder_template_competency',
1341 'classpath' => '',
1342 'description' => 'Move a template competency to a new relative sort order.',
1343 'type' => 'write',
1344 'capabilities' => 'moodle/competency:templatemanage',
1345 'ajax' => true,
1346 ),
1347 'core_competency_create_template' => array(
1348 'classname' => 'core_competency\external',
1349 'methodname' => 'create_template',
1350 'classpath' => '',
1351 'description' => 'Creates new learning plan templates.',
1352 'type' => 'write',
1353 'capabilities' => 'moodle/competency:templatemanage',
1354 'ajax' => true,
1355 ),
1356 'core_competency_duplicate_template' => array(
1357 'classname' => 'core_competency\external',
1358 'methodname' => 'duplicate_template',
1359 'classpath' => '',
1360 'description' => 'Duplicate learning plan template.',
1361 'type' => 'write',
1362 'capabilities' => 'moodle/competency:templatemanage',
1363 'ajax' => true,
1364 ),
1365 'core_competency_read_template' => array(
1366 'classname' => 'core_competency\external',
1367 'methodname' => 'read_template',
1368 'classpath' => '',
1369 'description' => 'Load a summary of a learning plan template.',
1370 'type' => 'read',
1371 'capabilities' => 'moodle/competency:templateview',
1372 'ajax' => true,
1373 ),
1374 'core_competency_delete_template' => array(
1375 'classname' => 'core_competency\external',
1376 'methodname' => 'delete_template',
1377 'classpath' => '',
1378 'description' => 'Delete a learning plan template.',
1379 'type' => 'write',
1380 'capabilities' => 'moodle/competency:templatemanage',
1381 'ajax' => true,
1382 ),
1383 'core_competency_update_template' => array(
1384 'classname' => 'core_competency\external',
1385 'methodname' => 'update_template',
1386 'classpath' => '',
1387 'description' => 'Update a learning plan template.',
1388 'type' => 'write',
1389 'capabilities' => 'moodle/competency:templatemanage',
1390 'ajax' => true,
1391 ),
1392 'core_competency_list_templates' => array(
1393 'classname' => 'core_competency\external',
1394 'methodname' => 'list_templates',
1395 'classpath' => '',
1396 'description' => 'Load a list of a learning plan templates.',
1397 'type' => 'read',
1398 'capabilities' => 'moodle/competency:templateview',
1399 'ajax' => true,
1400 ),
1401 'core_competency_list_templates_using_competency' => array(
1402 'classname' => 'core_competency\external',
1403 'methodname' => 'list_templates_using_competency',
1404 'classpath' => '',
1405 'description' => 'Load a list of a learning plan templates for a given competency.',
1406 'type' => 'read',
1407 'capabilities' => 'moodle/competency:templateview',
1408 'ajax' => true,
1409 ),
1410 'core_competency_count_templates' => array(
1411 'classname' => 'core_competency\external',
1412 'methodname' => 'count_templates',
1413 'classpath' => '',
1414 'description' => 'Count a list of a learning plan templates.',
1415 'type' => 'read',
1416 'capabilities' => 'moodle/competency:templateview',
1417 'ajax' => true,
1418 ),
1419 'core_competency_count_templates_using_competency' => array(
1420 'classname' => 'core_competency\external',
1421 'methodname' => 'count_templates_using_competency',
1422 'classpath' => '',
1423 'description' => 'Count a list of a learning plan templates for a given competency.',
1424 'type' => 'read',
1425 'capabilities' => 'moodle/competency:templateview',
1426 'ajax' => true,
1427 ),
1428 'core_competency_create_plan' => array(
1429 'classname' => 'core_competency\external',
1430 'methodname' => 'create_plan',
1431 'classpath' => '',
1432 'description' => 'Creates a learning plan.',
1433 'type' => 'write',
1434 'capabilities' => 'moodle/competency:planmanage',
1435 'ajax' => true,
1436 ),
1437 'core_competency_update_plan' => array(
1438 'classname' => 'core_competency\external',
1439 'methodname' => 'update_plan',
1440 'classpath' => '',
1441 'description' => 'Updates a learning plan.',
1442 'type' => 'write',
1443 'capabilities' => 'moodle/competency:planmanage',
1444 'ajax' => true,
1445 ),
1446 'core_competency_complete_plan' => array(
1447 'classname' => 'core_competency\external',
1448 'methodname' => 'complete_plan',
1449 'classpath' => '',
1450 'description' => 'Complete learning plan.',
1451 'type' => 'write',
1452 'capabilities' => 'moodle/competency:planmanage',
1453 'ajax' => true,
1454 ),
1455 'core_competency_reopen_plan' => array(
1456 'classname' => 'core_competency\external',
1457 'methodname' => 'reopen_plan',
1458 'classpath' => '',
1459 'description' => 'Reopen learning plan.',
1460 'type' => 'write',
1461 'capabilities' => 'moodle/competency:planmanage',
1462 'ajax' => true,
1463 ),
1464 'core_competency_read_plan' => array(
1465 'classname' => 'core_competency\external',
1466 'methodname' => 'read_plan',
1467 'classpath' => '',
1468 'description' => 'Load a learning plan.',
1469 'type' => 'read',
1470 'capabilities' => 'moodle/competency:planviewown',
1471 'ajax' => true,
1472 ),
1473 'core_competency_delete_plan' => array(
1474 'classname' => 'core_competency\external',
1475 'methodname' => 'delete_plan',
1476 'classpath' => '',
1477 'description' => 'Delete a learning plan.',
1478 'type' => 'write',
1479 'capabilities' => 'moodle/competency:planmanage',
1480 'ajax' => true,
1481 ),
1482 'core_competency_list_user_plans' => array(
1483 'classname' => 'core_competency\external',
1484 'methodname' => 'list_user_plans',
1485 'classpath' => '',
1486 'description' => 'List a user\'s learning plans.',
1487 'type' => 'read',
1488 'capabilities' => 'moodle/competency:planviewown',
1489 'ajax' => true,
1490 ),
1491 'core_competency_list_plan_competencies' => array(
1492 'classname' => 'core_competency\external',
1493 'methodname' => 'list_plan_competencies',
1494 'classpath' => '',
1495 'description' => 'List the competencies in a plan',
1496 'type' => 'read',
1497 'capabilities' => 'moodle/competency:planviewown',
1498 'ajax' => true,
1499 ),
1500 'core_competency_add_competency_to_plan' => array(
1501 'classname' => 'core_competency\external',
1502 'methodname' => 'add_competency_to_plan',
1503 'classpath' => '',
1504 'description' => 'Add the competency to a learning plan',
1505 'type' => 'write',
1506 'capabilities' => 'moodle/competency:planmanage',
1507 'ajax' => true,
1508 ),
1509 'core_competency_remove_competency_from_plan' => array(
1510 'classname' => 'core_competency\external',
1511 'methodname' => 'remove_competency_from_plan',
1512 'classpath' => '',
1513 'description' => 'Remove the competency from a learning plan',
1514 'type' => 'write',
1515 'capabilities' => 'moodle/competency:planmanage',
1516 'ajax' => true,
1517 ),
1518 'core_competency_reorder_plan_competency' => array(
1519 'classname' => 'core_competency\external',
1520 'methodname' => 'reorder_plan_competency',
1521 'classpath' => '',
1522 'description' => 'Move a plan competency to a new relative sort order.',
1523 'type' => 'write',
1524 'capabilities' => 'moodle/competency:planmanage',
1525 'ajax' => true,
1526 ),
1527 'core_competency_plan_request_review' => array(
1528 'classname' => 'core_competency\external',
1529 'methodname' => 'plan_request_review',
1530 'classpath' => '',
1531 'description' => 'Request for a plan to be reviewed.',
1532 'type' => 'write',
1533 'capabilities' => 'moodle/competency:planmanagedraft',
1534 'ajax' => true,
1535 ),
1536 'core_competency_plan_start_review' => array(
1537 'classname' => 'core_competency\external',
1538 'methodname' => 'plan_start_review',
1539 'classpath' => '',
1540 'description' => 'Start the review of a plan.',
1541 'type' => 'write',
1542 'capabilities' => 'moodle/competency:planmanage',
1543 'ajax' => true,
1544 ),
1545 'core_competency_plan_stop_review' => array(
1546 'classname' => 'core_competency\external',
1547 'methodname' => 'plan_stop_review',
1548 'classpath' => '',
1549 'description' => 'Stop the review of a plan.',
1550 'type' => 'write',
1551 'capabilities' => 'moodle/competency:planmanage',
1552 'ajax' => true,
1553 ),
1554 'core_competency_plan_cancel_review_request' => array(
1555 'classname' => 'core_competency\external',
1556 'methodname' => 'plan_cancel_review_request',
1557 'classpath' => '',
1558 'description' => 'Cancel the review of a plan.',
1559 'type' => 'write',
1560 'capabilities' => 'moodle/competency:planmanagedraft',
1561 'ajax' => true,
1562 ),
1563 'core_competency_approve_plan' => array(
1564 'classname' => 'core_competency\external',
1565 'methodname' => 'approve_plan',
1566 'classpath' => '',
1567 'description' => 'Approve a plan.',
1568 'type' => 'write',
1569 'capabilities' => 'moodle/competency:planmanage',
1570 'ajax' => true,
1571 ),
1572 'core_competency_unapprove_plan' => array(
1573 'classname' => 'core_competency\external',
1574 'methodname' => 'unapprove_plan',
1575 'classpath' => '',
1576 'description' => 'Unapprove a plan.',
1577 'type' => 'write',
1578 'capabilities' => 'moodle/competency:planmanage',
1579 'ajax' => true,
1580 ),
1581 'core_competency_template_has_related_data' => array(
1582 'classname' => 'core_competency\external',
1583 'methodname' => 'template_has_related_data',
1584 'classpath' => '',
1585 'description' => 'Check if a template has related data',
1586 'type' => 'read',
1587 'capabilities' => 'moodle/competency:templateview',
1588 'ajax' => true,
1589 ),
1590 'core_competency_get_scale_values' => array(
1591 'classname' => 'core_competency\external',
1592 'methodname' => 'get_scale_values',
1593 'classpath' => '',
1594 'description' => 'Fetch the values for a specific scale',
1595 'type' => 'read',
1596 'capabilities' => 'moodle/competency:competencymanage',
1597 'ajax' => true,
3123c2cf 1598 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
81de839f
FM
1599 ),
1600 'core_competency_add_related_competency' => array(
1601 'classname' => 'core_competency\external',
1602 'methodname' => 'add_related_competency',
1603 'classpath' => '',
1604 'description' => 'Adds a related competency',
1605 'type' => 'write',
1606 'capabilities' => 'moodle/competency:competencymanage',
1607 'ajax' => true,
1608 ),
1609 'core_competency_remove_related_competency' => array(
1610 'classname' => 'core_competency\external',
1611 'methodname' => 'remove_related_competency',
1612 'classpath' => '',
1613 'description' => 'Remove a related competency',
1614 'type' => 'write',
1615 'capabilities' => 'moodle/competency:competencymanage',
1616 'ajax' => true,
1617 ),
1618 'core_competency_read_user_evidence' => array(
1619 'classname' => 'core_competency\external',
1620 'methodname' => 'read_user_evidence',
1621 'classpath' => '',
1622 'description' => 'Read an evidence of prior learning.',
1623 'type' => 'read',
1624 'capabilities' => 'moodle/competency:userevidenceview',
1625 'ajax' => true,
1626 ),
1627 'core_competency_delete_user_evidence' => array(
1628 'classname' => 'core_competency\external',
1629 'methodname' => 'delete_user_evidence',
1630 'classpath' => '',
1631 'description' => 'Delete an evidence of prior learning.',
1632 'type' => 'write',
1633 'capabilities' => 'moodle/competency:userevidencemanageown',
1634 'ajax' => true,
1635 ),
1636 'core_competency_create_user_evidence_competency' => array(
1637 'classname' => 'core_competency\external',
1638 'methodname' => 'create_user_evidence_competency',
1639 'classpath' => '',
1640 'description' => 'Create an evidence of prior learning relationship with a competency.',
1641 'type' => 'read',
1642 'capabilities' => 'moodle/competency:userevidencemanageown, moodle/competency:competencyview',
1643 'ajax' => true,
1644 ),
1645 'core_competency_delete_user_evidence_competency' => array(
1646 'classname' => 'core_competency\external',
1647 'methodname' => 'delete_user_evidence_competency',
1648 'classpath' => '',
1649 'description' => 'Delete an evidence of prior learning relationship with a competency.',
1650 'type' => 'write',
1651 'capabilities' => 'moodle/competency:userevidencemanageown',
1652 'ajax' => true,
1653 ),
1654 'core_competency_user_competency_cancel_review_request' => array(
1655 'classname' => 'core_competency\external',
1656 'methodname' => 'user_competency_cancel_review_request',
1657 'classpath' => '',
1658 'description' => 'Cancel a review request.',
1659 'type' => 'write',
1660 'capabilities' => 'moodle/competency:userevidencemanageown',
1661 'ajax' => true,
1662 ),
1663 'core_competency_user_competency_request_review' => array(
1664 'classname' => 'core_competency\external',
1665 'methodname' => 'user_competency_request_review',
1666 'classpath' => '',
1667 'description' => 'Request a review.',
1668 'type' => 'write',
1669 'capabilities' => 'moodle/competency:userevidencemanageown',
1670 'ajax' => true,
1671 ),
1672 'core_competency_user_competency_start_review' => array(
1673 'classname' => 'core_competency\external',
1674 'methodname' => 'user_competency_start_review',
1675 'classpath' => '',
1676 'description' => 'Start a review.',
1677 'type' => 'write',
1678 'capabilities' => 'moodle/competency:competencygrade',
1679 'ajax' => true,
1680 ),
1681 'core_competency_user_competency_stop_review' => array(
1682 'classname' => 'core_competency\external',
1683 'methodname' => 'user_competency_stop_review',
1684 'classpath' => '',
1685 'description' => 'Stop a review.',
1686 'type' => 'write',
1687 'capabilities' => 'moodle/competency:competencygrade',
1688 'ajax' => true,
1689 ),
1690 'core_competency_user_competency_viewed' => array(
1691 'classname' => 'core_competency\external',
1692 'methodname' => 'user_competency_viewed',
1693 'classpath' => '',
1694 'description' => 'Log the user competency viewed event.',
1695 'type' => 'read',
1696 'capabilities' => 'moodle/competency:usercompetencyview',
1697 'ajax' => true,
3123c2cf 1698 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
81de839f
FM
1699 ),
1700 'core_competency_user_competency_viewed_in_plan' => array(
1701 'classname' => 'core_competency\external',
1702 'methodname' => 'user_competency_viewed_in_plan',
1703 'classpath' => '',
1704 'description' => 'Log the user competency viewed in plan event.',
1705 'type' => 'read',
1706 'capabilities' => 'moodle/competency:usercompetencyview',
1707 'ajax' => true,
3123c2cf 1708 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
81de839f
FM
1709 ),
1710 'core_competency_user_competency_viewed_in_course' => array(
1711 'classname' => 'core_competency\external',
1712 'methodname' => 'user_competency_viewed_in_course',
1713 'classpath' => '',
1714 'description' => 'Log the user competency viewed in course event',
1715 'type' => 'read',
1716 'capabilities' => 'moodle/competency:usercompetencyview',
1717 'ajax' => true,
3123c2cf 1718 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
81de839f
FM
1719 ),
1720 'core_competency_user_competency_plan_viewed' => array(
1721 'classname' => 'core_competency\external',
1722 'methodname' => 'user_competency_plan_viewed',
1723 'classpath' => '',
1724 'description' => 'Log the user competency plan viewed event.',
1725 'type' => 'read',
1726 'capabilities' => 'moodle/competency:usercompetencyview',
1727 'ajax' => true,
3123c2cf 1728 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
81de839f
FM
1729 ),
1730 'core_competency_grade_competency' => array(
1731 'classname' => 'core_competency\external',
1732 'methodname' => 'grade_competency',
1733 'classpath' => '',
1734 'description' => 'Grade a competency.',
1735 'type' => 'write',
1736 'capabilities' => 'moodle/competency:competencygrade',
1737 'ajax' => true,
1738 ),
1739 'core_competency_grade_competency_in_plan' => array(
1740 'classname' => 'core_competency\external',
1741 'methodname' => 'grade_competency_in_plan',
1742 'classpath' => '',
1743 'description' => 'Grade a competency from the user plan page.',
1744 'type' => 'write',
1745 'capabilities' => 'moodle/competency:competencygrade',
1746 'ajax' => true,
1747 ),
1748 'core_competency_grade_competency_in_course' => array(
1749 'classname' => 'core_competency\external',
1750 'methodname' => 'grade_competency_in_course',
1751 'classpath' => '',
1752 'description' => 'Grade a competency from the course page.',
1753 'type' => 'write',
1754 'capabilities' => 'moodle/competency:competencygrade',
1755 'ajax' => true,
3123c2cf 1756 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
81de839f
FM
1757 ),
1758 'core_competency_unlink_plan_from_template' => array(
1759 'classname' => 'core_competency\external',
1760 'methodname' => 'unlink_plan_from_template',
1761 'classpath' => '',
1762 'description' => 'Unlink a plan form it template.',
1763 'type' => 'write',
1764 'capabilities' => 'moodle/competency:planmanage',
1765 'ajax' => true,
1766 ),
1767 'core_competency_template_viewed' => array(
1768 'classname' => 'core_competency\external',
1769 'methodname' => 'template_viewed',
1770 'classpath' => '',
1771 'description' => 'Log event template viewed',
1772 'type' => 'read',
1773 'capabilities' => 'moodle/competency:templateview',
1774 'ajax' => true,
1775 ),
1776 'core_competency_request_review_of_user_evidence_linked_competencies' => array(
1777 'classname' => 'core_competency\external',
1778 'methodname' => 'request_review_of_user_evidence_linked_competencies',
1779 'classpath' => '',
1780 'description' => 'Send user evidence competencies in review',
1781 'type' => 'write',
1782 'capabilities' => 'moodle/competency:userevidencemanageown',
1783 'ajax' => true,
1784 ),
1785 'core_competency_update_course_competency_settings' => array(
1786 'classname' => 'core_competency\external',
1787 'methodname' => 'update_course_competency_settings',
1788 'classpath' => '',
1789 'description' => 'Update the course competency settings',
1790 'type' => 'write',
1791 'capabilities' => 'moodle/competency:coursecompetencyconfigure',
1792 'ajax' => true,
1793 ),
1e99f31e
FM
1794 'core_competency_delete_evidence' => array(
1795 'classname' => 'core_competency\external',
1796 'methodname' => 'delete_evidence',
1797 'classpath' => '',
1798 'description' => 'Delete an evidence',
1799 'type' => 'write',
1800 'capabilities' => 'moodle/competency:evidencedelete',
1801 'ajax' => true,
3123c2cf 1802 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
1e99f31e 1803 ),
f23e9b6b
CB
1804
1805 'core_webservice_get_site_info' => array(
1806 'classname' => 'core_webservice_external',
1807 'methodname' => 'get_site_info',
1808 'classpath' => 'webservice/externallib.php',
1809 'description' => 'Return some site info / user info / list web service functions',
1810 'type' => 'read',
ee7295ee 1811 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
f23e9b6b 1812 )
9a0df45a 1813);
c1b65883
JM
1814
1815$services = array(
96e0194c 1816 'Moodle mobile web service' => array(
12c52b91 1817 'functions' => array(), // Unused as we add the service in each function definition, third party services would use this.
96e0194c
SH
1818 'enabled' => 0,
1819 'restrictedusers' => 0,
af03513f 1820 'shortname' => MOODLE_OFFICIAL_MOBILE_SERVICE,
106c55fb
DW
1821 'downloadfiles' => 1,
1822 'uploadfiles' => 1
96e0194c
SH
1823 ),
1824);