MDL-64057 core_message: add get_conversation_counts() web service
[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 ),
b6f70a37
JL
45 'core_auth_request_password_reset' => array(
46 'classname' => 'core_auth_external',
47 'methodname' => 'request_password_reset',
48 'description' => 'Requests a password reset.',
49 'type' => 'write',
50 'ajax' => true,
51 'loginrequired' => false,
52 ),
25dbbdf9
MG
53 'core_auth_is_minor' => array(
54 'classname' => 'core_auth_external',
55 'methodname' => 'is_minor',
56 'description' => 'Requests a check if a user is a digital minor.',
57 'type' => 'read',
1f7565c1
JL
58 'ajax' => true,
59 'loginrequired' => false,
60 ),
61 'core_auth_is_age_digital_consent_verification_enabled' => array(
62 'classname' => 'core_auth_external',
63 'methodname' => 'is_age_digital_consent_verification_enabled',
64 'description' => 'Checks if age digital consent verification is enabled.',
65 'type' => 'read',
66 'ajax' => true,
25dbbdf9
MG
67 'loginrequired' => false,
68 ),
6f793705
JL
69 'core_auth_resend_confirmation_email' => array(
70 'classname' => 'core_auth_external',
71 'methodname' => 'resend_confirmation_email',
72 'description' => 'Resend confirmation email.',
73 'type' => 'write',
74 'ajax' => true,
75 'loginrequired' => false,
76 ),
f23e9b6b
CB
77 'core_badges_get_user_badges' => array(
78 'classname' => 'core_badges_external',
79 'methodname' => 'get_user_badges',
80 'description' => 'Returns the list of badges awarded to a user.',
81 'type' => 'read',
ee7295ee
JL
82 'capabilities' => 'moodle/badges:viewotherbadges',
83 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
088645e2 84 ),
bb96ff71
JL
85 'core_blog_get_entries' => array(
86 'classname' => 'core_blog\external',
87 'methodname' => 'get_entries',
88 'description' => 'Returns blog entries.',
89 'type' => 'read',
90 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
91 'ajax' => true,
92 'loginrequired' => false,
93 ),
ca48cc91
JL
94 'core_blog_view_entries' => array(
95 'classname' => 'core_blog\external',
96 'methodname' => 'view_entries',
97 'description' => 'Trigger the blog_entries_viewed event.',
98 'type' => 'read',
99 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
100 'ajax' => true,
101 'loginrequired' => false,
102 ),
695c5726
AN
103 'core_calendar_get_calendar_monthly_view' => array(
104 'classname' => 'core_calendar_external',
105 'methodname' => 'get_calendar_monthly_view',
106 'description' => 'Fetch the monthly view data for a calendar',
107 'classpath' => 'calendar/externallib.php',
3ea4f446
AN
108 'type' => 'read',
109 'capabilities' => '',
110 'ajax' => true,
111 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
112 ),
113 'core_calendar_get_calendar_day_view' => array(
114 'classname' => 'core_calendar_external',
115 'methodname' => 'get_calendar_day_view',
116 'description' => 'Fetch the day view data for a calendar',
117 'classpath' => 'calendar/externallib.php',
695c5726
AN
118 'type' => 'read',
119 'capabilities' => '',
120 'ajax' => true,
121 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
122 ),
e8306438
SL
123 'core_calendar_get_calendar_upcoming_view' => array(
124 'classname' => 'core_calendar_external',
125 'methodname' => 'get_calendar_upcoming_view',
126 'description' => 'Fetch the upcoming view data for a calendar',
127 'classpath' => 'calendar/externallib.php',
128 'type' => 'read',
129 'capabilities' => '',
130 'ajax' => true,
131 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
132 ),
c6fb9310
RW
133 'core_calendar_update_event_start_day' => array(
134 'classname' => 'core_calendar_external',
135 'methodname' => 'update_event_start_day',
136 'description' => 'Update the start day (but not time) for an event.',
137 'classpath' => 'calendar/externallib.php',
138 'type' => 'write',
139 'capabilities' => 'moodle/calendar:manageentries, moodle/calendar:manageownentries, moodle/calendar:managegroupentries',
140 'ajax' => true,
141 ),
f23e9b6b
CB
142 'core_calendar_create_calendar_events' => array(
143 'classname' => 'core_calendar_external',
144 'methodname' => 'create_calendar_events',
145 'description' => 'Create calendar events',
146 'classpath' => 'calendar/externallib.php',
147 'type' => 'write',
e453ed68
JL
148 'capabilities' => 'moodle/calendar:manageentries, moodle/calendar:manageownentries, moodle/calendar:managegroupentries',
149 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
088645e2 150 ),
f23e9b6b
CB
151 'core_calendar_delete_calendar_events' => array(
152 'classname' => 'core_calendar_external',
153 'methodname' => 'delete_calendar_events',
154 'description' => 'Delete calendar events',
155 'classpath' => 'calendar/externallib.php',
156 'type' => 'write',
e453ed68 157 'capabilities' => 'moodle/calendar:manageentries, moodle/calendar:manageownentries, moodle/calendar:managegroupentries',
542f5afa 158 'ajax' => true,
e453ed68 159 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
088645e2 160 ),
f23e9b6b
CB
161 'core_calendar_get_calendar_events' => array(
162 'classname' => 'core_calendar_external',
163 'methodname' => 'get_calendar_events',
164 'description' => 'Get calendar events',
165 'classpath' => 'calendar/externallib.php',
166 'type' => 'read',
ee7295ee
JL
167 'capabilities' => 'moodle/calendar:manageentries, moodle/calendar:manageownentries, moodle/calendar:managegroupentries',
168 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
088645e2 169 ),
c0f877fa
MN
170 'core_calendar_get_action_events_by_timesort' => array(
171 'classname' => 'core_calendar_external',
172 'methodname' => 'get_calendar_action_events_by_timesort',
173 'description' => 'Get calendar action events by tiemsort',
174 'classpath' => 'calendar/externallib.php',
175 'type' => 'read',
176 'capabilities' => 'moodle/calendar:manageentries, moodle/calendar:manageownentries, moodle/calendar:managegroupentries',
60774b28 177 'ajax' => true,
569d091b 178 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
60774b28
RW
179 ),
180 'core_calendar_get_action_events_by_course' => array(
181 'classname' => 'core_calendar_external',
182 'methodname' => 'get_calendar_action_events_by_course',
183 'description' => 'Get calendar action events by course',
184 'classpath' => 'calendar/externallib.php',
185 'type' => 'read',
186 'capabilities' => 'moodle/calendar:manageentries, moodle/calendar:manageownentries, moodle/calendar:managegroupentries',
9b8e5057 187 'ajax' => true,
569d091b 188 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
9b8e5057
RW
189 ),
190 'core_calendar_get_action_events_by_courses' => array(
191 'classname' => 'core_calendar_external',
192 'methodname' => 'get_calendar_action_events_by_courses',
193 'description' => 'Get calendar action events by courses',
194 'classpath' => 'calendar/externallib.php',
195 'type' => 'read',
196 'capabilities' => 'moodle/calendar:manageentries, moodle/calendar:manageownentries, moodle/calendar:managegroupentries',
c0f877fa 197 'ajax' => true,
569d091b 198 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
c0f877fa 199 ),
5813d1b9
SL
200 'core_calendar_get_calendar_event_by_id' => array(
201 'classname' => 'core_calendar_external',
202 'methodname' => 'get_calendar_event_by_id',
203 'description' => 'Get calendar event by id',
204 'classpath' => 'calendar/externallib.php',
205 'type' => 'read',
206 'capabilities' => 'moodle/calendar:manageentries, moodle/calendar:manageownentries, moodle/calendar:managegroupentries',
207 'ajax' => true,
208 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
209 ),
aa091225
RW
210 'core_calendar_submit_create_update_form' => array(
211 'classname' => 'core_calendar_external',
212 'methodname' => 'submit_create_update_form',
213 'description' => 'Submit form data for event form',
214 'classpath' => 'calendar/externallib.php',
215 'type' => 'write',
216 'capabilities' => 'moodle/calendar:manageentries, moodle/calendar:manageownentries, moodle/calendar:managegroupentries',
217 'ajax' => true,
218 ),
088645e2 219 'core_cohort_add_cohort_members' => array(
f23e9b6b
CB
220 'classname' => 'core_cohort_external',
221 'methodname' => 'add_cohort_members',
222 'classpath' => 'cohort/externallib.php',
088645e2 223 'description' => 'Adds cohort members.',
f23e9b6b
CB
224 'type' => 'write',
225 'capabilities' => 'moodle/cohort:assign'
226 ),
227 'core_cohort_create_cohorts' => array(
228 'classname' => 'core_cohort_external',
229 'methodname' => 'create_cohorts',
230 'classpath' => 'cohort/externallib.php',
231 'description' => 'Creates new cohorts.',
232 'type' => 'write',
233 'capabilities' => 'moodle/cohort:manage'
088645e2 234 ),
088645e2 235 'core_cohort_delete_cohort_members' => array(
f23e9b6b
CB
236 'classname' => 'core_cohort_external',
237 'methodname' => 'delete_cohort_members',
238 'classpath' => 'cohort/externallib.php',
088645e2 239 'description' => 'Deletes cohort members.',
0a4f3eb2 240 'type' => 'write',
f23e9b6b
CB
241 'capabilities' => 'moodle/cohort:assign'
242 ),
243 'core_cohort_delete_cohorts' => array(
244 'classname' => 'core_cohort_external',
245 'methodname' => 'delete_cohorts',
246 'classpath' => 'cohort/externallib.php',
247 'description' => 'Deletes all specified cohorts.',
0a4f3eb2 248 'type' => 'write',
f23e9b6b 249 'capabilities' => 'moodle/cohort:manage'
088645e2 250 ),
088645e2 251 'core_cohort_get_cohort_members' => array(
f23e9b6b
CB
252 'classname' => 'core_cohort_external',
253 'methodname' => 'get_cohort_members',
254 'classpath' => 'cohort/externallib.php',
088645e2 255 'description' => 'Returns cohort members.',
f23e9b6b
CB
256 'type' => 'read',
257 'capabilities' => 'moodle/cohort:view'
e77a0f36 258 ),
a60e8ba5
DW
259 'core_cohort_search_cohorts' => array(
260 'classname' => 'core_cohort_external',
261 'methodname' => 'search_cohorts',
262 'classpath' => 'cohort/externallib.php',
263 'description' => 'Search for cohorts.',
264 'type' => 'read',
265 'ajax' => true,
266 'capabilities' => 'moodle/cohort:view'
267 ),
f23e9b6b
CB
268 'core_cohort_get_cohorts' => array(
269 'classname' => 'core_cohort_external',
270 'methodname' => 'get_cohorts',
271 'classpath' => 'cohort/externallib.php',
272 'description' => 'Returns cohort details.',
273 'type' => 'read',
274 'capabilities' => 'moodle/cohort:view'
d3549931 275 ),
f23e9b6b
CB
276 'core_cohort_update_cohorts' => array(
277 'classname' => 'core_cohort_external',
278 'methodname' => 'update_cohorts',
279 'classpath' => 'cohort/externallib.php',
280 'description' => 'Updates existing cohorts.',
281 'type' => 'write',
282 'capabilities' => 'moodle/cohort:manage'
d3549931 283 ),
f23e9b6b
CB
284 'core_comment_get_comments' => array(
285 'classname' => 'core_comment_external',
286 'methodname' => 'get_comments',
287 'description' => 'Returns comments.',
288 'type' => 'read',
ee7295ee
JL
289 'capabilities' => 'moodle/comment:view',
290 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
5d1017e1 291 ),
f23e9b6b
CB
292 'core_completion_get_activities_completion_status' => array(
293 'classname' => 'core_completion_external',
294 'methodname' => 'get_activities_completion_status',
295 'description' => 'Return the activities completion status for a user in a course.',
296 'type' => 'read',
ee7295ee 297 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
9a0df45a 298 ),
f23e9b6b
CB
299 'core_completion_get_course_completion_status' => array(
300 'classname' => 'core_completion_external',
301 'methodname' => 'get_course_completion_status',
302 'description' => 'Returns course completion status.',
303 'type' => 'read',
ee7295ee
JL
304 'capabilities' => 'report/completion:view',
305 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
5d1017e1 306 ),
f23e9b6b
CB
307 'core_completion_mark_course_self_completed' => array(
308 'classname' => 'core_completion_external',
309 'methodname' => 'mark_course_self_completed',
310 'description' => 'Update the course completion status for the current user (if course self-completion is enabled).',
311 'type' => 'write',
ee7295ee 312 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
9a0df45a 313 ),
f23e9b6b
CB
314 'core_completion_update_activity_completion_status_manually' => array(
315 'classname' => 'core_completion_external',
316 'methodname' => 'update_activity_completion_status_manually',
317 'description' => 'Update completion status for the current user in an activity, only for activities with manual tracking.',
318 'type' => 'write',
ee7295ee 319 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
5d1017e1 320 ),
a39918da
EEAK
321 'core_completion_override_activity_completion_status' => array(
322 'classname' => 'core_completion_external',
323 'methodname' => 'override_activity_completion_status',
324 'description' => 'Update completion status for a user in an activity by overriding it.',
325 'type' => 'write',
326 'capabilities' => 'moodle/course:overridecompletion',
327 'ajax' => true,
328 ),
f23e9b6b
CB
329 'core_course_create_categories' => array(
330 'classname' => 'core_course_external',
331 'methodname' => 'create_categories',
332 'classpath' => 'course/externallib.php',
333 'description' => 'Create course categories',
334 'type' => 'write',
335 'capabilities' => 'moodle/category:manage'
246f6da2 336 ),
f23e9b6b
CB
337 'core_course_create_courses' => array(
338 'classname' => 'core_course_external',
339 'methodname' => 'create_courses',
340 'classpath' => 'course/externallib.php',
341 'description' => 'Create new courses',
342 'type' => 'write',
343 'capabilities' => 'moodle/course:create, moodle/course:visibility'
5d1017e1 344 ),
f23e9b6b
CB
345 'core_course_delete_categories' => array(
346 'classname' => 'core_course_external',
347 'methodname' => 'delete_categories',
348 'classpath' => 'course/externallib.php',
349 'description' => 'Delete course categories',
350 'type' => 'write',
351 'capabilities' => 'moodle/category:manage'
9a0df45a 352 ),
f23e9b6b
CB
353 'core_course_delete_courses' => array(
354 'classname' => 'core_course_external',
355 'methodname' => 'delete_courses',
356 'classpath' => 'course/externallib.php',
357 'description' => 'Deletes all specified courses',
358 'type' => 'write',
359 'capabilities' => 'moodle/course:delete'
5d1017e1 360 ),
f23e9b6b
CB
361 'core_course_delete_modules' => array(
362 'classname' => 'core_course_external',
363 'methodname' => 'delete_modules',
364 'classpath' => 'course/externallib.php',
365 'description' => 'Deletes all specified module instances',
366 'type' => 'write',
367 'capabilities' => 'moodle/course:manageactivities'
9a0df45a 368 ),
f23e9b6b
CB
369 'core_course_duplicate_course' => array(
370 'classname' => 'core_course_external',
371 'methodname' => 'duplicate_course',
372 'classpath' => 'course/externallib.php',
67adb4d8 373 'description' => 'Duplicate an existing course (creating a new one).',
f23e9b6b
CB
374 'type' => 'write',
375 'capabilities' => 'moodle/backup:backupcourse, moodle/restore:restorecourse, moodle/course:create'
5d1017e1 376 ),
f23e9b6b
CB
377 'core_course_get_categories' => array(
378 'classname' => 'core_course_external',
379 'methodname' => 'get_categories',
380 'classpath' => 'course/externallib.php',
381 'description' => 'Return category details',
382 'type' => 'read',
331e038b
JL
383 'capabilities' => 'moodle/category:viewhiddencategories',
384 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
9a0df45a 385 ),
f23e9b6b
CB
386 'core_course_get_contents' => array(
387 'classname' => 'core_course_external',
388 'methodname' => 'get_course_contents',
389 'classpath' => 'course/externallib.php',
390 'description' => 'Get course contents',
391 'type' => 'read',
ee7295ee
JL
392 'capabilities' => 'moodle/course:update, moodle/course:viewhiddencourses',
393 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
9a0df45a 394 ),
f23e9b6b
CB
395 'core_course_get_course_module' => array(
396 'classname' => 'core_course_external',
397 'methodname' => 'get_course_module',
398 'classpath' => 'course/externallib.php',
399 'description' => 'Return information about a course module',
400 'type' => 'read',
ee7295ee 401 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
5d1017e1 402 ),
f23e9b6b
CB
403 'core_course_get_course_module_by_instance' => array(
404 'classname' => 'core_course_external',
405 'methodname' => 'get_course_module_by_instance',
406 'classpath' => 'course/externallib.php',
407 'description' => 'Return information about a given module name and instance id',
408 'type' => 'read',
ee7295ee 409 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
7ce23590 410 ),
4529327a
MG
411 'core_course_get_module' => array(
412 'classname' => 'core_course_external',
413 'methodname' => 'get_module',
414 'classpath' => 'course/externallib.php',
415 'description' => 'Returns html with one activity module on course page',
416 'type' => 'read',
417 'ajax' => true,
418 ),
419 'core_course_edit_module' => array(
420 'classname' => 'core_course_external',
421 'methodname' => 'edit_module',
422 'classpath' => 'course/externallib.php',
423 'description' => 'Performs an action on course module (change visibility, duplicate, delete, etc.)',
424 'type' => 'write',
425 'ajax' => true,
426 ),
427 'core_course_edit_section' => array(
428 'classname' => 'core_course_external',
429 'methodname' => 'edit_section',
430 'classpath' => 'course/externallib.php',
431 'description' => 'Performs an action on course section (change visibility, set marker, delete)',
432 'type' => 'write',
433 'ajax' => true,
434 ),
f23e9b6b
CB
435 'core_course_get_courses' => array(
436 'classname' => 'core_course_external',
437 'methodname' => 'get_courses',
438 'classpath' => 'course/externallib.php',
439 'description' => 'Return course details',
440 'type' => 'read',
441 'capabilities' => 'moodle/course:view, moodle/course:update, moodle/course:viewhiddencourses',
5041600d 442 'ajax' => true,
ee7295ee 443 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
7ce23590 444 ),
f23e9b6b
CB
445 'core_course_import_course' => array(
446 'classname' => 'core_course_external',
447 'methodname' => 'import_course',
448 'classpath' => 'course/externallib.php',
449 'description' => 'Import course data from a course into another course. Does not include any user data.',
450 'type' => 'write',
451 'capabilities' => 'moodle/backup:backuptargetimport, moodle/restore:restoretargetimport'
7ce23590 452 ),
f23e9b6b
CB
453 'core_course_search_courses' => array(
454 'classname' => 'core_course_external',
455 'methodname' => 'search_courses',
456 'classpath' => 'course/externallib.php',
457 'description' => 'Search courses by (name, module, block, tag)',
458 'type' => 'read',
5041600d 459 'ajax' => true,
ee7295ee 460 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
7ce23590 461 ),
f23e9b6b
CB
462 'core_course_update_categories' => array(
463 'classname' => 'core_course_external',
464 'methodname' => 'update_categories',
465 'classpath' => 'course/externallib.php',
466 'description' => 'Update categories',
467 'type' => 'write',
468 'capabilities' => 'moodle/category:manage',
7ce23590 469 ),
f23e9b6b
CB
470 'core_course_update_courses' => array(
471 'classname' => 'core_course_external',
472 'methodname' => 'update_courses',
473 'classpath' => 'course/externallib.php',
474 'description' => 'Update courses',
475 'type' => 'write',
476 'capabilities' => 'moodle/course:update, moodle/course:changecategory, moodle/course:changefullname, '
477 . 'moodle/course:changeshortname, moodle/course:changeidnumber, moodle/course:changesummary, moodle/course:visibility'
7ce23590 478 ),
f23e9b6b
CB
479 'core_course_view_course' => array(
480 'classname' => 'core_course_external',
481 'methodname' => 'view_course',
482 'classpath' => 'course/externallib.php',
483 'description' => 'Log that the course was viewed',
484 'type' => 'write',
ee7295ee 485 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
7ce23590 486 ),
7c4e686f
JL
487 'core_course_get_activities_overview' => array(
488 'classname' => 'core_course_external',
489 'methodname' => 'get_activities_overview',
490 'classpath' => 'course/externallib.php',
e9dfeec9
MN
491 'description' => '** DEPRECATED ** Please do not call this function any more.
492 Return activities overview for the given courses.',
7c4e686f
JL
493 'type' => 'read',
494 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
495 ),
c115ff6a
JL
496 'core_course_get_user_navigation_options' => array(
497 'classname' => 'core_course_external',
498 'methodname' => 'get_user_navigation_options',
499 'classpath' => 'course/externallib.php',
500 'description' => 'Return a list of navigation options in a set of courses that are avaialable or not for the current user.',
501 'type' => 'read',
502 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
503 ),
b9050b10
JL
504 'core_course_get_user_administration_options' => array(
505 'classname' => 'core_course_external',
506 'methodname' => 'get_user_administration_options',
507 'classpath' => 'course/externallib.php',
508 'description' => 'Return a list of administration options in a set of courses that are avaialable or not for the current
509 user.',
510 'type' => 'read',
511 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
512 ),
80adabef
JL
513 'core_course_get_courses_by_field' => array(
514 'classname' => 'core_course_external',
515 'methodname' => 'get_courses_by_field',
516 'classpath' => 'course/externallib.php',
517 'description' => 'Get courses matching a specific field (id/s, shortname, idnumber, category)',
518 'type' => 'read',
519 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
520 ),
26659f62
JL
521 'core_course_check_updates' => array(
522 'classname' => 'core_course_external',
523 'methodname' => 'check_updates',
524 'classpath' => 'course/externallib.php',
525 'description' => 'Check if there is updates affecting the user for the given course and contexts.',
526 'type' => 'read',
527 'ajax' => true,
528 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
529 ),
879a8f56
JL
530 'core_course_get_updates_since' => array(
531 'classname' => 'core_course_external',
532 'methodname' => 'get_updates_since',
533 'classpath' => 'course/externallib.php',
534 'description' => 'Check if there are updates affecting the user for the given course since the given time stamp.',
535 'type' => 'read',
536 'ajax' => true,
537 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
538 ),
2c1d19fd
RW
539 'core_course_get_enrolled_courses_by_timeline_classification' => array(
540 'classname' => 'core_course_external',
541 'methodname' => 'get_enrolled_courses_by_timeline_classification',
542 'classpath' => 'course/externallib.php',
543 'description' => 'List of enrolled courses for the given timeline classification (past, inprogress, or future).',
544 'type' => 'read',
b9508423
JL
545 'ajax' => true,
546 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
2c1d19fd 547 ),
98a52c80
VD
548 'core_course_get_recent_courses' => array(
549 'classname' => 'core_course_external',
550 'methodname' => 'get_recent_courses',
551 'classpath' => 'course/externallib.php',
552 'description' => 'List of courses a user has accessed most recently.',
553 'type' => 'read',
b9508423
JL
554 'ajax' => true,
555 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
556 ),
557 'core_course_set_favourite_courses' => array(
558 'classname' => 'core_course_external',
559 'methodname' => 'set_favourite_courses',
560 'classpath' => 'course/externallib.php',
561 'description' => 'Add a list of courses to the list of favourite courses.',
562 'type' => 'read',
563 'ajax' => true,
564 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
98a52c80 565 ),
f23e9b6b
CB
566 'core_enrol_get_course_enrolment_methods' => array(
567 'classname' => 'core_enrol_external',
568 'methodname' => 'get_course_enrolment_methods',
569 'classpath' => 'enrol/externallib.php',
570 'description' => 'Get the list of course enrolment methods',
571 'type' => 'read',
ee7295ee 572 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
5d62e813 573 ),
f23e9b6b
CB
574 'core_enrol_get_enrolled_users' => array(
575 'classname' => 'core_enrol_external',
576 'methodname' => 'get_enrolled_users',
577 'classpath' => 'enrol/externallib.php',
578 'description' => 'Get enrolled users by course id.',
579 'type' => 'read',
580 'capabilities' => 'moodle/user:viewdetails, moodle/user:viewhiddendetails, moodle/course:useremail, moodle/user:update, '
ee7295ee
JL
581 . 'moodle/site:accessallgroups',
582 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
7107c2f0 583 ),
f23e9b6b
CB
584 'core_enrol_get_enrolled_users_with_capability' => array(
585 'classname' => 'core_enrol_external',
586 'methodname' => 'get_enrolled_users_with_capability',
587 'classpath' => 'enrol/externallib.php',
588 'description' => 'For each course and capability specified, return a list of the users that are enrolled in the course
589 and have that capability',
590 'type' => 'read',
c0ef63eb 591 ),
a60e8ba5
DW
592 'core_enrol_get_potential_users' => array(
593 'classname' => 'core_enrol_external',
594 'methodname' => 'get_potential_users',
595 'classpath' => 'enrol/externallib.php',
596 'description' => 'Get the list of potential users to enrol',
0fa35b1a 597 'ajax' => true,
a60e8ba5
DW
598 'type' => 'read',
599 'capabilities' => 'moodle/course:enrolreview'
600 ),
f23e9b6b
CB
601 'core_enrol_get_users_courses' => array(
602 'classname' => 'core_enrol_external',
603 'methodname' => 'get_users_courses',
604 'classpath' => 'enrol/externallib.php',
605 'description' => 'Get the list of courses where a user is enrolled in',
606 'type' => 'read',
ee7295ee
JL
607 'capabilities' => 'moodle/course:viewparticipants',
608 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
9857381d 609 ),
58c20c81
JP
610 'core_enrol_edit_user_enrolment' => array(
611 'classname' => 'core_enrol_external',
612 'methodname' => 'edit_user_enrolment',
613 'classpath' => 'enrol/externallib.php',
614 'description' => 'External function that updates a given user enrolment',
615 'type' => 'write',
616 'ajax' => true,
617 ),
c8351261
MG
618 'core_enrol_unenrol_user_enrolment' => array(
619 'classname' => 'core_enrol_external',
620 'methodname' => 'unenrol_user_enrolment',
621 'classpath' => 'enrol/externallib.php',
622 'description' => 'External function that unenrols a given user enrolment',
623 'type' => 'write',
624 'ajax' => true,
625 ),
f23e9b6b
CB
626 'core_fetch_notifications' => array(
627 'classname' => 'core_external',
628 'methodname' => 'fetch_notifications',
629 'classpath' => 'lib/external/externallib.php',
630 'description' => 'Return a list of notifications for the current session',
631 'type' => 'read',
5041600d
RT
632 'loginrequired' => false,
633 'ajax' => true,
5d1017e1 634 ),
5d1017e1 635 'core_files_get_files' => array(
f23e9b6b
CB
636 'classname' => 'core_files_external',
637 'methodname' => 'get_files',
249c4f60 638 'description' => 'browse moodle files',
f23e9b6b
CB
639 'type' => 'read',
640 'classpath' => 'files/externallib.php',
ee7295ee 641 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
5d1017e1 642 ),
5d1017e1 643 'core_files_upload' => array(
f23e9b6b
CB
644 'classname' => 'core_files_external',
645 'methodname' => 'upload',
249c4f60
DC
646 'description' => 'upload a file to moodle',
647 'type' => 'write',
648 'classpath' => 'files/externallib.php',
649 ),
8b493eb0
DM
650 'core_form_get_filetypes_browser_data' => array(
651 'classname' => 'core_form\external',
652 'methodname' => 'get_filetypes_browser_data',
653 'classpath' => '',
654 'description' => 'Provides data for the filetypes element browser.',
655 'type' => 'read',
656 'loginrequired' => false,
657 'ajax' => true,
658 ),
f23e9b6b
CB
659 'core_get_component_strings' => array(
660 'classname' => 'core_external',
661 'methodname' => 'get_component_strings',
662 'classpath' => 'lib/external/externallib.php',
faeca20d
DM
663 'description' => 'Return all raw strings (with {$a->xxx}), for a specific component ' .
664 '- similar to core get_component_strings(), call',
f23e9b6b 665 'type' => 'read',
5041600d
RT
666 'loginrequired' => false,
667 'ajax' => true,
ee7295ee 668 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
3364dbb5 669 ),
f23e9b6b
CB
670 'core_get_fragment' => array(
671 'classname' => 'core_external',
672 'methodname' => 'get_fragment',
673 'classpath' => 'lib/external/externallib.php',
674 'description' => 'Return a fragment for inclusion, such as a JavaScript page.',
675 'type' => 'read',
5041600d 676 'ajax' => true,
5d1017e1 677 ),
f23e9b6b
CB
678 'core_get_string' => array(
679 'classname' => 'core_external',
680 'methodname' => 'get_string',
681 'classpath' => 'lib/external/externallib.php',
682 'description' => 'Return a translated string - similar to core get_string(), call',
683 'type' => 'read',
5041600d
RT
684 'loginrequired' => false,
685 'ajax' => true,
be9bf94e 686 ),
f23e9b6b
CB
687 'core_get_strings' => array(
688 'classname' => 'core_external',
689 'methodname' => 'get_strings',
690 'classpath' => 'lib/external/externallib.php',
691 'description' => 'Return some translated strings - like several core get_string(), calls',
692 'type' => 'read',
5041600d
RT
693 'loginrequired' => false,
694 'ajax' => true,
5d1017e1 695 ),
88c2941b
RW
696 'core_get_user_dates' => array(
697 'classname' => 'core_external',
698 'methodname' => 'get_user_dates',
699 'classpath' => 'lib/external/externallib.php',
700 'description' => 'Return formatted timestamps',
701 'type' => 'read',
702 'ajax' => true,
703 ),
f23e9b6b
CB
704 'core_grades_get_grades' => array(
705 'classname' => 'core_grades_external',
706 'methodname' => 'get_grades',
aa7e371a
JL
707 'description' => '** DEPRECATED ** Please do not call this function any more.
708 Returns student course total grade and grades for activities.
f23e9b6b
CB
709 This function does not return category or manual items.
710 This function is suitable for managers or teachers not students.',
711 'type' => 'read',
712 'capabilities' => 'moodle/grade:view, moodle/grade:viewall, moodle/grade:viewhidden'
e9b66095 713 ),
f23e9b6b
CB
714 'core_grades_update_grades' => array(
715 'classname' => 'core_grades_external',
716 'methodname' => 'update_grades',
717 'description' => 'Update a grade item and associated student grades.',
718 'type' => 'write',
5d1017e1 719 ),
f23e9b6b
CB
720 'core_grading_get_definitions' => array(
721 'classname' => 'core_grading_external',
722 'methodname' => 'get_definitions',
723 'description' => 'Get grading definitions',
724 'type' => 'read',
e9b66095 725 ),
f23e9b6b
CB
726 'core_grading_get_gradingform_instances' => array(
727 'classname' => 'core_grading_external',
728 'methodname' => 'get_gradingform_instances',
729 'description' => 'Get grading form instances',
730 'type' => 'read',
f2229c68 731 ),
f23e9b6b
CB
732 'core_grading_save_definitions' => array(
733 'classname' => 'core_grading_external',
734 'methodname' => 'save_definitions',
735 'description' => 'Save grading definitions',
736 'type' => 'write',
5d1017e1 737 ),
f23e9b6b
CB
738 'core_group_add_group_members' => array(
739 'classname' => 'core_group_external',
740 'methodname' => 'add_group_members',
741 'classpath' => 'group/externallib.php',
742 'description' => 'Adds group members.',
743 'type' => 'write',
744 'capabilities' => 'moodle/course:managegroups',
6bb31e40 745 ),
f23e9b6b
CB
746 'core_group_assign_grouping' => array(
747 'classname' => 'core_group_external',
748 'methodname' => 'assign_grouping',
749 'classpath' => 'group/externallib.php',
750 'description' => 'Assing groups from groupings',
751 'type' => 'write',
740c354f 752 ),
f23e9b6b
CB
753 'core_group_create_groupings' => array(
754 'classname' => 'core_group_external',
755 'methodname' => 'create_groupings',
756 'classpath' => 'group/externallib.php',
757 'description' => 'Creates new groupings',
758 'type' => 'write',
5d1017e1 759 ),
f23e9b6b
CB
760 'core_group_create_groups' => array(
761 'classname' => 'core_group_external',
762 'methodname' => 'create_groups',
763 'classpath' => 'group/externallib.php',
764 'description' => 'Creates new groups.',
765 'type' => 'write',
766 'capabilities' => 'moodle/course:managegroups'
6bb31e40 767 ),
f23e9b6b
CB
768 'core_group_delete_group_members' => array(
769 'classname' => 'core_group_external',
770 'methodname' => 'delete_group_members',
771 'classpath' => 'group/externallib.php',
772 'description' => 'Deletes group members.',
0a4f3eb2 773 'type' => 'write',
f23e9b6b 774 'capabilities' => 'moodle/course:managegroups'
63a85dc7 775 ),
f23e9b6b
CB
776 'core_group_delete_groupings' => array(
777 'classname' => 'core_group_external',
778 'methodname' => 'delete_groupings',
779 'classpath' => 'group/externallib.php',
780 'description' => 'Deletes all specified groupings.',
79949c1b 781 'type' => 'write',
79949c1b 782 ),
f23e9b6b
CB
783 'core_group_delete_groups' => array(
784 'classname' => 'core_group_external',
785 'methodname' => 'delete_groups',
786 'classpath' => 'group/externallib.php',
787 'description' => 'Deletes all specified groups.',
0a4f3eb2 788 'type' => 'write',
f23e9b6b 789 'capabilities' => 'moodle/course:managegroups'
3dc1d76e 790 ),
f23e9b6b
CB
791 'core_group_get_activity_allowed_groups' => array(
792 'classname' => 'core_group_external',
793 'methodname' => 'get_activity_allowed_groups',
794 'classpath' => 'group/externallib.php',
795 'description' => 'Gets a list of groups that the user is allowed to access within the specified activity.',
796 'type' => 'read',
ee7295ee 797 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
791723c3 798 ),
f23e9b6b
CB
799 'core_group_get_activity_groupmode' => array(
800 'classname' => 'core_group_external',
801 'methodname' => 'get_activity_groupmode',
802 'classpath' => 'group/externallib.php',
803 'description' => 'Returns effective groupmode used in a given activity.',
804 'type' => 'read',
ee7295ee 805 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
c4f7bf29 806 ),
f23e9b6b
CB
807 'core_group_get_course_groupings' => array(
808 'classname' => 'core_group_external',
809 'methodname' => 'get_course_groupings',
810 'classpath' => 'group/externallib.php',
811 'description' => 'Returns all groupings in specified course.',
812 'type' => 'read',
c5158499 813 ),
f23e9b6b
CB
814 'core_group_get_course_groups' => array(
815 'classname' => 'core_group_external',
816 'methodname' => 'get_course_groups',
817 'classpath' => 'group/externallib.php',
818 'description' => 'Returns all groups in specified course.',
819 'type' => 'read',
dfc609e5 820 'ajax' => true,
f23e9b6b 821 'capabilities' => 'moodle/course:managegroups'
13bb6819 822 ),
f23e9b6b
CB
823 'core_group_get_course_user_groups' => array(
824 'classname' => 'core_group_external',
825 'methodname' => 'get_course_user_groups',
826 'classpath' => 'group/externallib.php',
827 'description' => 'Returns all groups in specified course for the specified user.',
828 'type' => 'read',
ee7295ee
JL
829 'capabilities' => 'moodle/course:managegroups',
830 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
3ec163dd 831 ),
f23e9b6b
CB
832 'core_group_get_group_members' => array(
833 'classname' => 'core_group_external',
834 'methodname' => 'get_group_members',
835 'classpath' => 'group/externallib.php',
836 'description' => 'Returns group members.',
837 'type' => 'read',
838 'capabilities' => 'moodle/course:managegroups'
479a5db1 839 ),
f23e9b6b
CB
840 'core_group_get_groupings' => array(
841 'classname' => 'core_group_external',
842 'methodname' => 'get_groupings',
843 'classpath' => 'group/externallib.php',
844 'description' => 'Returns groupings details.',
845 'type' => 'read',
3ec163dd 846 ),
f23e9b6b
CB
847 'core_group_get_groups' => array(
848 'classname' => 'core_group_external',
849 'methodname' => 'get_groups',
850 'classpath' => 'group/externallib.php',
851 'description' => 'Returns group details.',
852 'type' => 'read',
853 'capabilities' => 'moodle/course:managegroups'
2f951d86 854 ),
f23e9b6b
CB
855 'core_group_unassign_grouping' => array(
856 'classname' => 'core_group_external',
857 'methodname' => 'unassign_grouping',
858 'classpath' => 'group/externallib.php',
859 'description' => 'Unassing groups from groupings',
860 'type' => 'write',
8430d87b 861 ),
f23e9b6b
CB
862 'core_group_update_groupings' => array(
863 'classname' => 'core_group_external',
864 'methodname' => 'update_groupings',
865 'classpath' => 'group/externallib.php',
866 'description' => 'Updates existing groupings',
867 'type' => 'write',
5d1017e1 868 ),
474dd887
R
869 'core_group_update_groups' => array(
870 'classname' => 'core_group_external',
871 'methodname' => 'update_groups',
872 'classpath' => 'group/externallib.php',
873 'description' => 'Updates existing groups.',
874 'type' => 'write',
875 'capabilities' => 'moodle/course:managegroups'
876 ),
52284186
MN
877 'core_message_block_user' => array(
878 'classname' => 'core_message_external',
879 'methodname' => 'block_user',
880 'classpath' => 'message/externallib.php',
881 'description' => 'Blocks a user',
882 'type' => 'write',
883 'ajax' => true,
884 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
885 ),
f23e9b6b
CB
886 'core_message_block_contacts' => array(
887 'classname' => 'core_message_external',
888 'methodname' => 'block_contacts',
889 'classpath' => 'message/externallib.php',
0b3eadcd
MN
890 'description' => '** DEPRECATED ** Please do not call this function any more.
891 Block contacts',
f23e9b6b 892 'type' => 'write',
c6e97f54 893 'ajax' => true,
ee7295ee 894 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
a623b6b8 895 ),
d6731600 896 'core_message_create_contacts' => array(
f23e9b6b
CB
897 'classname' => 'core_message_external',
898 'methodname' => 'create_contacts',
899 'classpath' => 'message/externallib.php',
0b3eadcd
MN
900 'description' => '** DEPRECATED ** Please do not call this function any more.
901 Add contacts to the contact list',
f23e9b6b 902 'type' => 'write',
c6e97f54 903 'ajax' => true,
ee7295ee 904 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
d6731600 905 ),
52284186
MN
906 'core_message_get_contact_requests' => array(
907 'classname' => 'core_message_external',
908 'methodname' => 'get_contact_requests',
909 'classpath' => 'message/externallib.php',
910 'description' => 'Returns contact requests for a user',
911 'type' => 'read',
912 'ajax' => true,
913 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
914 ),
915 'core_message_create_contact_request' => array(
916 'classname' => 'core_message_external',
917 'methodname' => 'create_contact_request',
918 'classpath' => 'message/externallib.php',
919 'description' => 'Creates a contact request',
920 'type' => 'write',
921 'ajax' => true,
922 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
923 ),
924 'core_message_confirm_contact_request' => array(
925 'classname' => 'core_message_external',
926 'methodname' => 'confirm_contact_request',
927 'classpath' => 'message/externallib.php',
928 'description' => 'Confirms a contact request',
929 'type' => 'write',
930 'ajax' => true,
931 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
932 ),
933 'core_message_decline_contact_request' => array(
934 'classname' => 'core_message_external',
935 'methodname' => 'decline_contact_request',
936 'classpath' => 'message/externallib.php',
937 'description' => 'Declines a contact request',
938 'type' => 'write',
939 'ajax' => true,
940 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
941 ),
d6731600 942 'core_message_delete_contacts' => array(
f23e9b6b
CB
943 'classname' => 'core_message_external',
944 'methodname' => 'delete_contacts',
945 'classpath' => 'message/externallib.php',
d6731600 946 'description' => 'Remove contacts from the contact list',
f23e9b6b 947 'type' => 'write',
c6e97f54 948 'ajax' => true,
ee7295ee 949 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
d6731600 950 ),
dec0cd99
MN
951 'core_message_delete_conversation' => array(
952 'classname' => 'core_message_external',
953 'methodname' => 'delete_conversation',
954 'classpath' => 'message/externallib.php',
fa024820
MN
955 'description' => '** DEPRECATED ** Please do not call this function any more.
956 Deletes a conversation.',
dec0cd99
MN
957 'type' => 'write',
958 'capabilities' => 'moodle/site:deleteownmessage',
959 'ajax' => true,
53522c6e 960 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
dec0cd99 961 ),
60b67bbc 962 'core_message_delete_conversations_by_id' => array(
26f39c88 963 'classname' => 'core_message_external',
60b67bbc 964 'methodname' => 'delete_conversations_by_id',
26f39c88 965 'classpath' => 'message/externallib.php',
60b67bbc 966 'description' => 'Deletes a list of conversations.',
26f39c88
MN
967 'type' => 'write',
968 'capabilities' => 'moodle/site:deleteownmessage',
969 'ajax' => true,
970 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
971 ),
f23e9b6b
CB
972 'core_message_delete_message' => array(
973 'classname' => 'core_message_external',
974 'methodname' => 'delete_message',
975 'classpath' => 'message/externallib.php',
976 'description' => 'Deletes a message.',
977 'type' => 'write',
ee7295ee 978 'capabilities' => 'moodle/site:deleteownmessage',
3090f52f 979 'ajax' => true,
ee7295ee 980 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
d6731600 981 ),
f23e9b6b
CB
982 'core_message_get_blocked_users' => array(
983 'classname' => 'core_message_external',
984 'methodname' => 'get_blocked_users',
985 'classpath' => 'message/externallib.php',
986 'description' => 'Retrieve a list of users blocked',
987 'type' => 'read',
ee7295ee 988 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
d6731600 989 ),
cd03b8d7
MN
990 'core_message_data_for_messagearea_search_messages' => array(
991 'classname' => 'core_message_external',
992 'methodname' => 'data_for_messagearea_search_messages',
993 'classpath' => 'message/externallib.php',
994 'description' => 'Retrieve the template data for searching for messages',
995 'type' => 'read',
996 'ajax' => true,
53522c6e 997 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
cd03b8d7 998 ),
48e8bdba 999 'core_message_data_for_messagearea_search_users' => array(
cd03b8d7 1000 'classname' => 'core_message_external',
48e8bdba 1001 'methodname' => 'data_for_messagearea_search_users',
cd03b8d7 1002 'classpath' => 'message/externallib.php',
548cac7d
AA
1003 'description' => '** DEPRECATED ** Please do not call this function any more.
1004 Retrieve the template data for searching for people',
cd03b8d7
MN
1005 'type' => 'read',
1006 'ajax' => true,
1007 ),
48e8bdba 1008 'core_message_data_for_messagearea_search_users_in_course' => array(
cd03b8d7 1009 'classname' => 'core_message_external',
48e8bdba 1010 'methodname' => 'data_for_messagearea_search_users_in_course',
cd03b8d7 1011 'classpath' => 'message/externallib.php',
548cac7d
AA
1012 'description' => '** DEPRECATED ** Please do not call this function any more.
1013 Retrieve the template data for searching for people in a course',
1014 'type' => 'read',
1015 'ajax' => true,
1016 ),
1017 'core_message_message_search_users' => array(
1018 'classname' => 'core_message_external',
1019 'methodname' => 'message_search_users',
1020 'classpath' => 'message/externallib.php',
1021 'description' => 'Retrieve the data for searching for people',
cd03b8d7
MN
1022 'type' => 'read',
1023 'ajax' => true,
548cac7d 1024 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
cd03b8d7 1025 ),
9aa012b5
MN
1026 'core_message_data_for_messagearea_conversations' => array(
1027 'classname' => 'core_message_external',
1028 'methodname' => 'data_for_messagearea_conversations',
1029 'classpath' => 'message/externallib.php',
eb35e0b1
JD
1030 'description' => '** DEPRECATED ** Please do not call this function any more.
1031 Retrieve the template data for the conversation list',
9aa012b5
MN
1032 'type' => 'read',
1033 'ajax' => true,
21d9f020 1034 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
9aa012b5
MN
1035 ),
1036 'core_message_data_for_messagearea_contacts' => array(
1037 'classname' => 'core_message_external',
1038 'methodname' => 'data_for_messagearea_contacts',
1039 'classpath' => 'message/externallib.php',
a6049a79
MN
1040 'description' => '** DEPRECATED ** Please do not call this function any more.
1041 Retrieve the template data for the contact list',
9aa012b5
MN
1042 'type' => 'read',
1043 'ajax' => true,
21d9f020 1044 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
9aa012b5 1045 ),
3cd13828
MN
1046 'core_message_data_for_messagearea_messages' => array(
1047 'classname' => 'core_message_external',
1048 'methodname' => 'data_for_messagearea_messages',
1049 'classpath' => 'message/externallib.php',
a6049a79
MN
1050 'description' => '** DEPRECATED ** Please do not call this function any more.
1051 Retrieve the template data for the messages',
3cd13828
MN
1052 'type' => 'read',
1053 'ajax' => true,
21d9f020 1054 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
3cd13828 1055 ),
c060cd49
MN
1056 'core_message_data_for_messagearea_get_most_recent_message' => array(
1057 'classname' => 'core_message_external',
1058 'methodname' => 'data_for_messagearea_get_most_recent_message',
1059 'classpath' => 'message/externallib.php',
a6049a79
MN
1060 'description' => '** DEPRECATED ** Please do not call this function any more.
1061 Retrieve the template data for the most recent message',
c060cd49
MN
1062 'type' => 'read',
1063 'ajax' => true,
1064 ),
c6e97f54
MN
1065 'core_message_data_for_messagearea_get_profile' => array(
1066 'classname' => 'core_message_external',
1067 'methodname' => 'data_for_messagearea_get_profile',
1068 'classpath' => 'message/externallib.php',
a6049a79
MN
1069 'description' => '** DEPRECATED ** Please do not call this function any more.
1070 Retrieve the template data for the users\'s profile',
c6e97f54
MN
1071 'type' => 'read',
1072 'ajax' => true,
1073 ),
d6731600 1074 'core_message_get_contacts' => array(
f23e9b6b
CB
1075 'classname' => 'core_message_external',
1076 'methodname' => 'get_contacts',
1077 'classpath' => 'message/externallib.php',
d6731600 1078 'description' => 'Retrieve the contact list',
f23e9b6b 1079 'type' => 'read',
6f31927a
JD
1080 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
1081 ),
1082 'core_message_get_conversations' => array(
1083 'classname' => 'core_message_external',
1084 'methodname' => 'get_conversations',
1085 'classpath' => 'message/externallib.php',
1086 'description' => 'Retrieve a list of conversations for a user',
1087 'type' => 'read',
ee7295ee 1088 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
b3bbd4a0 1089 'ajax' => true
d6731600 1090 ),
4e313026
RW
1091 'core_message_get_conversation' => array(
1092 'classname' => 'core_message_external',
1093 'methodname' => 'get_conversation',
1094 'classpath' => 'message/externallib.php',
1095 'description' => 'Retrieve a conversation for a user',
1096 'type' => 'read',
569c0bae
RW
1097 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
1098 'ajax' => true
1099 ),
1100 'core_message_get_conversation_between_users' => array(
1101 'classname' => 'core_message_external',
1102 'methodname' => 'get_conversation_between_users',
1103 'classpath' => 'message/externallib.php',
1104 'description' => 'Retrieve a conversation for a user between another user',
1105 'type' => 'read',
4e313026
RW
1106 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
1107 'ajax' => true
1108 ),
aff9da17 1109 'core_message_get_messages' => array(
f23e9b6b
CB
1110 'classname' => 'core_message_external',
1111 'methodname' => 'get_messages',
1112 'classpath' => 'message/externallib.php',
1113 'description' => 'Retrieve a list of messages sent and received by a user (conversations, notifications or both)',
1114 'type' => 'read',
ee7295ee 1115 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
3274d5ca
RW
1116 'ajax' => true,
1117 ),
28ff6ad1
JD
1118 'core_message_get_conversation_counts' => array(
1119 'classname' => 'core_message_external',
1120 'methodname' => 'get_conversation_counts',
1121 'classpath' => 'message/externallib.php',
1122 'description' => 'Retrieve a list of conversation counts, indexed by type.',
1123 'type' => 'read',
1124 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
1125 'ajax' => true,
1126 ),
5584c48a
MN
1127 'core_message_get_conversation_members' => array(
1128 'classname' => 'core_message_external',
1129 'methodname' => 'get_conversation_members',
1130 'classpath' => 'message/externallib.php',
1131 'description' => 'Retrieve a list of members in a conversation',
1132 'type' => 'read',
1133 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
1134 'ajax' => true,
1135 ),
8350978a
RW
1136 'core_message_get_member_info' => array(
1137 'classname' => 'core_message_external',
1138 'methodname' => 'get_member_info',
1139 'classpath' => 'message/externallib.php',
1140 'description' => 'Retrieve a user message profiles',
1141 'type' => 'read',
1142 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
1143 'ajax' => true,
1144 ),
8c55bd6c
RW
1145 'core_message_get_unread_conversations_count' => array(
1146 'classname' => 'core_message_external',
1147 'methodname' => 'get_unread_conversations_count',
1148 'classpath' => 'message/externallib.php',
1149 'description' => 'Retrieve the count of unread conversations for a given user',
1150 'type' => 'read',
1151 'ajax' => true,
53522c6e 1152 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
8c55bd6c 1153 ),
3274d5ca
RW
1154 'core_message_mark_all_notifications_as_read' => array(
1155 'classname' => 'core_message_external',
1156 'methodname' => 'mark_all_notifications_as_read',
1157 'classpath' => 'message/externallib.php',
8c55bd6c
RW
1158 'description' => 'Mark all notifications as read for a given user',
1159 'type' => 'write',
1160 'ajax' => true,
53522c6e 1161 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
8c55bd6c
RW
1162 ),
1163 'core_message_mark_all_messages_as_read' => array(
1164 'classname' => 'core_message_external',
1165 'methodname' => 'mark_all_messages_as_read',
1166 'classpath' => 'message/externallib.php',
e4c30994
MN
1167 'description' => '** DEPRECATED ** Please do not call this function any more.
1168 Mark all messages as read for a given user',
3274d5ca
RW
1169 'type' => 'write',
1170 'ajax' => true,
53522c6e 1171 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
60ab2e1b 1172 ),
09ec5017
MN
1173 'core_message_mark_all_conversation_messages_as_read' => array(
1174 'classname' => 'core_message_external',
1175 'methodname' => 'mark_all_conversation_messages_as_read',
1176 'classpath' => 'message/externallib.php',
1177 'description' => 'Mark all conversation messages as read for a given user',
3274d5ca
RW
1178 'type' => 'write',
1179 'ajax' => true,
53522c6e 1180 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
60ab2e1b 1181 ),
a84f89ca 1182 'core_message_mark_message_read' => array(
f23e9b6b
CB
1183 'classname' => 'core_message_external',
1184 'methodname' => 'mark_message_read',
1185 'classpath' => 'message/externallib.php',
1186 'description' => 'Mark a single message as read, trigger message_viewed event.',
1187 'type' => 'write',
ee7295ee 1188 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
0b19d048 1189 'ajax' => true,
a84f89ca 1190 ),
2b595d96
MN
1191 'core_message_mark_notification_read' => array(
1192 'classname' => 'core_message_external',
1193 'methodname' => 'mark_notification_read',
1194 'classpath' => 'message/externallib.php',
1195 'description' => 'Mark a single notification as read, trigger notification_viewed event.',
1196 'type' => 'write',
1197 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
1198 'ajax' => true,
1199 ),
a0eabdd3
RW
1200 'core_message_message_processor_config_form' => array(
1201 'classname' => 'core_message_external',
1202 'methodname' => 'message_processor_config_form',
1203 'classpath' => 'message/externallib.php',
1204 'description' => 'Process the message processor config form',
1205 'type' => 'write',
1206 'ajax' => true,
53522c6e 1207 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
a0eabdd3 1208 ),
8c125526
RW
1209 'core_message_get_message_processor' => array(
1210 'classname' => 'core_message_external',
1211 'methodname' => 'get_message_processor',
1212 'classpath' => 'message/externallib.php',
1213 'description' => 'Get a message processor',
1214 'type' => 'read',
1215 'ajax' => true,
1216 ),
f23e9b6b
CB
1217 'core_message_search_contacts' => array(
1218 'classname' => 'core_message_external',
1219 'methodname' => 'search_contacts',
1220 'classpath' => 'message/externallib.php',
1221 'description' => 'Search for contacts',
1222 'type' => 'read',
ee7295ee 1223 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
419b1128 1224 ),
f23e9b6b
CB
1225 'core_message_send_instant_messages' => array(
1226 'classname' => 'core_message_external',
1227 'methodname' => 'send_instant_messages',
1228 'classpath' => 'message/externallib.php',
1229 'description' => 'Send instant messages',
1230 'type' => 'write',
ee7295ee 1231 'capabilities' => 'moodle/site:sendmessage',
c060cd49 1232 'ajax' => true,
ee7295ee 1233 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
f23e9b6b 1234 ),
2553e9db
JD
1235 'core_message_send_messages_to_conversation' => array(
1236 'classname' => 'core_message_external',
1237 'methodname' => 'send_messages_to_conversation',
1238 'classpath' => 'message/externallib.php',
1239 'description' => 'Send messages to an existing conversation between users',
1240 'type' => 'write',
1241 'capabilities' => 'moodle/site:sendmessage',
1242 'ajax' => true,
1243 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
1244 ),
fb04293b
SA
1245 'core_message_get_conversation_messages' => array(
1246 'classname' => 'core_message_external',
1247 'methodname' => 'get_conversation_messages',
1248 'classpath' => 'message/externallib.php',
1249 'description' => 'Retrieve the conversation messages and relevant member information',
1250 'type' => 'read',
1251 'ajax' => true,
1252 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
1253 ),
52284186
MN
1254 'core_message_unblock_user' => array(
1255 'classname' => 'core_message_external',
1256 'methodname' => 'unblock_user',
1257 'classpath' => 'message/externallib.php',
1258 'description' => 'Unblocks a user',
1259 'type' => 'write',
1260 'ajax' => true,
1261 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
1262 ),
f23e9b6b
CB
1263 'core_message_unblock_contacts' => array(
1264 'classname' => 'core_message_external',
1265 'methodname' => 'unblock_contacts',
1266 'classpath' => 'message/externallib.php',
0b3eadcd
MN
1267 'description' => '** DEPRECATED ** Please do not call this function any more.
1268 Unblock contacts',
f23e9b6b 1269 'type' => 'write',
c6e97f54 1270 'ajax' => true,
ee7295ee 1271 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
5d1017e1 1272 ),
e86f0cb4
JL
1273 'core_message_get_user_notification_preferences' => array(
1274 'classname' => 'core_message_external',
1275 'methodname' => 'get_user_notification_preferences',
1276 'classpath' => 'message/externallib.php',
1277 'description' => 'Get the notification preferences for a given user.',
1278 'type' => 'read',
1279 'capabilities' => 'moodle/user:editownmessageprofile',
1280 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
1281 ),
2521afd2
JL
1282 'core_message_get_user_message_preferences' => array(
1283 'classname' => 'core_message_external',
1284 'methodname' => 'get_user_message_preferences',
1285 'classpath' => 'message/externallib.php',
1286 'description' => 'Get the message preferences for a given user.',
1287 'type' => 'read',
1288 'capabilities' => 'moodle/user:editownmessageprofile',
1289 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
1290 ),
5b367bae
JD
1291 'core_message_set_favourite_conversations' => array(
1292 'classname' => 'core_message_external',
1293 'methodname' => 'set_favourite_conversations',
1294 'classpath' => 'message/externallib.php',
1295 'description' => 'Mark a conversation or group of conversations as favourites/starred conversations.',
1296 'type' => 'write',
9e189a91 1297 'ajax' => true,
5b367bae
JD
1298 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
1299 ),
1300 'core_message_unset_favourite_conversations' => array(
1301 'classname' => 'core_message_external',
1302 'methodname' => 'unset_favourite_conversations',
1303 'classpath' => 'message/externallib.php',
1304 'description' => 'Unset a conversation or group of conversations as favourites/starred conversations.',
1305 'type' => 'write',
9e189a91 1306 'ajax' => true,
5b367bae
JD
1307 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
1308 ),
5d1017e1 1309 'core_notes_create_notes' => array(
f23e9b6b
CB
1310 'classname' => 'core_notes_external',
1311 'methodname' => 'create_notes',
1312 'classpath' => 'notes/externallib.php',
8d46dabb 1313 'description' => 'Create notes',
f23e9b6b 1314 'type' => 'write',
b5b81de3 1315 'ajax' => true,
ee7295ee
JL
1316 'capabilities' => 'moodle/notes:manage',
1317 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
8d46dabb 1318 ),
34348b2b 1319 'core_notes_delete_notes' => array(
f23e9b6b
CB
1320 'classname' => 'core_notes_external',
1321 'methodname' => 'delete_notes',
1322 'classpath' => 'notes/externallib.php',
34348b2b 1323 'description' => 'Delete notes',
f23e9b6b 1324 'type' => 'write',
ee7295ee
JL
1325 'capabilities' => 'moodle/notes:manage',
1326 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
f23e9b6b
CB
1327 ),
1328 'core_notes_get_course_notes' => array(
1329 'classname' => 'core_notes_external',
1330 'methodname' => 'get_course_notes',
1331 'classpath' => 'notes/externallib.php',
1332 'description' => 'Returns all notes in specified course (or site), for the specified user.',
1333 'type' => 'read',
ee7295ee
JL
1334 'capabilities' => 'moodle/notes:view',
1335 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
34348b2b 1336 ),
34348b2b 1337 'core_notes_get_notes' => array(
f23e9b6b
CB
1338 'classname' => 'core_notes_external',
1339 'methodname' => 'get_notes',
1340 'classpath' => 'notes/externallib.php',
34348b2b 1341 'description' => 'Get notes',
f23e9b6b
CB
1342 'type' => 'read',
1343 'capabilities' => 'moodle/notes:view'
34348b2b 1344 ),
34348b2b 1345 'core_notes_update_notes' => array(
f23e9b6b
CB
1346 'classname' => 'core_notes_external',
1347 'methodname' => 'update_notes',
1348 'classpath' => 'notes/externallib.php',
34348b2b 1349 'description' => 'Update notes',
f23e9b6b
CB
1350 'type' => 'write',
1351 'capabilities' => 'moodle/notes:manage'
34348b2b 1352 ),
a80b5518 1353 'core_notes_view_notes' => array(
f23e9b6b
CB
1354 'classname' => 'core_notes_external',
1355 'methodname' => 'view_notes',
1356 'classpath' => 'notes/externallib.php',
1357 'description' => 'Simulates the web interface view of notes/index.php: trigger events.',
1358 'type' => 'write',
ee7295ee
JL
1359 'capabilities' => 'moodle/notes:view',
1360 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
9028d9b5 1361 ),
f23e9b6b
CB
1362 'core_output_load_template' => array(
1363 'classname' => 'core\output\external',
1364 'methodname' => 'load_template',
1365 'description' => 'Load a template for a renderable',
1366 'type' => 'read',
5041600d
RT
1367 'loginrequired' => false,
1368 'ajax' => true,
0ff4ebb4 1369 ),
e330b1c2 1370 'core_output_load_fontawesome_icon_map' => array(
a26ce248 1371 'classname' => 'core\output\external',
e330b1c2 1372 'methodname' => 'load_fontawesome_icon_map',
a26ce248
DW
1373 'description' => 'Load the mapping of names to icons',
1374 'type' => 'read',
1375 'loginrequired' => false,
1376 'ajax' => true,
1377 ),
f23e9b6b
CB
1378 // Question related functions.
1379 'core_question_update_flag' => array(
1380 'classname' => 'core_question_external',
1381 'methodname' => 'update_flag',
1382 'description' => 'Update the flag state of a question attempt.',
1383 'type' => 'write',
1384 'capabilities' => 'moodle/question:flag',
ee7295ee 1385 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
3f0ea6d8 1386 ),
680d5c5b
SL
1387 'core_question_submit_tags_form' => array(
1388 'classname' => 'core_question_external',
1389 'methodname' => 'submit_tags_form',
1390 'description' => 'Update the question tags.',
1391 'type' => 'write',
1392 'ajax' => true,
1393 ),
6768729e
RW
1394 'core_question_get_random_question_summaries' => array(
1395 'classname' => 'core_question_external',
1396 'methodname' => 'get_random_question_summaries',
1397 'description' => 'Get the random question set for a criteria',
1398 'type' => 'read',
1399 'ajax' => true,
1400 ),
f23e9b6b
CB
1401 'core_rating_get_item_ratings' => array(
1402 'classname' => 'core_rating_external',
1403 'methodname' => 'get_item_ratings',
1404 'description' => 'Retrieve all the ratings for an item.',
1405 'type' => 'read',
ee7295ee
JL
1406 'capabilities' => 'moodle/rating:view',
1407 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
5d1017e1 1408 ),
afb7799a
JL
1409 'core_rating_add_rating' => array(
1410 'classname' => 'core_rating_external',
1411 'methodname' => 'add_rating',
1412 'description' => 'Rates an item.',
1413 'type' => 'write',
1414 'capabilities' => 'moodle/rating:rate',
1415 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
1416 ),
f23e9b6b
CB
1417 'core_role_assign_roles' => array(
1418 'classname' => 'core_role_external',
1419 'methodname' => 'assign_roles',
1420 'classpath' => 'enrol/externallib.php',
1421 'description' => 'Manual role assignments.',
1422 'type' => 'write',
1423 'capabilities' => 'moodle/role:assign'
0bf486a6 1424 ),
f23e9b6b
CB
1425 'core_role_unassign_roles' => array(
1426 'classname' => 'core_role_external',
1427 'methodname' => 'unassign_roles',
1428 'classpath' => 'enrol/externallib.php',
1429 'description' => 'Manual role unassignments.',
1430 'type' => 'write',
1431 'capabilities' => 'moodle/role:assign'
11e76602 1432 ),
a6cacdd2 1433 'core_search_get_relevant_users' => array(
1434 'classname' => '\core_search\external',
1435 'methodname' => 'get_relevant_users',
1436 'description' => 'Gets relevant users for a search request.',
1437 'type' => 'read',
1438 'ajax' => true
1439 ),
f23e9b6b
CB
1440 'core_tag_get_tagindex' => array(
1441 'classname' => 'core_tag_external',
1442 'methodname' => 'get_tagindex',
1443 'description' => 'Gets tag index page for one tag and one tag area',
1444 'type' => 'read',
5041600d 1445 'ajax' => true,
11e76602 1446 ),
f23e9b6b
CB
1447 'core_tag_get_tags' => array(
1448 'classname' => 'core_tag_external',
1449 'methodname' => 'get_tags',
1450 'description' => 'Gets tags by their ids',
1451 'type' => 'read',
5041600d 1452 'ajax' => true,
11e76602 1453 ),
f23e9b6b
CB
1454 'core_tag_update_tags' => array(
1455 'classname' => 'core_tag_external',
1456 'methodname' => 'update_tags',
1457 'description' => 'Updates tags',
1458 'type' => 'write',
5041600d 1459 'ajax' => true,
cc73ea07 1460 ),
cdc5f978 1461 'core_update_inplace_editable' => array(
f23e9b6b
CB
1462 'classname' => 'core_external',
1463 'methodname' => 'update_inplace_editable',
1464 'classpath' => 'lib/external/externallib.php',
cdc5f978 1465 'description' => 'Generic service to update title',
f23e9b6b 1466 'type' => 'write',
5041600d
RT
1467 'loginrequired' => true,
1468 'ajax' => true,
c66dc3df 1469 ),
f23e9b6b
CB
1470 'core_user_add_user_device' => array(
1471 'classname' => 'core_user_external',
1472 'methodname' => 'add_user_device',
1473 'classpath' => 'user/externallib.php',
1474 'description' => 'Store mobile user devices information for PUSH Notifications.',
1475 'type' => 'write',
ee7295ee 1476 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
9bdcf579 1477 ),
f23e9b6b
CB
1478 'core_user_add_user_private_files' => array(
1479 'classname' => 'core_user_external',
1480 'methodname' => 'add_user_private_files',
1481 'classpath' => 'user/externallib.php',
1482 'description' => 'Copy files from a draft area to users private files area.',
1483 'type' => 'write',
ee7295ee
JL
1484 'capabilities' => 'moodle/user:manageownfiles',
1485 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
25c49a85 1486 ),
f23e9b6b
CB
1487 'core_user_create_users' => array(
1488 'classname' => 'core_user_external',
1489 'methodname' => 'create_users',
1490 'classpath' => 'user/externallib.php',
1491 'description' => 'Create users.',
1492 'type' => 'write',
1493 'capabilities' => 'moodle/user:create'
23b398fc 1494 ),
f23e9b6b
CB
1495 'core_user_delete_users' => array(
1496 'classname' => 'core_user_external',
1497 'methodname' => 'delete_users',
1498 'classpath' => 'user/externallib.php',
1499 'description' => 'Delete users.',
1500 'type' => 'write',
1501 'capabilities' => 'moodle/user:delete'
6c785afa 1502 ),
f23e9b6b
CB
1503 'core_user_get_course_user_profiles' => array(
1504 'classname' => 'core_user_external',
1505 'methodname' => 'get_course_user_profiles',
1506 'classpath' => 'user/externallib.php',
1507 'description' => 'Get course user profiles (each of the profils matching a course id and a user id),.',
1508 'type' => 'read',
1509 'capabilities' => 'moodle/user:viewdetails, moodle/user:viewhiddendetails, moodle/course:useremail, moodle/user:update, '
ee7295ee
JL
1510 . 'moodle/site:accessallgroups',
1511 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
6c785afa 1512 ),
f23e9b6b
CB
1513 'core_user_get_users' => array(
1514 'classname' => 'core_user_external',
1515 'methodname' => 'get_users',
1516 'classpath' => 'user/externallib.php',
1517 'description' => 'search for users matching the parameters',
1518 'type' => 'read',
1519 'capabilities' => 'moodle/user:viewdetails, moodle/user:viewhiddendetails, moodle/course:useremail, moodle/user:update'
db5b6971 1520 ),
f23e9b6b
CB
1521 'core_user_get_users_by_field' => array(
1522 'classname' => 'core_user_external',
1523 'methodname' => 'get_users_by_field',
1524 'classpath' => 'user/externallib.php',
1525 'description' => 'Retrieve users\' information for a specified unique field - If you want to do a user search, use '
1526 . 'core_user_get_users()',
1527 'type' => 'read',
ee7295ee 1528 'capabilities' => 'moodle/user:viewdetails, moodle/user:viewhiddendetails, moodle/course:useremail, moodle/user:update',
5041600d 1529 'ajax' => true,
ee7295ee 1530 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
8e355853 1531 ),
f23e9b6b
CB
1532 'core_user_remove_user_device' => array(
1533 'classname' => 'core_user_external',
1534 'methodname' => 'remove_user_device',
1535 'classpath' => 'user/externallib.php',
1536 'description' => 'Remove a user device from the Moodle database.',
1537 'type' => 'write',
ee7295ee 1538 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
ef4c23cc 1539 ),
c598f278 1540 'core_user_update_users' => array(
a0eabdd3 1541 'classname' => 'core_user_external',
c598f278 1542 'methodname' => 'update_users',
a0eabdd3 1543 'classpath' => 'user/externallib.php',
c598f278 1544 'description' => 'Update users.',
a0eabdd3
RW
1545 'type' => 'write',
1546 'capabilities' => 'moodle/user:update',
1547 'ajax' => true,
1548 ),
c598f278 1549 'core_user_update_user_preferences' => array(
f23e9b6b 1550 'classname' => 'core_user_external',
c598f278 1551 'methodname' => 'update_user_preferences',
f23e9b6b 1552 'classpath' => 'user/externallib.php',
c598f278 1553 'description' => 'Update a user\'s preferences',
f23e9b6b 1554 'type' => 'write',
c598f278 1555 'capabilities' => 'moodle/user:editownmessageprofile, moodle/user:editmessageprofile',
a0eabdd3 1556 'ajax' => true,
6d2f938c 1557 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
c026a28d 1558 ),
f23e9b6b
CB
1559 'core_user_view_user_list' => array(
1560 'classname' => 'core_user_external',
1561 'methodname' => 'view_user_list',
1562 'classpath' => 'user/externallib.php',
1563 'description' => 'Simulates the web-interface view of user/index.php (triggering events),.',
1564 'type' => 'write',
1565 'capabilities' => 'moodle/course:viewparticipants',
ee7295ee 1566 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
7361b968 1567 ),
f23e9b6b
CB
1568 'core_user_view_user_profile' => array(
1569 'classname' => 'core_user_external',
1570 'methodname' => 'view_user_profile',
1571 'classpath' => 'user/externallib.php',
1572 'description' => 'Simulates the web-interface view of user/view.php and user/profile.php (triggering events),.',
1573 'type' => 'write',
1574 'capabilities' => 'moodle/user:viewdetails',
ee7295ee 1575 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
f4fb827e 1576 ),
45fec983
JL
1577 'core_user_get_user_preferences' => array(
1578 'classname' => 'core_user_external',
1579 'methodname' => 'get_user_preferences',
1580 'classpath' => 'user/externallib.php',
1581 'description' => 'Return user preferences.',
1582 'type' => 'read',
5005d8cf 1583 'ajax' => true,
45fec983
JL
1584 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
1585 ),
d44e2e42
JL
1586 'core_user_update_picture' => array(
1587 'classname' => 'core_user_external',
1588 'methodname' => 'update_picture',
1589 'classpath' => 'user/externallib.php',
1590 'description' => 'Update or delete the user picture in the site',
1591 'type' => 'write',
1592 'capabilities' => 'moodle/user:editownprofile, moodle/user:editprofile',
1593 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
1594 ),
649777fb
JL
1595 'core_user_set_user_preferences' => array(
1596 'classname' => 'core_user_external',
1597 'methodname' => 'set_user_preferences',
1598 'classpath' => 'user/externallib.php',
1599 'description' => 'Set user preferences.',
1600 'type' => 'write',
1601 'capabilities' => 'moodle/site:config',
2979ca11
JL
1602 'ajax' => true,
1603 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
649777fb 1604 ),
3e8145a3
JL
1605 'core_user_agree_site_policy' => array(
1606 'classname' => 'core_user_external',
1607 'methodname' => 'agree_site_policy',
1608 'classpath' => 'user/externallib.php',
1609 'description' => 'Agree the site policy for the current user.',
1610 'type' => 'write',
1611 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
1612 ),
f74ac6e7
JL
1613 'core_user_get_private_files_info' => array(
1614 'classname' => 'core_user_external',
1615 'methodname' => 'get_private_files_info',
1616 'classpath' => 'user/externallib.php',
1617 'description' => 'Returns general information about files in the user private files area.',
1618 'type' => 'read',
1619 'capabilities' => 'moodle/user:manageownfiles',
1620 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
1621 ),
649777fb 1622
81de839f
FM
1623 // Competencies functions.
1624 'core_competency_create_competency_framework' => array(
1625 'classname' => 'core_competency\external',
1626 'methodname' => 'create_competency_framework',
1627 'classpath' => '',
1628 'description' => 'Creates new competency frameworks.',
1629 'type' => 'write',
1630 'capabilities' => 'moodle/competency:competencymanage',
1631 'ajax' => true,
1632 ),
1633 'core_competency_read_competency_framework' => array(
1634 'classname' => 'core_competency\external',
1635 'methodname' => 'read_competency_framework',
1636 'classpath' => '',
1637 'description' => 'Load a summary of a competency framework.',
1638 'type' => 'read',
1639 'capabilities' => 'moodle/competency:competencyview',
1640 'ajax' => true,
1641 ),
1642 'core_competency_duplicate_competency_framework' => array(
1643 'classname' => 'core_competency\external',
1644 'methodname' => 'duplicate_competency_framework',
1645 'classpath' => '',
1646 'description' => 'Duplicate a competency framework.',
1647 'type' => 'write',
1648 'capabilities' => 'moodle/competency:competencymanage',
1649 'ajax' => true,
1650 ),
1651 'core_competency_delete_competency_framework' => array(
1652 'classname' => 'core_competency\external',
1653 'methodname' => 'delete_competency_framework',
1654 'classpath' => '',
1655 'description' => 'Delete a competency framework.',
1656 'type' => 'write',
1657 'capabilities' => 'moodle/competency:competencymanage',
1658 'ajax' => true,
1659 ),
1660 'core_competency_update_competency_framework' => array(
1661 'classname' => 'core_competency\external',
1662 'methodname' => 'update_competency_framework',
1663 'classpath' => '',
1664 'description' => 'Update a competency framework.',
1665 'type' => 'write',
1666 'capabilities' => 'moodle/competency:competencymanage',
1667 'ajax' => true,
1668 ),
1669 'core_competency_list_competency_frameworks' => array(
1670 'classname' => 'core_competency\external',
1671 'methodname' => 'list_competency_frameworks',
1672 'classpath' => '',
1673 'description' => 'Load a list of a competency frameworks.',
1674 'type' => 'read',
1675 'capabilities' => 'moodle/competency:competencyview',
1676 'ajax' => true,
1677 ),
1678 'core_competency_count_competency_frameworks' => array(
1679 'classname' => 'core_competency\external',
1680 'methodname' => 'count_competency_frameworks',
1681 'classpath' => '',
1682 'description' => 'Count a list of a competency frameworks.',
1683 'type' => 'read',
1684 'capabilities' => 'moodle/competency:competencyview',
1685 'ajax' => true,
1686 ),
1687 'core_competency_competency_framework_viewed' => array(
1688 'classname' => 'core_competency\external',
1689 'methodname' => 'competency_framework_viewed',
1690 'classpath' => '',
1691 'description' => 'Log event competency framework viewed',
1692 'type' => 'read',
1693 'capabilities' => 'moodle/competency:competencyview',
1694 'ajax' => true,
1695 ),
1696 'core_competency_create_competency' => array(
1697 'classname' => 'core_competency\external',
1698 'methodname' => 'create_competency',
1699 'classpath' => '',
1700 'description' => 'Creates new competencies.',
1701 'type' => 'write',
1702 'capabilities' => 'moodle/competency:competencymanage',
1703 'ajax' => true,
1704 ),
1705 'core_competency_read_competency' => array(
1706 'classname' => 'core_competency\external',
1707 'methodname' => 'read_competency',
1708 'classpath' => '',
1709 'description' => 'Load a summary of a competency.',
1710 'type' => 'read',
1711 'capabilities' => 'moodle/competency:competencyview',
1712 'ajax' => true,
1713 ),
1714 'core_competency_competency_viewed' => array(
1715 'classname' => 'core_competency\external',
1716 'methodname' => 'competency_viewed',
1717 'classpath' => '',
1718 'description' => 'Log event competency viewed',
1719 'type' => 'read',
1720 'capabilities' => 'moodle/competency:competencyview',
1721 'ajax' => true,
3123c2cf 1722 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
81de839f
FM
1723 ),
1724 'core_competency_delete_competency' => array(
1725 'classname' => 'core_competency\external',
1726 'methodname' => 'delete_competency',
1727 'classpath' => '',
1728 'description' => 'Delete a competency.',
1729 'type' => 'write',
1730 'capabilities' => 'moodle/competency:competencymanage',
1731 'ajax' => true,
1732 ),
1733 'core_competency_update_competency' => array(
1734 'classname' => 'core_competency\external',
1735 'methodname' => 'update_competency',
1736 'classpath' => '',
1737 'description' => 'Update a competency.',
1738 'type' => 'write',
1739 'capabilities' => 'moodle/competency:competencymanage',
1740 'ajax' => true,
1741 ),
1742 'core_competency_list_competencies' => array(
1743 'classname' => 'core_competency\external',
1744 'methodname' => 'list_competencies',
1745 'classpath' => '',
1746 'description' => 'Load a list of a competencies.',
1747 'type' => 'read',
1748 'capabilities' => 'moodle/competency:competencyview',
1749 'ajax' => true,
1750 ),
1751 'core_competency_list_competencies_in_template' => array(
1752 'classname' => 'core_competency\external',
1753 'methodname' => 'list_competencies_in_template',
1754 'classpath' => '',
1755 'description' => 'Load a list of a competencies for a given template.',
1756 'type' => 'read',
1757 'capabilities' => 'moodle/competency:competencyview',
1758 'ajax' => true,
1759 ),
1760 'core_competency_count_competencies' => array(
1761 'classname' => 'core_competency\external',
1762 'methodname' => 'count_competencies',
1763 'classpath' => '',
1764 'description' => 'Count a list of a competencies.',
1765 'type' => 'read',
1766 'capabilities' => 'moodle/competency:competencyview',
1767 'ajax' => true,
1768 ),
1769 'core_competency_count_competencies_in_template' => array(
1770 'classname' => 'core_competency\external',
1771 'methodname' => 'count_competencies_in_template',
1772 'classpath' => '',
1773 'description' => 'Count a list of a competencies for a given template.',
1774 'type' => 'read',
1775 'capabilities' => 'moodle/competency:competencyview',
1776 'ajax' => true,
1777 ),
1778 'core_competency_search_competencies' => array(
1779 'classname' => 'core_competency\external',
1780 'methodname' => 'search_competencies',
1781 'classpath' => '',
1782 'description' => 'Search a list of a competencies.',
1783 'type' => 'read',
1784 'capabilities' => 'moodle/competency:competencyview',
1785 'ajax' => true,
1786 ),
1787 'core_competency_set_parent_competency' => array(
1788 'classname' => 'core_competency\external',
1789 'methodname' => 'set_parent_competency',
1790 'classpath' => '',
1791 'description' => 'Set a new parent for a competency.',
1792 'type' => 'write',
1793 'capabilities' => 'moodle/competency:competencymanage',
1794 'ajax' => true,
1795 ),
1796 'core_competency_move_up_competency' => array(
1797 'classname' => 'core_competency\external',
1798 'methodname' => 'move_up_competency',
1799 'classpath' => '',
1800 'description' => 'Re-order a competency.',
1801 'type' => 'write',
1802 'capabilities' => 'moodle/competency:competencymanage',
1803 'ajax' => true,
1804 ),
1805 'core_competency_move_down_competency' => array(
1806 'classname' => 'core_competency\external',
1807 'methodname' => 'move_down_competency',
1808 'classpath' => '',
1809 'description' => 'Re-order a competency.',
1810 'type' => 'write',
1811 'capabilities' => 'moodle/competency:competencymanage',
1812 'ajax' => true,
1813 ),
1814 'core_competency_list_course_competencies' => array(
1815 'classname' => 'core_competency\external',
1816 'methodname' => 'list_course_competencies',
1817 'classpath' => '',
1818 'description' => 'List the competencies in a course',
1819 'type' => 'read',
1820 'capabilities' => 'moodle/competency:coursecompetencyview',
1821 'ajax' => true,
3123c2cf 1822 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
81de839f
FM
1823 ),
1824 'core_competency_count_competencies_in_course' => array(
1825 'classname' => 'core_competency\external',
1826 'methodname' => 'count_competencies_in_course',
1827 'classpath' => '',
1828 'description' => 'List the competencies in a course',
1829 'type' => 'read',
1830 'capabilities' => 'moodle/competency:coursecompetencyview',
1831 'ajax' => true,
1832 ),
1833 'core_competency_count_courses_using_competency' => array(
1834 'classname' => 'core_competency\external',
1835 'methodname' => 'count_courses_using_competency',
1836 'classpath' => '',
1837 'description' => 'List the courses using a competency',
1838 'type' => 'read',
1839 'capabilities' => 'moodle/competency:coursecompetencyview',
1840 'ajax' => true,
1841 ),
1842 'core_competency_add_competency_to_course' => array(
1843 'classname' => 'core_competency\external',
1844 'methodname' => 'add_competency_to_course',
1845 'classpath' => '',
1846 'description' => 'Add the competency to a course',
1847 'type' => 'write',
1848 'capabilities' => 'moodle/competency:coursecompetencymanage',
1849 'ajax' => true,
1850 ),
1851 'core_competency_add_competency_to_template' => array(
1852 'classname' => 'core_competency\external',
1853 'methodname' => 'add_competency_to_template',
1854 'classpath' => '',
1855 'description' => 'Add the competency to a template',
1856 'type' => 'write',
1857 'capabilities' => 'moodle/competency:templatemanage',
1858 'ajax' => true,
1859 ),
1860 'core_competency_remove_competency_from_course' => array(
1861 'classname' => 'core_competency\external',
1862 'methodname' => 'remove_competency_from_course',
1863 'classpath' => '',
1864 'description' => 'Remove a competency from a course',
1865 'type' => 'write',
1866 'capabilities' => 'moodle/competency:coursecompetencymanage',
1867 'ajax' => true,
1868 ),
1869 'core_competency_set_course_competency_ruleoutcome' => array(
1870 'classname' => 'core_competency\external',
1871 'methodname' => 'set_course_competency_ruleoutcome',
1872 'classpath' => '',
1873 'description' => 'Modify the ruleoutcome value for course competency',
1874 'type' => 'write',
1875 'capabilities' => 'moodle/competency:coursecompetencymanage',
1876 'ajax' => true,
1877 ),
1878 'core_competency_remove_competency_from_template' => array(
1879 'classname' => 'core_competency\external',
1880 'methodname' => 'remove_competency_from_template',
1881 'classpath' => '',
1882 'description' => 'Remove a competency from a template',
1883 'type' => 'write',
1884 'capabilities' => 'moodle/competency:templatemanage',
1885 'ajax' => true,
1886 ),
1887 'core_competency_reorder_course_competency' => array(
1888 'classname' => 'core_competency\external',
1889 'methodname' => 'reorder_course_competency',
1890 'classpath' => '',
1891 'description' => 'Move a course competency to a new relative sort order.',
1892 'type' => 'write',
1893 'capabilities' => 'moodle/competency:coursecompetencymanage',
1894 'ajax' => true,
1895 ),
1896 'core_competency_reorder_template_competency' => array(
1897 'classname' => 'core_competency\external',
1898 'methodname' => 'reorder_template_competency',
1899 'classpath' => '',
1900 'description' => 'Move a template competency to a new relative sort order.',
1901 'type' => 'write',
1902 'capabilities' => 'moodle/competency:templatemanage',
1903 'ajax' => true,
1904 ),
1905 'core_competency_create_template' => array(
1906 'classname' => 'core_competency\external',
1907 'methodname' => 'create_template',
1908 'classpath' => '',
1909 'description' => 'Creates new learning plan templates.',
1910 'type' => 'write',
1911 'capabilities' => 'moodle/competency:templatemanage',
1912 'ajax' => true,
1913 ),
1914 'core_competency_duplicate_template' => array(
1915 'classname' => 'core_competency\external',
1916 'methodname' => 'duplicate_template',
1917 'classpath' => '',
1918 'description' => 'Duplicate learning plan template.',
1919 'type' => 'write',
1920 'capabilities' => 'moodle/competency:templatemanage',
1921 'ajax' => true,
1922 ),
1923 'core_competency_read_template' => array(
1924 'classname' => 'core_competency\external',
1925 'methodname' => 'read_template',
1926 'classpath' => '',
1927 'description' => 'Load a summary of a learning plan template.',
1928 'type' => 'read',
1929 'capabilities' => 'moodle/competency:templateview',
1930 'ajax' => true,
1931 ),
1932 'core_competency_delete_template' => array(
1933 'classname' => 'core_competency\external',
1934 'methodname' => 'delete_template',
1935 'classpath' => '',
1936 'description' => 'Delete a learning plan template.',
1937 'type' => 'write',
1938 'capabilities' => 'moodle/competency:templatemanage',
1939 'ajax' => true,
1940 ),
1941 'core_competency_update_template' => array(
1942 'classname' => 'core_competency\external',
1943 'methodname' => 'update_template',
1944 'classpath' => '',
1945 'description' => 'Update a learning plan template.',
1946 'type' => 'write',
1947 'capabilities' => 'moodle/competency:templatemanage',
1948 'ajax' => true,
1949 ),
1950 'core_competency_list_templates' => array(
1951 'classname' => 'core_competency\external',
1952 'methodname' => 'list_templates',
1953 'classpath' => '',
1954 'description' => 'Load a list of a learning plan templates.',
1955 'type' => 'read',
1956 'capabilities' => 'moodle/competency:templateview',
1957 'ajax' => true,
1958 ),
1959 'core_competency_list_templates_using_competency' => array(
1960 'classname' => 'core_competency\external',
1961 'methodname' => 'list_templates_using_competency',
1962 'classpath' => '',
1963 'description' => 'Load a list of a learning plan templates for a given competency.',
1964 'type' => 'read',
1965 'capabilities' => 'moodle/competency:templateview',
1966 'ajax' => true,
1967 ),
1968 'core_competency_count_templates' => array(
1969 'classname' => 'core_competency\external',
1970 'methodname' => 'count_templates',
1971 'classpath' => '',
1972 'description' => 'Count a list of a learning plan templates.',
1973 'type' => 'read',
1974 'capabilities' => 'moodle/competency:templateview',
1975 'ajax' => true,
1976 ),
1977 'core_competency_count_templates_using_competency' => array(
1978 'classname' => 'core_competency\external',
1979 'methodname' => 'count_templates_using_competency',
1980 'classpath' => '',
1981 'description' => 'Count a list of a learning plan templates for a given competency.',
1982 'type' => 'read',
1983 'capabilities' => 'moodle/competency:templateview',
1984 'ajax' => true,
1985 ),
1986 'core_competency_create_plan' => array(
1987 'classname' => 'core_competency\external',
1988 'methodname' => 'create_plan',
1989 'classpath' => '',
1990 'description' => 'Creates a learning plan.',
1991 'type' => 'write',
1992 'capabilities' => 'moodle/competency:planmanage',
1993 'ajax' => true,
1994 ),
1995 'core_competency_update_plan' => array(
1996 'classname' => 'core_competency\external',
1997 'methodname' => 'update_plan',
1998 'classpath' => '',
1999 'description' => 'Updates a learning plan.',
2000 'type' => 'write',
2001 'capabilities' => 'moodle/competency:planmanage',
2002 'ajax' => true,
2003 ),
2004 'core_competency_complete_plan' => array(
2005 'classname' => 'core_competency\external',
2006 'methodname' => 'complete_plan',
2007 'classpath' => '',
2008 'description' => 'Complete learning plan.',
2009 'type' => 'write',
2010 'capabilities' => 'moodle/competency:planmanage',
2011 'ajax' => true,
2012 ),
2013 'core_competency_reopen_plan' => array(
2014 'classname' => 'core_competency\external',
2015 'methodname' => 'reopen_plan',
2016 'classpath' => '',
2017 'description' => 'Reopen learning plan.',
2018 'type' => 'write',
2019 'capabilities' => 'moodle/competency:planmanage',
2020 'ajax' => true,
2021 ),
2022 'core_competency_read_plan' => array(
2023 'classname' => 'core_competency\external',
2024 'methodname' => 'read_plan',
2025 'classpath' => '',
2026 'description' => 'Load a learning plan.',
2027 'type' => 'read',
2028 'capabilities' => 'moodle/competency:planviewown',
2029 'ajax' => true,
2030 ),
2031 'core_competency_delete_plan' => array(
2032 'classname' => 'core_competency\external',
2033 'methodname' => 'delete_plan',
2034 'classpath' => '',
2035 'description' => 'Delete a learning plan.',
2036 'type' => 'write',
2037 'capabilities' => 'moodle/competency:planmanage',
2038 'ajax' => true,
2039 ),
2040 'core_competency_list_user_plans' => array(
2041 'classname' => 'core_competency\external',
2042 'methodname' => 'list_user_plans',
2043 'classpath' => '',
2044 'description' => 'List a user\'s learning plans.',
2045 'type' => 'read',
2046 'capabilities' => 'moodle/competency:planviewown',
2047 'ajax' => true,
2048 ),
2049 'core_competency_list_plan_competencies' => array(
2050 'classname' => 'core_competency\external',
2051 'methodname' => 'list_plan_competencies',
2052 'classpath' => '',
2053 'description' => 'List the competencies in a plan',
2054 'type' => 'read',
2055 'capabilities' => 'moodle/competency:planviewown',
2056 'ajax' => true,
2057 ),
2058 'core_competency_add_competency_to_plan' => array(
2059 'classname' => 'core_competency\external',
2060 'methodname' => 'add_competency_to_plan',
2061 'classpath' => '',
2062 'description' => 'Add the competency to a learning plan',
2063 'type' => 'write',
2064 'capabilities' => 'moodle/competency:planmanage',
2065 'ajax' => true,
2066 ),
2067 'core_competency_remove_competency_from_plan' => array(
2068 'classname' => 'core_competency\external',
2069 'methodname' => 'remove_competency_from_plan',
2070 'classpath' => '',
2071 'description' => 'Remove the competency from a learning plan',
2072 'type' => 'write',
2073 'capabilities' => 'moodle/competency:planmanage',
2074 'ajax' => true,
2075 ),
2076 'core_competency_reorder_plan_competency' => array(
2077 'classname' => 'core_competency\external',
2078 'methodname' => 'reorder_plan_competency',
2079 'classpath' => '',
2080 'description' => 'Move a plan competency to a new relative sort order.',
2081 'type' => 'write',
2082 'capabilities' => 'moodle/competency:planmanage',
2083 'ajax' => true,
2084 ),
2085 'core_competency_plan_request_review' => array(
2086 'classname' => 'core_competency\external',
2087 'methodname' => 'plan_request_review',
2088 'classpath' => '',
2089 'description' => 'Request for a plan to be reviewed.',
2090 'type' => 'write',
2091 'capabilities' => 'moodle/competency:planmanagedraft',
2092 'ajax' => true,
2093 ),
2094 'core_competency_plan_start_review' => array(
2095 'classname' => 'core_competency\external',
2096 'methodname' => 'plan_start_review',
2097 'classpath' => '',
2098 'description' => 'Start the review of a plan.',
2099 'type' => 'write',
2100 'capabilities' => 'moodle/competency:planmanage',
2101 'ajax' => true,
2102 ),
2103 'core_competency_plan_stop_review' => array(
2104 'classname' => 'core_competency\external',
2105 'methodname' => 'plan_stop_review',
2106 'classpath' => '',
2107 'description' => 'Stop the review of a plan.',
2108 'type' => 'write',
2109 'capabilities' => 'moodle/competency:planmanage',
2110 'ajax' => true,
2111 ),
2112 'core_competency_plan_cancel_review_request' => array(
2113 'classname' => 'core_competency\external',
2114 'methodname' => 'plan_cancel_review_request',
2115 'classpath' => '',
2116 'description' => 'Cancel the review of a plan.',
2117 'type' => 'write',
2118 'capabilities' => 'moodle/competency:planmanagedraft',
2119 'ajax' => true,
2120 ),
2121 'core_competency_approve_plan' => array(
2122 'classname' => 'core_competency\external',
2123 'methodname' => 'approve_plan',
2124 'classpath' => '',
2125 'description' => 'Approve a plan.',
2126 'type' => 'write',
2127 'capabilities' => 'moodle/competency:planmanage',
2128 'ajax' => true,
2129 ),
2130 'core_competency_unapprove_plan' => array(
2131 'classname' => 'core_competency\external',
2132 'methodname' => 'unapprove_plan',
2133 'classpath' => '',
2134 'description' => 'Unapprove a plan.',
2135 'type' => 'write',
2136 'capabilities' => 'moodle/competency:planmanage',
2137 'ajax' => true,
2138 ),
2139 'core_competency_template_has_related_data' => array(
2140 'classname' => 'core_competency\external',
2141 'methodname' => 'template_has_related_data',
2142 'classpath' => '',
2143 'description' => 'Check if a template has related data',
2144 'type' => 'read',
2145 'capabilities' => 'moodle/competency:templateview',
2146 'ajax' => true,
2147 ),
2148 'core_competency_get_scale_values' => array(
2149 'classname' => 'core_competency\external',
2150 'methodname' => 'get_scale_values',
2151 'classpath' => '',
2152 'description' => 'Fetch the values for a specific scale',
2153 'type' => 'read',
2154 'capabilities' => 'moodle/competency:competencymanage',
2155 'ajax' => true,
3123c2cf 2156 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
81de839f
FM
2157 ),
2158 'core_competency_add_related_competency' => array(
2159 'classname' => 'core_competency\external',
2160 'methodname' => 'add_related_competency',
2161 'classpath' => '',
2162 'description' => 'Adds a related competency',
2163 'type' => 'write',
2164 'capabilities' => 'moodle/competency:competencymanage',
2165 'ajax' => true,
2166 ),
2167 'core_competency_remove_related_competency' => array(
2168 'classname' => 'core_competency\external',
2169 'methodname' => 'remove_related_competency',
2170 'classpath' => '',
2171 'description' => 'Remove a related competency',
2172 'type' => 'write',
2173 'capabilities' => 'moodle/competency:competencymanage',
2174 'ajax' => true,
2175 ),
2176 'core_competency_read_user_evidence' => array(
2177 'classname' => 'core_competency\external',
2178 'methodname' => 'read_user_evidence',
2179 'classpath' => '',
2180 'description' => 'Read an evidence of prior learning.',
2181 'type' => 'read',
2182 'capabilities' => 'moodle/competency:userevidenceview',
2183 'ajax' => true,
2184 ),
2185 'core_competency_delete_user_evidence' => array(
2186 'classname' => 'core_competency\external',
2187 'methodname' => 'delete_user_evidence',
2188 'classpath' => '',
2189 'description' => 'Delete an evidence of prior learning.',
2190 'type' => 'write',
2191 'capabilities' => 'moodle/competency:userevidencemanageown',
2192 'ajax' => true,
2193 ),
2194 'core_competency_create_user_evidence_competency' => array(
2195 'classname' => 'core_competency\external',
2196 'methodname' => 'create_user_evidence_competency',
2197 'classpath' => '',
2198 'description' => 'Create an evidence of prior learning relationship with a competency.',
2199 'type' => 'read',
2200 'capabilities' => 'moodle/competency:userevidencemanageown, moodle/competency:competencyview',
2201 'ajax' => true,
2202 ),
2203 'core_competency_delete_user_evidence_competency' => array(
2204 'classname' => 'core_competency\external',
2205 'methodname' => 'delete_user_evidence_competency',
2206 'classpath' => '',
2207 'description' => 'Delete an evidence of prior learning relationship with a competency.',
2208 'type' => 'write',
2209 'capabilities' => 'moodle/competency:userevidencemanageown',
2210 'ajax' => true,
2211 ),
2212 'core_competency_user_competency_cancel_review_request' => array(
2213 'classname' => 'core_competency\external',
2214 'methodname' => 'user_competency_cancel_review_request',
2215 'classpath' => '',
2216 'description' => 'Cancel a review request.',
2217 'type' => 'write',
2218 'capabilities' => 'moodle/competency:userevidencemanageown',
2219 'ajax' => true,
2220 ),
2221 'core_competency_user_competency_request_review' => array(
2222 'classname' => 'core_competency\external',
2223 'methodname' => 'user_competency_request_review',
2224 'classpath' => '',
2225 'description' => 'Request a review.',
2226 'type' => 'write',
2227 'capabilities' => 'moodle/competency:userevidencemanageown',
2228 'ajax' => true,
2229 ),
2230 'core_competency_user_competency_start_review' => array(
2231 'classname' => 'core_competency\external',
2232 'methodname' => 'user_competency_start_review',
2233 'classpath' => '',
2234 'description' => 'Start a review.',
2235 'type' => 'write',
2236 'capabilities' => 'moodle/competency:competencygrade',
2237 'ajax' => true,
2238 ),
2239 'core_competency_user_competency_stop_review' => array(
2240 'classname' => 'core_competency\external',
2241 'methodname' => 'user_competency_stop_review',
2242 'classpath' => '',
2243 'description' => 'Stop a review.',
2244 'type' => 'write',
2245 'capabilities' => 'moodle/competency:competencygrade',
2246 'ajax' => true,
2247 ),
2248 'core_competency_user_competency_viewed' => array(
2249 'classname' => 'core_competency\external',
2250 'methodname' => 'user_competency_viewed',
2251 'classpath' => '',
2252 'description' => 'Log the user competency viewed event.',
2253 'type' => 'read',
2254 'capabilities' => 'moodle/competency:usercompetencyview',
2255 'ajax' => true,
3123c2cf 2256 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
81de839f
FM
2257 ),
2258 'core_competency_user_competency_viewed_in_plan' => array(
2259 'classname' => 'core_competency\external',
2260 'methodname' => 'user_competency_viewed_in_plan',
2261 'classpath' => '',
2262 'description' => 'Log the user competency viewed in plan event.',
2263 'type' => 'read',
2264 'capabilities' => 'moodle/competency:usercompetencyview',
2265 'ajax' => true,
3123c2cf 2266 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
81de839f
FM
2267 ),
2268 'core_competency_user_competency_viewed_in_course' => array(
2269 'classname' => 'core_competency\external',
2270 'methodname' => 'user_competency_viewed_in_course',
2271 'classpath' => '',
2272 'description' => 'Log the user competency viewed in course event',
2273 'type' => 'read',
2274 'capabilities' => 'moodle/competency:usercompetencyview',
2275 'ajax' => true,
3123c2cf 2276 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
81de839f
FM
2277 ),
2278 'core_competency_user_competency_plan_viewed' => array(
2279 'classname' => 'core_competency\external',
2280 'methodname' => 'user_competency_plan_viewed',
2281 'classpath' => '',
2282 'description' => 'Log the user competency plan viewed event.',
2283 'type' => 'read',
2284 'capabilities' => 'moodle/competency:usercompetencyview',
2285 'ajax' => true,
3123c2cf 2286 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
81de839f
FM
2287 ),
2288 'core_competency_grade_competency' => array(
2289 'classname' => 'core_competency\external',
2290 'methodname' => 'grade_competency',
2291 'classpath' => '',
2292 'description' => 'Grade a competency.',
2293 'type' => 'write',
2294 'capabilities' => 'moodle/competency:competencygrade',
2295 'ajax' => true,
2296 ),
2297 'core_competency_grade_competency_in_plan' => array(
2298 'classname' => 'core_competency\external',
2299 'methodname' => 'grade_competency_in_plan',
2300 'classpath' => '',
2301 'description' => 'Grade a competency from the user plan page.',
2302 'type' => 'write',
2303 'capabilities' => 'moodle/competency:competencygrade',
2304 'ajax' => true,
2305 ),
2306 'core_competency_grade_competency_in_course' => array(
2307 'classname' => 'core_competency\external',
2308 'methodname' => 'grade_competency_in_course',
2309 'classpath' => '',
2310 'description' => 'Grade a competency from the course page.',
2311 'type' => 'write',
2312 'capabilities' => 'moodle/competency:competencygrade',
2313 'ajax' => true,
3123c2cf 2314 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
81de839f
FM
2315 ),
2316 'core_competency_unlink_plan_from_template' => array(
2317 'classname' => 'core_competency\external',
2318 'methodname' => 'unlink_plan_from_template',
2319 'classpath' => '',
2320 'description' => 'Unlink a plan form it template.',
2321 'type' => 'write',
2322 'capabilities' => 'moodle/competency:planmanage',
2323 'ajax' => true,
2324 ),
2325 'core_competency_template_viewed' => array(
2326 'classname' => 'core_competency\external',
2327 'methodname' => 'template_viewed',
2328 'classpath' => '',
2329 'description' => 'Log event template viewed',
2330 'type' => 'read',
2331 'capabilities' => 'moodle/competency:templateview',
2332 'ajax' => true,
2333 ),
2334 'core_competency_request_review_of_user_evidence_linked_competencies' => array(
2335 'classname' => 'core_competency\external',
2336 'methodname' => 'request_review_of_user_evidence_linked_competencies',
2337 'classpath' => '',
2338 'description' => 'Send user evidence competencies in review',
2339 'type' => 'write',
2340 'capabilities' => 'moodle/competency:userevidencemanageown',
2341 'ajax' => true,
2342 ),
2343 'core_competency_update_course_competency_settings' => array(
2344 'classname' => 'core_competency\external',
2345 'methodname' => 'update_course_competency_settings',
2346 'classpath' => '',
2347 'description' => 'Update the course competency settings',
2348 'type' => 'write',
2349 'capabilities' => 'moodle/competency:coursecompetencyconfigure',
2350 'ajax' => true,
2351 ),
1e99f31e
FM
2352 'core_competency_delete_evidence' => array(
2353 'classname' => 'core_competency\external',
2354 'methodname' => 'delete_evidence',
2355 'classpath' => '',
2356 'description' => 'Delete an evidence',
2357 'type' => 'write',
2358 'capabilities' => 'moodle/competency:evidencedelete',
2359 'ajax' => true,
3123c2cf 2360 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
1e99f31e 2361 ),
f23e9b6b
CB
2362
2363 'core_webservice_get_site_info' => array(
2364 'classname' => 'core_webservice_external',
2365 'methodname' => 'get_site_info',
2366 'classpath' => 'webservice/externallib.php',
2367 'description' => 'Return some site info / user info / list web service functions',
2368 'type' => 'read',
ee7295ee 2369 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
8446ba36
JL
2370 ),
2371
2372 // Blocks functions.
2373 'core_block_get_course_blocks' => array(
2374 'classname' => 'core_block_external',
2375 'methodname' => 'get_course_blocks',
2376 'description' => 'Returns blocks information for a course.',
2377 'type' => 'read',
2378 'capabilities' => '',
2379 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
2380 ),
66ef16d3 2381
0f8b2604
JL
2382 'core_block_get_dashboard_blocks' => array(
2383 'classname' => 'core_block_external',
2384 'methodname' => 'get_dashboard_blocks',
2385 'description' => 'Returns blocks information for the given user dashboard.',
2386 'type' => 'read',
2387 'capabilities' => '',
2388 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
2389 ),
2390
66ef16d3
JL
2391 // Filters functions.
2392 'core_filters_get_available_in_context' => array(
2393 'classname' => 'core_filters\external',
2394 'methodname' => 'get_available_in_context',
2395 'description' => 'Returns the filters available in the given contexts.',
2396 'type' => 'read',
2397 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
3cfff885 2398 ),
9a0df45a 2399);
c1b65883
JM
2400
2401$services = array(
96e0194c 2402 'Moodle mobile web service' => array(
12c52b91 2403 'functions' => array(), // Unused as we add the service in each function definition, third party services would use this.
96e0194c
SH
2404 'enabled' => 0,
2405 'restrictedusers' => 0,
af03513f 2406 'shortname' => MOODLE_OFFICIAL_MOBILE_SERVICE,
106c55fb
DW
2407 'downloadfiles' => 1,
2408 'uploadfiles' => 1
96e0194c
SH
2409 ),
2410);