weekly release 3.7dev
[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 ),
7d678923
MN
942 'core_message_get_received_contact_requests_count' => array(
943 'classname' => 'core_message_external',
944 'methodname' => 'get_received_contact_requests_count',
945 'classpath' => 'message/externallib.php',
946 'description' => 'Gets the number of received contact requests',
947 'type' => 'read',
948 'ajax' => true,
949 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
950 ),
d6731600 951 'core_message_delete_contacts' => array(
f23e9b6b
CB
952 'classname' => 'core_message_external',
953 'methodname' => 'delete_contacts',
954 'classpath' => 'message/externallib.php',
d6731600 955 'description' => 'Remove contacts from the contact list',
f23e9b6b 956 'type' => 'write',
c6e97f54 957 'ajax' => true,
ee7295ee 958 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
d6731600 959 ),
dec0cd99
MN
960 'core_message_delete_conversation' => array(
961 'classname' => 'core_message_external',
962 'methodname' => 'delete_conversation',
963 'classpath' => 'message/externallib.php',
fa024820
MN
964 'description' => '** DEPRECATED ** Please do not call this function any more.
965 Deletes a conversation.',
dec0cd99
MN
966 'type' => 'write',
967 'capabilities' => 'moodle/site:deleteownmessage',
968 'ajax' => true,
53522c6e 969 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
dec0cd99 970 ),
60b67bbc 971 'core_message_delete_conversations_by_id' => array(
26f39c88 972 'classname' => 'core_message_external',
60b67bbc 973 'methodname' => 'delete_conversations_by_id',
26f39c88 974 'classpath' => 'message/externallib.php',
60b67bbc 975 'description' => 'Deletes a list of conversations.',
26f39c88
MN
976 'type' => 'write',
977 'capabilities' => 'moodle/site:deleteownmessage',
978 'ajax' => true,
979 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
980 ),
f23e9b6b
CB
981 'core_message_delete_message' => array(
982 'classname' => 'core_message_external',
983 'methodname' => 'delete_message',
984 'classpath' => 'message/externallib.php',
985 'description' => 'Deletes a message.',
986 'type' => 'write',
ee7295ee 987 'capabilities' => 'moodle/site:deleteownmessage',
3090f52f 988 'ajax' => true,
ee7295ee 989 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
d6731600 990 ),
f23e9b6b
CB
991 'core_message_get_blocked_users' => array(
992 'classname' => 'core_message_external',
993 'methodname' => 'get_blocked_users',
994 'classpath' => 'message/externallib.php',
995 'description' => 'Retrieve a list of users blocked',
996 'type' => 'read',
ee7295ee 997 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
d6731600 998 ),
cd03b8d7
MN
999 'core_message_data_for_messagearea_search_messages' => array(
1000 'classname' => 'core_message_external',
1001 'methodname' => 'data_for_messagearea_search_messages',
1002 'classpath' => 'message/externallib.php',
1003 'description' => 'Retrieve the template data for searching for messages',
1004 'type' => 'read',
1005 'ajax' => true,
53522c6e 1006 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
cd03b8d7 1007 ),
48e8bdba 1008 'core_message_data_for_messagearea_search_users' => array(
cd03b8d7 1009 'classname' => 'core_message_external',
48e8bdba 1010 'methodname' => 'data_for_messagearea_search_users',
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',
cd03b8d7
MN
1014 'type' => 'read',
1015 'ajax' => true,
1016 ),
48e8bdba 1017 'core_message_data_for_messagearea_search_users_in_course' => array(
cd03b8d7 1018 'classname' => 'core_message_external',
48e8bdba 1019 'methodname' => 'data_for_messagearea_search_users_in_course',
cd03b8d7 1020 'classpath' => 'message/externallib.php',
548cac7d
AA
1021 'description' => '** DEPRECATED ** Please do not call this function any more.
1022 Retrieve the template data for searching for people in a course',
1023 'type' => 'read',
1024 'ajax' => true,
1025 ),
1026 'core_message_message_search_users' => array(
1027 'classname' => 'core_message_external',
1028 'methodname' => 'message_search_users',
1029 'classpath' => 'message/externallib.php',
1030 'description' => 'Retrieve the data for searching for people',
cd03b8d7
MN
1031 'type' => 'read',
1032 'ajax' => true,
548cac7d 1033 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
cd03b8d7 1034 ),
9aa012b5
MN
1035 'core_message_data_for_messagearea_conversations' => array(
1036 'classname' => 'core_message_external',
1037 'methodname' => 'data_for_messagearea_conversations',
1038 'classpath' => 'message/externallib.php',
eb35e0b1
JD
1039 'description' => '** DEPRECATED ** Please do not call this function any more.
1040 Retrieve the template data for the conversation list',
9aa012b5
MN
1041 'type' => 'read',
1042 'ajax' => true,
21d9f020 1043 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
9aa012b5
MN
1044 ),
1045 'core_message_data_for_messagearea_contacts' => array(
1046 'classname' => 'core_message_external',
1047 'methodname' => 'data_for_messagearea_contacts',
1048 'classpath' => 'message/externallib.php',
a6049a79
MN
1049 'description' => '** DEPRECATED ** Please do not call this function any more.
1050 Retrieve the template data for the contact list',
9aa012b5
MN
1051 'type' => 'read',
1052 'ajax' => true,
21d9f020 1053 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
9aa012b5 1054 ),
3cd13828
MN
1055 'core_message_data_for_messagearea_messages' => array(
1056 'classname' => 'core_message_external',
1057 'methodname' => 'data_for_messagearea_messages',
1058 'classpath' => 'message/externallib.php',
a6049a79
MN
1059 'description' => '** DEPRECATED ** Please do not call this function any more.
1060 Retrieve the template data for the messages',
3cd13828
MN
1061 'type' => 'read',
1062 'ajax' => true,
21d9f020 1063 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
3cd13828 1064 ),
c060cd49
MN
1065 'core_message_data_for_messagearea_get_most_recent_message' => array(
1066 'classname' => 'core_message_external',
1067 'methodname' => 'data_for_messagearea_get_most_recent_message',
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 most recent message',
c060cd49
MN
1071 'type' => 'read',
1072 'ajax' => true,
1073 ),
c6e97f54
MN
1074 'core_message_data_for_messagearea_get_profile' => array(
1075 'classname' => 'core_message_external',
1076 'methodname' => 'data_for_messagearea_get_profile',
1077 'classpath' => 'message/externallib.php',
a6049a79
MN
1078 'description' => '** DEPRECATED ** Please do not call this function any more.
1079 Retrieve the template data for the users\'s profile',
c6e97f54
MN
1080 'type' => 'read',
1081 'ajax' => true,
1082 ),
d6731600 1083 'core_message_get_contacts' => array(
f23e9b6b
CB
1084 'classname' => 'core_message_external',
1085 'methodname' => 'get_contacts',
1086 'classpath' => 'message/externallib.php',
f8905537
MN
1087 'description' => '** DEPRECATED ** Please do not call this function any more.
1088 Retrieve the contact list',
f23e9b6b 1089 'type' => 'read',
6f31927a
JD
1090 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
1091 ),
c9b0f33f
MN
1092 'core_message_get_user_contacts' => array(
1093 'classname' => 'core_message_external',
1094 'methodname' => 'get_user_contacts',
1095 'classpath' => 'message/externallib.php',
d6731600 1096 'description' => 'Retrieve the contact list',
f23e9b6b 1097 'type' => 'read',
c9b0f33f 1098 'ajax' => true,
6f31927a
JD
1099 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
1100 ),
1101 'core_message_get_conversations' => array(
1102 'classname' => 'core_message_external',
1103 'methodname' => 'get_conversations',
1104 'classpath' => 'message/externallib.php',
1105 'description' => 'Retrieve a list of conversations for a user',
1106 'type' => 'read',
ee7295ee 1107 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
b3bbd4a0 1108 'ajax' => true
d6731600 1109 ),
4e313026
RW
1110 'core_message_get_conversation' => array(
1111 'classname' => 'core_message_external',
1112 'methodname' => 'get_conversation',
1113 'classpath' => 'message/externallib.php',
1114 'description' => 'Retrieve a conversation for a user',
1115 'type' => 'read',
569c0bae
RW
1116 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
1117 'ajax' => true
1118 ),
1119 'core_message_get_conversation_between_users' => array(
1120 'classname' => 'core_message_external',
1121 'methodname' => 'get_conversation_between_users',
1122 'classpath' => 'message/externallib.php',
1123 'description' => 'Retrieve a conversation for a user between another user',
1124 'type' => 'read',
4e313026
RW
1125 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
1126 'ajax' => true
1127 ),
aff9da17 1128 'core_message_get_messages' => array(
f23e9b6b
CB
1129 'classname' => 'core_message_external',
1130 'methodname' => 'get_messages',
1131 'classpath' => 'message/externallib.php',
1132 'description' => 'Retrieve a list of messages sent and received by a user (conversations, notifications or both)',
1133 'type' => 'read',
ee7295ee 1134 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
3274d5ca
RW
1135 'ajax' => true,
1136 ),
28ff6ad1
JD
1137 'core_message_get_conversation_counts' => array(
1138 'classname' => 'core_message_external',
1139 'methodname' => 'get_conversation_counts',
1140 'classpath' => 'message/externallib.php',
1141 'description' => 'Retrieve a list of conversation counts, indexed by type.',
1142 'type' => 'read',
1143 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
1144 'ajax' => true,
1145 ),
b402a163
JD
1146 'core_message_get_unread_conversation_counts' => array(
1147 'classname' => 'core_message_external',
1148 'methodname' => 'get_unread_conversation_counts',
1149 'classpath' => 'message/externallib.php',
1150 'description' => 'Retrieve a list of unread conversation counts, indexed by type.',
1151 'type' => 'read',
1152 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
1153 'ajax' => true,
1154 ),
5584c48a
MN
1155 'core_message_get_conversation_members' => array(
1156 'classname' => 'core_message_external',
1157 'methodname' => 'get_conversation_members',
1158 'classpath' => 'message/externallib.php',
1159 'description' => 'Retrieve a list of members in a conversation',
1160 'type' => 'read',
1161 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
1162 'ajax' => true,
1163 ),
8350978a
RW
1164 'core_message_get_member_info' => array(
1165 'classname' => 'core_message_external',
1166 'methodname' => 'get_member_info',
1167 'classpath' => 'message/externallib.php',
1168 'description' => 'Retrieve a user message profiles',
1169 'type' => 'read',
1170 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
1171 'ajax' => true,
1172 ),
8c55bd6c
RW
1173 'core_message_get_unread_conversations_count' => array(
1174 'classname' => 'core_message_external',
1175 'methodname' => 'get_unread_conversations_count',
1176 'classpath' => 'message/externallib.php',
1177 'description' => 'Retrieve the count of unread conversations for a given user',
1178 'type' => 'read',
1179 'ajax' => true,
53522c6e 1180 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
8c55bd6c 1181 ),
3274d5ca
RW
1182 'core_message_mark_all_notifications_as_read' => array(
1183 'classname' => 'core_message_external',
1184 'methodname' => 'mark_all_notifications_as_read',
1185 'classpath' => 'message/externallib.php',
8c55bd6c
RW
1186 'description' => 'Mark all notifications as read for a given user',
1187 'type' => 'write',
1188 'ajax' => true,
53522c6e 1189 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
8c55bd6c
RW
1190 ),
1191 'core_message_mark_all_messages_as_read' => array(
1192 'classname' => 'core_message_external',
1193 'methodname' => 'mark_all_messages_as_read',
1194 'classpath' => 'message/externallib.php',
e4c30994
MN
1195 'description' => '** DEPRECATED ** Please do not call this function any more.
1196 Mark all messages as read for a given user',
3274d5ca
RW
1197 'type' => 'write',
1198 'ajax' => true,
53522c6e 1199 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
60ab2e1b 1200 ),
09ec5017
MN
1201 'core_message_mark_all_conversation_messages_as_read' => array(
1202 'classname' => 'core_message_external',
1203 'methodname' => 'mark_all_conversation_messages_as_read',
1204 'classpath' => 'message/externallib.php',
1205 'description' => 'Mark all conversation messages as read for a given user',
3274d5ca
RW
1206 'type' => 'write',
1207 'ajax' => true,
53522c6e 1208 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
60ab2e1b 1209 ),
a84f89ca 1210 'core_message_mark_message_read' => array(
f23e9b6b
CB
1211 'classname' => 'core_message_external',
1212 'methodname' => 'mark_message_read',
1213 'classpath' => 'message/externallib.php',
1214 'description' => 'Mark a single message as read, trigger message_viewed event.',
1215 'type' => 'write',
ee7295ee 1216 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
0b19d048 1217 'ajax' => true,
a84f89ca 1218 ),
2b595d96
MN
1219 'core_message_mark_notification_read' => array(
1220 'classname' => 'core_message_external',
1221 'methodname' => 'mark_notification_read',
1222 'classpath' => 'message/externallib.php',
1223 'description' => 'Mark a single notification as read, trigger notification_viewed event.',
1224 'type' => 'write',
1225 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
1226 'ajax' => true,
1227 ),
a0eabdd3
RW
1228 'core_message_message_processor_config_form' => array(
1229 'classname' => 'core_message_external',
1230 'methodname' => 'message_processor_config_form',
1231 'classpath' => 'message/externallib.php',
1232 'description' => 'Process the message processor config form',
1233 'type' => 'write',
1234 'ajax' => true,
53522c6e 1235 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
a0eabdd3 1236 ),
8c125526
RW
1237 'core_message_get_message_processor' => array(
1238 'classname' => 'core_message_external',
1239 'methodname' => 'get_message_processor',
1240 'classpath' => 'message/externallib.php',
1241 'description' => 'Get a message processor',
1242 'type' => 'read',
1243 'ajax' => true,
1244 ),
f23e9b6b
CB
1245 'core_message_search_contacts' => array(
1246 'classname' => 'core_message_external',
1247 'methodname' => 'search_contacts',
1248 'classpath' => 'message/externallib.php',
1249 'description' => 'Search for contacts',
1250 'type' => 'read',
ee7295ee 1251 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
419b1128 1252 ),
f23e9b6b
CB
1253 'core_message_send_instant_messages' => array(
1254 'classname' => 'core_message_external',
1255 'methodname' => 'send_instant_messages',
1256 'classpath' => 'message/externallib.php',
1257 'description' => 'Send instant messages',
1258 'type' => 'write',
ee7295ee 1259 'capabilities' => 'moodle/site:sendmessage',
c060cd49 1260 'ajax' => true,
ee7295ee 1261 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
f23e9b6b 1262 ),
2553e9db
JD
1263 'core_message_send_messages_to_conversation' => array(
1264 'classname' => 'core_message_external',
1265 'methodname' => 'send_messages_to_conversation',
1266 'classpath' => 'message/externallib.php',
1267 'description' => 'Send messages to an existing conversation between users',
1268 'type' => 'write',
1269 'capabilities' => 'moodle/site:sendmessage',
1270 'ajax' => true,
1271 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
1272 ),
fb04293b
SA
1273 'core_message_get_conversation_messages' => array(
1274 'classname' => 'core_message_external',
1275 'methodname' => 'get_conversation_messages',
1276 'classpath' => 'message/externallib.php',
1277 'description' => 'Retrieve the conversation messages and relevant member information',
1278 'type' => 'read',
1279 'ajax' => true,
1280 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
1281 ),
52284186
MN
1282 'core_message_unblock_user' => array(
1283 'classname' => 'core_message_external',
1284 'methodname' => 'unblock_user',
1285 'classpath' => 'message/externallib.php',
1286 'description' => 'Unblocks a user',
1287 'type' => 'write',
1288 'ajax' => true,
1289 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
1290 ),
f23e9b6b
CB
1291 'core_message_unblock_contacts' => array(
1292 'classname' => 'core_message_external',
1293 'methodname' => 'unblock_contacts',
1294 'classpath' => 'message/externallib.php',
0b3eadcd
MN
1295 'description' => '** DEPRECATED ** Please do not call this function any more.
1296 Unblock contacts',
f23e9b6b 1297 'type' => 'write',
c6e97f54 1298 'ajax' => true,
ee7295ee 1299 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
5d1017e1 1300 ),
e86f0cb4
JL
1301 'core_message_get_user_notification_preferences' => array(
1302 'classname' => 'core_message_external',
1303 'methodname' => 'get_user_notification_preferences',
1304 'classpath' => 'message/externallib.php',
1305 'description' => 'Get the notification preferences for a given user.',
1306 'type' => 'read',
1307 'capabilities' => 'moodle/user:editownmessageprofile',
1308 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
1309 ),
2521afd2
JL
1310 'core_message_get_user_message_preferences' => array(
1311 'classname' => 'core_message_external',
1312 'methodname' => 'get_user_message_preferences',
1313 'classpath' => 'message/externallib.php',
1314 'description' => 'Get the message preferences for a given user.',
1315 'type' => 'read',
1316 'capabilities' => 'moodle/user:editownmessageprofile',
1317 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
08ae9a73 1318 'ajax' => true
2521afd2 1319 ),
5b367bae
JD
1320 'core_message_set_favourite_conversations' => array(
1321 'classname' => 'core_message_external',
1322 'methodname' => 'set_favourite_conversations',
1323 'classpath' => 'message/externallib.php',
1324 'description' => 'Mark a conversation or group of conversations as favourites/starred conversations.',
1325 'type' => 'write',
9e189a91 1326 'ajax' => true,
5b367bae
JD
1327 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
1328 ),
1329 'core_message_unset_favourite_conversations' => array(
1330 'classname' => 'core_message_external',
1331 'methodname' => 'unset_favourite_conversations',
1332 'classpath' => 'message/externallib.php',
1333 'description' => 'Unset a conversation or group of conversations as favourites/starred conversations.',
1334 'type' => 'write',
9e189a91 1335 'ajax' => true,
5b367bae
JD
1336 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
1337 ),
5d1017e1 1338 'core_notes_create_notes' => array(
f23e9b6b
CB
1339 'classname' => 'core_notes_external',
1340 'methodname' => 'create_notes',
1341 'classpath' => 'notes/externallib.php',
8d46dabb 1342 'description' => 'Create notes',
f23e9b6b 1343 'type' => 'write',
b5b81de3 1344 'ajax' => true,
ee7295ee
JL
1345 'capabilities' => 'moodle/notes:manage',
1346 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
8d46dabb 1347 ),
34348b2b 1348 'core_notes_delete_notes' => array(
f23e9b6b
CB
1349 'classname' => 'core_notes_external',
1350 'methodname' => 'delete_notes',
1351 'classpath' => 'notes/externallib.php',
34348b2b 1352 'description' => 'Delete notes',
f23e9b6b 1353 'type' => 'write',
ee7295ee
JL
1354 'capabilities' => 'moodle/notes:manage',
1355 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
f23e9b6b
CB
1356 ),
1357 'core_notes_get_course_notes' => array(
1358 'classname' => 'core_notes_external',
1359 'methodname' => 'get_course_notes',
1360 'classpath' => 'notes/externallib.php',
1361 'description' => 'Returns all notes in specified course (or site), for the specified user.',
1362 'type' => 'read',
ee7295ee
JL
1363 'capabilities' => 'moodle/notes:view',
1364 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
34348b2b 1365 ),
34348b2b 1366 'core_notes_get_notes' => array(
f23e9b6b
CB
1367 'classname' => 'core_notes_external',
1368 'methodname' => 'get_notes',
1369 'classpath' => 'notes/externallib.php',
34348b2b 1370 'description' => 'Get notes',
f23e9b6b
CB
1371 'type' => 'read',
1372 'capabilities' => 'moodle/notes:view'
34348b2b 1373 ),
34348b2b 1374 'core_notes_update_notes' => array(
f23e9b6b
CB
1375 'classname' => 'core_notes_external',
1376 'methodname' => 'update_notes',
1377 'classpath' => 'notes/externallib.php',
34348b2b 1378 'description' => 'Update notes',
f23e9b6b
CB
1379 'type' => 'write',
1380 'capabilities' => 'moodle/notes:manage'
34348b2b 1381 ),
a80b5518 1382 'core_notes_view_notes' => array(
f23e9b6b
CB
1383 'classname' => 'core_notes_external',
1384 'methodname' => 'view_notes',
1385 'classpath' => 'notes/externallib.php',
1386 'description' => 'Simulates the web interface view of notes/index.php: trigger events.',
1387 'type' => 'write',
ee7295ee
JL
1388 'capabilities' => 'moodle/notes:view',
1389 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
9028d9b5 1390 ),
f23e9b6b
CB
1391 'core_output_load_template' => array(
1392 'classname' => 'core\output\external',
1393 'methodname' => 'load_template',
1394 'description' => 'Load a template for a renderable',
1395 'type' => 'read',
5041600d
RT
1396 'loginrequired' => false,
1397 'ajax' => true,
0ff4ebb4 1398 ),
e0034b5d
RW
1399 'core_output_load_template_with_dependencies' => array(
1400 'classname' => 'core\output\external',
1401 'methodname' => 'load_template_with_dependencies',
1402 'description' => 'Load a template and its dependencies for a renderable',
1403 'type' => 'read',
1404 'loginrequired' => false,
1405 'ajax' => true,
1406 ),
e330b1c2 1407 'core_output_load_fontawesome_icon_map' => array(
a26ce248 1408 'classname' => 'core\output\external',
e330b1c2 1409 'methodname' => 'load_fontawesome_icon_map',
a26ce248
DW
1410 'description' => 'Load the mapping of names to icons',
1411 'type' => 'read',
1412 'loginrequired' => false,
1413 'ajax' => true,
1414 ),
f23e9b6b
CB
1415 // Question related functions.
1416 'core_question_update_flag' => array(
1417 'classname' => 'core_question_external',
1418 'methodname' => 'update_flag',
1419 'description' => 'Update the flag state of a question attempt.',
1420 'type' => 'write',
1421 'capabilities' => 'moodle/question:flag',
ee7295ee 1422 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
3f0ea6d8 1423 ),
680d5c5b
SL
1424 'core_question_submit_tags_form' => array(
1425 'classname' => 'core_question_external',
1426 'methodname' => 'submit_tags_form',
1427 'description' => 'Update the question tags.',
1428 'type' => 'write',
1429 'ajax' => true,
1430 ),
6768729e
RW
1431 'core_question_get_random_question_summaries' => array(
1432 'classname' => 'core_question_external',
1433 'methodname' => 'get_random_question_summaries',
1434 'description' => 'Get the random question set for a criteria',
1435 'type' => 'read',
1436 'ajax' => true,
1437 ),
f23e9b6b
CB
1438 'core_rating_get_item_ratings' => array(
1439 'classname' => 'core_rating_external',
1440 'methodname' => 'get_item_ratings',
1441 'description' => 'Retrieve all the ratings for an item.',
1442 'type' => 'read',
ee7295ee
JL
1443 'capabilities' => 'moodle/rating:view',
1444 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
5d1017e1 1445 ),
afb7799a
JL
1446 'core_rating_add_rating' => array(
1447 'classname' => 'core_rating_external',
1448 'methodname' => 'add_rating',
1449 'description' => 'Rates an item.',
1450 'type' => 'write',
1451 'capabilities' => 'moodle/rating:rate',
1452 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
1453 ),
f23e9b6b
CB
1454 'core_role_assign_roles' => array(
1455 'classname' => 'core_role_external',
1456 'methodname' => 'assign_roles',
1457 'classpath' => 'enrol/externallib.php',
1458 'description' => 'Manual role assignments.',
1459 'type' => 'write',
1460 'capabilities' => 'moodle/role:assign'
0bf486a6 1461 ),
f23e9b6b
CB
1462 'core_role_unassign_roles' => array(
1463 'classname' => 'core_role_external',
1464 'methodname' => 'unassign_roles',
1465 'classpath' => 'enrol/externallib.php',
1466 'description' => 'Manual role unassignments.',
1467 'type' => 'write',
1468 'capabilities' => 'moodle/role:assign'
11e76602 1469 ),
a6cacdd2 1470 'core_search_get_relevant_users' => array(
1471 'classname' => '\core_search\external',
1472 'methodname' => 'get_relevant_users',
1473 'description' => 'Gets relevant users for a search request.',
1474 'type' => 'read',
1475 'ajax' => true
1476 ),
f23e9b6b
CB
1477 'core_tag_get_tagindex' => array(
1478 'classname' => 'core_tag_external',
1479 'methodname' => 'get_tagindex',
1480 'description' => 'Gets tag index page for one tag and one tag area',
1481 'type' => 'read',
5041600d 1482 'ajax' => true,
11e76602 1483 ),
f23e9b6b
CB
1484 'core_tag_get_tags' => array(
1485 'classname' => 'core_tag_external',
1486 'methodname' => 'get_tags',
1487 'description' => 'Gets tags by their ids',
1488 'type' => 'read',
5041600d 1489 'ajax' => true,
11e76602 1490 ),
f23e9b6b
CB
1491 'core_tag_update_tags' => array(
1492 'classname' => 'core_tag_external',
1493 'methodname' => 'update_tags',
1494 'description' => 'Updates tags',
1495 'type' => 'write',
5041600d 1496 'ajax' => true,
cc73ea07 1497 ),
cdc5f978 1498 'core_update_inplace_editable' => array(
f23e9b6b
CB
1499 'classname' => 'core_external',
1500 'methodname' => 'update_inplace_editable',
1501 'classpath' => 'lib/external/externallib.php',
cdc5f978 1502 'description' => 'Generic service to update title',
f23e9b6b 1503 'type' => 'write',
5041600d
RT
1504 'loginrequired' => true,
1505 'ajax' => true,
c66dc3df 1506 ),
f23e9b6b
CB
1507 'core_user_add_user_device' => array(
1508 'classname' => 'core_user_external',
1509 'methodname' => 'add_user_device',
1510 'classpath' => 'user/externallib.php',
1511 'description' => 'Store mobile user devices information for PUSH Notifications.',
1512 'type' => 'write',
ee7295ee 1513 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
9bdcf579 1514 ),
f23e9b6b
CB
1515 'core_user_add_user_private_files' => array(
1516 'classname' => 'core_user_external',
1517 'methodname' => 'add_user_private_files',
1518 'classpath' => 'user/externallib.php',
1519 'description' => 'Copy files from a draft area to users private files area.',
1520 'type' => 'write',
ee7295ee
JL
1521 'capabilities' => 'moodle/user:manageownfiles',
1522 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
25c49a85 1523 ),
f23e9b6b
CB
1524 'core_user_create_users' => array(
1525 'classname' => 'core_user_external',
1526 'methodname' => 'create_users',
1527 'classpath' => 'user/externallib.php',
1528 'description' => 'Create users.',
1529 'type' => 'write',
1530 'capabilities' => 'moodle/user:create'
23b398fc 1531 ),
f23e9b6b
CB
1532 'core_user_delete_users' => array(
1533 'classname' => 'core_user_external',
1534 'methodname' => 'delete_users',
1535 'classpath' => 'user/externallib.php',
1536 'description' => 'Delete users.',
1537 'type' => 'write',
1538 'capabilities' => 'moodle/user:delete'
6c785afa 1539 ),
f23e9b6b
CB
1540 'core_user_get_course_user_profiles' => array(
1541 'classname' => 'core_user_external',
1542 'methodname' => 'get_course_user_profiles',
1543 'classpath' => 'user/externallib.php',
1544 'description' => 'Get course user profiles (each of the profils matching a course id and a user id),.',
1545 'type' => 'read',
1546 'capabilities' => 'moodle/user:viewdetails, moodle/user:viewhiddendetails, moodle/course:useremail, moodle/user:update, '
ee7295ee
JL
1547 . 'moodle/site:accessallgroups',
1548 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
6c785afa 1549 ),
f23e9b6b
CB
1550 'core_user_get_users' => array(
1551 'classname' => 'core_user_external',
1552 'methodname' => 'get_users',
1553 'classpath' => 'user/externallib.php',
1554 'description' => 'search for users matching the parameters',
1555 'type' => 'read',
1556 'capabilities' => 'moodle/user:viewdetails, moodle/user:viewhiddendetails, moodle/course:useremail, moodle/user:update'
db5b6971 1557 ),
f23e9b6b
CB
1558 'core_user_get_users_by_field' => array(
1559 'classname' => 'core_user_external',
1560 'methodname' => 'get_users_by_field',
1561 'classpath' => 'user/externallib.php',
1562 'description' => 'Retrieve users\' information for a specified unique field - If you want to do a user search, use '
1563 . 'core_user_get_users()',
1564 'type' => 'read',
ee7295ee 1565 'capabilities' => 'moodle/user:viewdetails, moodle/user:viewhiddendetails, moodle/course:useremail, moodle/user:update',
5041600d 1566 'ajax' => true,
ee7295ee 1567 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
8e355853 1568 ),
f23e9b6b
CB
1569 'core_user_remove_user_device' => array(
1570 'classname' => 'core_user_external',
1571 'methodname' => 'remove_user_device',
1572 'classpath' => 'user/externallib.php',
1573 'description' => 'Remove a user device from the Moodle database.',
1574 'type' => 'write',
ee7295ee 1575 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
ef4c23cc 1576 ),
c598f278 1577 'core_user_update_users' => array(
a0eabdd3 1578 'classname' => 'core_user_external',
c598f278 1579 'methodname' => 'update_users',
a0eabdd3 1580 'classpath' => 'user/externallib.php',
c598f278 1581 'description' => 'Update users.',
a0eabdd3
RW
1582 'type' => 'write',
1583 'capabilities' => 'moodle/user:update',
1584 'ajax' => true,
1585 ),
c598f278 1586 'core_user_update_user_preferences' => array(
f23e9b6b 1587 'classname' => 'core_user_external',
c598f278 1588 'methodname' => 'update_user_preferences',
f23e9b6b 1589 'classpath' => 'user/externallib.php',
c598f278 1590 'description' => 'Update a user\'s preferences',
f23e9b6b 1591 'type' => 'write',
c598f278 1592 'capabilities' => 'moodle/user:editownmessageprofile, moodle/user:editmessageprofile',
a0eabdd3 1593 'ajax' => true,
6d2f938c 1594 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
c026a28d 1595 ),
f23e9b6b
CB
1596 'core_user_view_user_list' => array(
1597 'classname' => 'core_user_external',
1598 'methodname' => 'view_user_list',
1599 'classpath' => 'user/externallib.php',
1600 'description' => 'Simulates the web-interface view of user/index.php (triggering events),.',
1601 'type' => 'write',
1602 'capabilities' => 'moodle/course:viewparticipants',
ee7295ee 1603 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
7361b968 1604 ),
f23e9b6b
CB
1605 'core_user_view_user_profile' => array(
1606 'classname' => 'core_user_external',
1607 'methodname' => 'view_user_profile',
1608 'classpath' => 'user/externallib.php',
1609 'description' => 'Simulates the web-interface view of user/view.php and user/profile.php (triggering events),.',
1610 'type' => 'write',
1611 'capabilities' => 'moodle/user:viewdetails',
ee7295ee 1612 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
f4fb827e 1613 ),
45fec983
JL
1614 'core_user_get_user_preferences' => array(
1615 'classname' => 'core_user_external',
1616 'methodname' => 'get_user_preferences',
1617 'classpath' => 'user/externallib.php',
1618 'description' => 'Return user preferences.',
1619 'type' => 'read',
5005d8cf 1620 'ajax' => true,
45fec983
JL
1621 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
1622 ),
d44e2e42
JL
1623 'core_user_update_picture' => array(
1624 'classname' => 'core_user_external',
1625 'methodname' => 'update_picture',
1626 'classpath' => 'user/externallib.php',
1627 'description' => 'Update or delete the user picture in the site',
1628 'type' => 'write',
1629 'capabilities' => 'moodle/user:editownprofile, moodle/user:editprofile',
1630 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
1631 ),
649777fb
JL
1632 'core_user_set_user_preferences' => array(
1633 'classname' => 'core_user_external',
1634 'methodname' => 'set_user_preferences',
1635 'classpath' => 'user/externallib.php',
1636 'description' => 'Set user preferences.',
1637 'type' => 'write',
1638 'capabilities' => 'moodle/site:config',
2979ca11
JL
1639 'ajax' => true,
1640 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
649777fb 1641 ),
3e8145a3
JL
1642 'core_user_agree_site_policy' => array(
1643 'classname' => 'core_user_external',
1644 'methodname' => 'agree_site_policy',
1645 'classpath' => 'user/externallib.php',
1646 'description' => 'Agree the site policy for the current user.',
1647 'type' => 'write',
1648 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
1649 ),
f74ac6e7
JL
1650 'core_user_get_private_files_info' => array(
1651 'classname' => 'core_user_external',
1652 'methodname' => 'get_private_files_info',
1653 'classpath' => 'user/externallib.php',
1654 'description' => 'Returns general information about files in the user private files area.',
1655 'type' => 'read',
1656 'capabilities' => 'moodle/user:manageownfiles',
1657 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
1658 ),
649777fb 1659
81de839f
FM
1660 // Competencies functions.
1661 'core_competency_create_competency_framework' => array(
1662 'classname' => 'core_competency\external',
1663 'methodname' => 'create_competency_framework',
1664 'classpath' => '',
1665 'description' => 'Creates new competency frameworks.',
1666 'type' => 'write',
1667 'capabilities' => 'moodle/competency:competencymanage',
1668 'ajax' => true,
1669 ),
1670 'core_competency_read_competency_framework' => array(
1671 'classname' => 'core_competency\external',
1672 'methodname' => 'read_competency_framework',
1673 'classpath' => '',
1674 'description' => 'Load a summary of a competency framework.',
1675 'type' => 'read',
1676 'capabilities' => 'moodle/competency:competencyview',
1677 'ajax' => true,
1678 ),
1679 'core_competency_duplicate_competency_framework' => array(
1680 'classname' => 'core_competency\external',
1681 'methodname' => 'duplicate_competency_framework',
1682 'classpath' => '',
1683 'description' => 'Duplicate a competency framework.',
1684 'type' => 'write',
1685 'capabilities' => 'moodle/competency:competencymanage',
1686 'ajax' => true,
1687 ),
1688 'core_competency_delete_competency_framework' => array(
1689 'classname' => 'core_competency\external',
1690 'methodname' => 'delete_competency_framework',
1691 'classpath' => '',
1692 'description' => 'Delete a competency framework.',
1693 'type' => 'write',
1694 'capabilities' => 'moodle/competency:competencymanage',
1695 'ajax' => true,
1696 ),
1697 'core_competency_update_competency_framework' => array(
1698 'classname' => 'core_competency\external',
1699 'methodname' => 'update_competency_framework',
1700 'classpath' => '',
1701 'description' => 'Update a competency framework.',
1702 'type' => 'write',
1703 'capabilities' => 'moodle/competency:competencymanage',
1704 'ajax' => true,
1705 ),
1706 'core_competency_list_competency_frameworks' => array(
1707 'classname' => 'core_competency\external',
1708 'methodname' => 'list_competency_frameworks',
1709 'classpath' => '',
1710 'description' => 'Load a list of a competency frameworks.',
1711 'type' => 'read',
1712 'capabilities' => 'moodle/competency:competencyview',
1713 'ajax' => true,
1714 ),
1715 'core_competency_count_competency_frameworks' => array(
1716 'classname' => 'core_competency\external',
1717 'methodname' => 'count_competency_frameworks',
1718 'classpath' => '',
1719 'description' => 'Count a list of a competency frameworks.',
1720 'type' => 'read',
1721 'capabilities' => 'moodle/competency:competencyview',
1722 'ajax' => true,
1723 ),
1724 'core_competency_competency_framework_viewed' => array(
1725 'classname' => 'core_competency\external',
1726 'methodname' => 'competency_framework_viewed',
1727 'classpath' => '',
1728 'description' => 'Log event competency framework viewed',
1729 'type' => 'read',
1730 'capabilities' => 'moodle/competency:competencyview',
1731 'ajax' => true,
1732 ),
1733 'core_competency_create_competency' => array(
1734 'classname' => 'core_competency\external',
1735 'methodname' => 'create_competency',
1736 'classpath' => '',
1737 'description' => 'Creates new competencies.',
1738 'type' => 'write',
1739 'capabilities' => 'moodle/competency:competencymanage',
1740 'ajax' => true,
1741 ),
1742 'core_competency_read_competency' => array(
1743 'classname' => 'core_competency\external',
1744 'methodname' => 'read_competency',
1745 'classpath' => '',
1746 'description' => 'Load a summary of a competency.',
1747 'type' => 'read',
1748 'capabilities' => 'moodle/competency:competencyview',
1749 'ajax' => true,
1750 ),
1751 'core_competency_competency_viewed' => array(
1752 'classname' => 'core_competency\external',
1753 'methodname' => 'competency_viewed',
1754 'classpath' => '',
1755 'description' => 'Log event competency viewed',
1756 'type' => 'read',
1757 'capabilities' => 'moodle/competency:competencyview',
1758 'ajax' => true,
3123c2cf 1759 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
81de839f
FM
1760 ),
1761 'core_competency_delete_competency' => array(
1762 'classname' => 'core_competency\external',
1763 'methodname' => 'delete_competency',
1764 'classpath' => '',
1765 'description' => 'Delete a competency.',
1766 'type' => 'write',
1767 'capabilities' => 'moodle/competency:competencymanage',
1768 'ajax' => true,
1769 ),
1770 'core_competency_update_competency' => array(
1771 'classname' => 'core_competency\external',
1772 'methodname' => 'update_competency',
1773 'classpath' => '',
1774 'description' => 'Update a competency.',
1775 'type' => 'write',
1776 'capabilities' => 'moodle/competency:competencymanage',
1777 'ajax' => true,
1778 ),
1779 'core_competency_list_competencies' => array(
1780 'classname' => 'core_competency\external',
1781 'methodname' => 'list_competencies',
1782 'classpath' => '',
1783 'description' => 'Load a list of a competencies.',
1784 'type' => 'read',
1785 'capabilities' => 'moodle/competency:competencyview',
1786 'ajax' => true,
1787 ),
1788 'core_competency_list_competencies_in_template' => array(
1789 'classname' => 'core_competency\external',
1790 'methodname' => 'list_competencies_in_template',
1791 'classpath' => '',
1792 'description' => 'Load a list of a competencies for a given template.',
1793 'type' => 'read',
1794 'capabilities' => 'moodle/competency:competencyview',
1795 'ajax' => true,
1796 ),
1797 'core_competency_count_competencies' => array(
1798 'classname' => 'core_competency\external',
1799 'methodname' => 'count_competencies',
1800 'classpath' => '',
1801 'description' => 'Count a list of a competencies.',
1802 'type' => 'read',
1803 'capabilities' => 'moodle/competency:competencyview',
1804 'ajax' => true,
1805 ),
1806 'core_competency_count_competencies_in_template' => array(
1807 'classname' => 'core_competency\external',
1808 'methodname' => 'count_competencies_in_template',
1809 'classpath' => '',
1810 'description' => 'Count a list of a competencies for a given template.',
1811 'type' => 'read',
1812 'capabilities' => 'moodle/competency:competencyview',
1813 'ajax' => true,
1814 ),
1815 'core_competency_search_competencies' => array(
1816 'classname' => 'core_competency\external',
1817 'methodname' => 'search_competencies',
1818 'classpath' => '',
1819 'description' => 'Search a list of a competencies.',
1820 'type' => 'read',
1821 'capabilities' => 'moodle/competency:competencyview',
1822 'ajax' => true,
1823 ),
1824 'core_competency_set_parent_competency' => array(
1825 'classname' => 'core_competency\external',
1826 'methodname' => 'set_parent_competency',
1827 'classpath' => '',
1828 'description' => 'Set a new parent for a competency.',
1829 'type' => 'write',
1830 'capabilities' => 'moodle/competency:competencymanage',
1831 'ajax' => true,
1832 ),
1833 'core_competency_move_up_competency' => array(
1834 'classname' => 'core_competency\external',
1835 'methodname' => 'move_up_competency',
1836 'classpath' => '',
1837 'description' => 'Re-order a competency.',
1838 'type' => 'write',
1839 'capabilities' => 'moodle/competency:competencymanage',
1840 'ajax' => true,
1841 ),
1842 'core_competency_move_down_competency' => array(
1843 'classname' => 'core_competency\external',
1844 'methodname' => 'move_down_competency',
1845 'classpath' => '',
1846 'description' => 'Re-order a competency.',
1847 'type' => 'write',
1848 'capabilities' => 'moodle/competency:competencymanage',
1849 'ajax' => true,
1850 ),
1851 'core_competency_list_course_competencies' => array(
1852 'classname' => 'core_competency\external',
1853 'methodname' => 'list_course_competencies',
1854 'classpath' => '',
1855 'description' => 'List the competencies in a course',
1856 'type' => 'read',
1857 'capabilities' => 'moodle/competency:coursecompetencyview',
1858 'ajax' => true,
3123c2cf 1859 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
81de839f
FM
1860 ),
1861 'core_competency_count_competencies_in_course' => array(
1862 'classname' => 'core_competency\external',
1863 'methodname' => 'count_competencies_in_course',
1864 'classpath' => '',
1865 'description' => 'List the competencies in a course',
1866 'type' => 'read',
1867 'capabilities' => 'moodle/competency:coursecompetencyview',
1868 'ajax' => true,
1869 ),
1870 'core_competency_count_courses_using_competency' => array(
1871 'classname' => 'core_competency\external',
1872 'methodname' => 'count_courses_using_competency',
1873 'classpath' => '',
1874 'description' => 'List the courses using a competency',
1875 'type' => 'read',
1876 'capabilities' => 'moodle/competency:coursecompetencyview',
1877 'ajax' => true,
1878 ),
1879 'core_competency_add_competency_to_course' => array(
1880 'classname' => 'core_competency\external',
1881 'methodname' => 'add_competency_to_course',
1882 'classpath' => '',
1883 'description' => 'Add the competency to a course',
1884 'type' => 'write',
1885 'capabilities' => 'moodle/competency:coursecompetencymanage',
1886 'ajax' => true,
1887 ),
1888 'core_competency_add_competency_to_template' => array(
1889 'classname' => 'core_competency\external',
1890 'methodname' => 'add_competency_to_template',
1891 'classpath' => '',
1892 'description' => 'Add the competency to a template',
1893 'type' => 'write',
1894 'capabilities' => 'moodle/competency:templatemanage',
1895 'ajax' => true,
1896 ),
1897 'core_competency_remove_competency_from_course' => array(
1898 'classname' => 'core_competency\external',
1899 'methodname' => 'remove_competency_from_course',
1900 'classpath' => '',
1901 'description' => 'Remove a competency from a course',
1902 'type' => 'write',
1903 'capabilities' => 'moodle/competency:coursecompetencymanage',
1904 'ajax' => true,
1905 ),
1906 'core_competency_set_course_competency_ruleoutcome' => array(
1907 'classname' => 'core_competency\external',
1908 'methodname' => 'set_course_competency_ruleoutcome',
1909 'classpath' => '',
1910 'description' => 'Modify the ruleoutcome value for course competency',
1911 'type' => 'write',
1912 'capabilities' => 'moodle/competency:coursecompetencymanage',
1913 'ajax' => true,
1914 ),
1915 'core_competency_remove_competency_from_template' => array(
1916 'classname' => 'core_competency\external',
1917 'methodname' => 'remove_competency_from_template',
1918 'classpath' => '',
1919 'description' => 'Remove a competency from a template',
1920 'type' => 'write',
1921 'capabilities' => 'moodle/competency:templatemanage',
1922 'ajax' => true,
1923 ),
1924 'core_competency_reorder_course_competency' => array(
1925 'classname' => 'core_competency\external',
1926 'methodname' => 'reorder_course_competency',
1927 'classpath' => '',
1928 'description' => 'Move a course competency to a new relative sort order.',
1929 'type' => 'write',
1930 'capabilities' => 'moodle/competency:coursecompetencymanage',
1931 'ajax' => true,
1932 ),
1933 'core_competency_reorder_template_competency' => array(
1934 'classname' => 'core_competency\external',
1935 'methodname' => 'reorder_template_competency',
1936 'classpath' => '',
1937 'description' => 'Move a template competency to a new relative sort order.',
1938 'type' => 'write',
1939 'capabilities' => 'moodle/competency:templatemanage',
1940 'ajax' => true,
1941 ),
1942 'core_competency_create_template' => array(
1943 'classname' => 'core_competency\external',
1944 'methodname' => 'create_template',
1945 'classpath' => '',
1946 'description' => 'Creates new learning plan templates.',
1947 'type' => 'write',
1948 'capabilities' => 'moodle/competency:templatemanage',
1949 'ajax' => true,
1950 ),
1951 'core_competency_duplicate_template' => array(
1952 'classname' => 'core_competency\external',
1953 'methodname' => 'duplicate_template',
1954 'classpath' => '',
1955 'description' => 'Duplicate learning plan template.',
1956 'type' => 'write',
1957 'capabilities' => 'moodle/competency:templatemanage',
1958 'ajax' => true,
1959 ),
1960 'core_competency_read_template' => array(
1961 'classname' => 'core_competency\external',
1962 'methodname' => 'read_template',
1963 'classpath' => '',
1964 'description' => 'Load a summary of a learning plan template.',
1965 'type' => 'read',
1966 'capabilities' => 'moodle/competency:templateview',
1967 'ajax' => true,
1968 ),
1969 'core_competency_delete_template' => array(
1970 'classname' => 'core_competency\external',
1971 'methodname' => 'delete_template',
1972 'classpath' => '',
1973 'description' => 'Delete a learning plan template.',
1974 'type' => 'write',
1975 'capabilities' => 'moodle/competency:templatemanage',
1976 'ajax' => true,
1977 ),
1978 'core_competency_update_template' => array(
1979 'classname' => 'core_competency\external',
1980 'methodname' => 'update_template',
1981 'classpath' => '',
1982 'description' => 'Update a learning plan template.',
1983 'type' => 'write',
1984 'capabilities' => 'moodle/competency:templatemanage',
1985 'ajax' => true,
1986 ),
1987 'core_competency_list_templates' => array(
1988 'classname' => 'core_competency\external',
1989 'methodname' => 'list_templates',
1990 'classpath' => '',
1991 'description' => 'Load a list of a learning plan templates.',
1992 'type' => 'read',
1993 'capabilities' => 'moodle/competency:templateview',
1994 'ajax' => true,
1995 ),
1996 'core_competency_list_templates_using_competency' => array(
1997 'classname' => 'core_competency\external',
1998 'methodname' => 'list_templates_using_competency',
1999 'classpath' => '',
2000 'description' => 'Load a list of a learning plan templates for a given competency.',
2001 'type' => 'read',
2002 'capabilities' => 'moodle/competency:templateview',
2003 'ajax' => true,
2004 ),
2005 'core_competency_count_templates' => array(
2006 'classname' => 'core_competency\external',
2007 'methodname' => 'count_templates',
2008 'classpath' => '',
2009 'description' => 'Count a list of a learning plan templates.',
2010 'type' => 'read',
2011 'capabilities' => 'moodle/competency:templateview',
2012 'ajax' => true,
2013 ),
2014 'core_competency_count_templates_using_competency' => array(
2015 'classname' => 'core_competency\external',
2016 'methodname' => 'count_templates_using_competency',
2017 'classpath' => '',
2018 'description' => 'Count a list of a learning plan templates for a given competency.',
2019 'type' => 'read',
2020 'capabilities' => 'moodle/competency:templateview',
2021 'ajax' => true,
2022 ),
2023 'core_competency_create_plan' => array(
2024 'classname' => 'core_competency\external',
2025 'methodname' => 'create_plan',
2026 'classpath' => '',
2027 'description' => 'Creates a learning plan.',
2028 'type' => 'write',
2029 'capabilities' => 'moodle/competency:planmanage',
2030 'ajax' => true,
2031 ),
2032 'core_competency_update_plan' => array(
2033 'classname' => 'core_competency\external',
2034 'methodname' => 'update_plan',
2035 'classpath' => '',
2036 'description' => 'Updates a learning plan.',
2037 'type' => 'write',
2038 'capabilities' => 'moodle/competency:planmanage',
2039 'ajax' => true,
2040 ),
2041 'core_competency_complete_plan' => array(
2042 'classname' => 'core_competency\external',
2043 'methodname' => 'complete_plan',
2044 'classpath' => '',
2045 'description' => 'Complete learning plan.',
2046 'type' => 'write',
2047 'capabilities' => 'moodle/competency:planmanage',
2048 'ajax' => true,
2049 ),
2050 'core_competency_reopen_plan' => array(
2051 'classname' => 'core_competency\external',
2052 'methodname' => 'reopen_plan',
2053 'classpath' => '',
2054 'description' => 'Reopen learning plan.',
2055 'type' => 'write',
2056 'capabilities' => 'moodle/competency:planmanage',
2057 'ajax' => true,
2058 ),
2059 'core_competency_read_plan' => array(
2060 'classname' => 'core_competency\external',
2061 'methodname' => 'read_plan',
2062 'classpath' => '',
2063 'description' => 'Load a learning plan.',
2064 'type' => 'read',
2065 'capabilities' => 'moodle/competency:planviewown',
2066 'ajax' => true,
2067 ),
2068 'core_competency_delete_plan' => array(
2069 'classname' => 'core_competency\external',
2070 'methodname' => 'delete_plan',
2071 'classpath' => '',
2072 'description' => 'Delete a learning plan.',
2073 'type' => 'write',
2074 'capabilities' => 'moodle/competency:planmanage',
2075 'ajax' => true,
2076 ),
2077 'core_competency_list_user_plans' => array(
2078 'classname' => 'core_competency\external',
2079 'methodname' => 'list_user_plans',
2080 'classpath' => '',
2081 'description' => 'List a user\'s learning plans.',
2082 'type' => 'read',
2083 'capabilities' => 'moodle/competency:planviewown',
2084 'ajax' => true,
2085 ),
2086 'core_competency_list_plan_competencies' => array(
2087 'classname' => 'core_competency\external',
2088 'methodname' => 'list_plan_competencies',
2089 'classpath' => '',
2090 'description' => 'List the competencies in a plan',
2091 'type' => 'read',
2092 'capabilities' => 'moodle/competency:planviewown',
2093 'ajax' => true,
2094 ),
2095 'core_competency_add_competency_to_plan' => array(
2096 'classname' => 'core_competency\external',
2097 'methodname' => 'add_competency_to_plan',
2098 'classpath' => '',
2099 'description' => 'Add the competency to a learning plan',
2100 'type' => 'write',
2101 'capabilities' => 'moodle/competency:planmanage',
2102 'ajax' => true,
2103 ),
2104 'core_competency_remove_competency_from_plan' => array(
2105 'classname' => 'core_competency\external',
2106 'methodname' => 'remove_competency_from_plan',
2107 'classpath' => '',
2108 'description' => 'Remove the competency from a learning plan',
2109 'type' => 'write',
2110 'capabilities' => 'moodle/competency:planmanage',
2111 'ajax' => true,
2112 ),
2113 'core_competency_reorder_plan_competency' => array(
2114 'classname' => 'core_competency\external',
2115 'methodname' => 'reorder_plan_competency',
2116 'classpath' => '',
2117 'description' => 'Move a plan competency to a new relative sort order.',
2118 'type' => 'write',
2119 'capabilities' => 'moodle/competency:planmanage',
2120 'ajax' => true,
2121 ),
2122 'core_competency_plan_request_review' => array(
2123 'classname' => 'core_competency\external',
2124 'methodname' => 'plan_request_review',
2125 'classpath' => '',
2126 'description' => 'Request for a plan to be reviewed.',
2127 'type' => 'write',
2128 'capabilities' => 'moodle/competency:planmanagedraft',
2129 'ajax' => true,
2130 ),
2131 'core_competency_plan_start_review' => array(
2132 'classname' => 'core_competency\external',
2133 'methodname' => 'plan_start_review',
2134 'classpath' => '',
2135 'description' => 'Start the review of a plan.',
2136 'type' => 'write',
2137 'capabilities' => 'moodle/competency:planmanage',
2138 'ajax' => true,
2139 ),
2140 'core_competency_plan_stop_review' => array(
2141 'classname' => 'core_competency\external',
2142 'methodname' => 'plan_stop_review',
2143 'classpath' => '',
2144 'description' => 'Stop the review of a plan.',
2145 'type' => 'write',
2146 'capabilities' => 'moodle/competency:planmanage',
2147 'ajax' => true,
2148 ),
2149 'core_competency_plan_cancel_review_request' => array(
2150 'classname' => 'core_competency\external',
2151 'methodname' => 'plan_cancel_review_request',
2152 'classpath' => '',
2153 'description' => 'Cancel the review of a plan.',
2154 'type' => 'write',
2155 'capabilities' => 'moodle/competency:planmanagedraft',
2156 'ajax' => true,
2157 ),
2158 'core_competency_approve_plan' => array(
2159 'classname' => 'core_competency\external',
2160 'methodname' => 'approve_plan',
2161 'classpath' => '',
2162 'description' => 'Approve a plan.',
2163 'type' => 'write',
2164 'capabilities' => 'moodle/competency:planmanage',
2165 'ajax' => true,
2166 ),
2167 'core_competency_unapprove_plan' => array(
2168 'classname' => 'core_competency\external',
2169 'methodname' => 'unapprove_plan',
2170 'classpath' => '',
2171 'description' => 'Unapprove a plan.',
2172 'type' => 'write',
2173 'capabilities' => 'moodle/competency:planmanage',
2174 'ajax' => true,
2175 ),
2176 'core_competency_template_has_related_data' => array(
2177 'classname' => 'core_competency\external',
2178 'methodname' => 'template_has_related_data',
2179 'classpath' => '',
2180 'description' => 'Check if a template has related data',
2181 'type' => 'read',
2182 'capabilities' => 'moodle/competency:templateview',
2183 'ajax' => true,
2184 ),
2185 'core_competency_get_scale_values' => array(
2186 'classname' => 'core_competency\external',
2187 'methodname' => 'get_scale_values',
2188 'classpath' => '',
2189 'description' => 'Fetch the values for a specific scale',
2190 'type' => 'read',
2191 'capabilities' => 'moodle/competency:competencymanage',
2192 'ajax' => true,
3123c2cf 2193 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
81de839f
FM
2194 ),
2195 'core_competency_add_related_competency' => array(
2196 'classname' => 'core_competency\external',
2197 'methodname' => 'add_related_competency',
2198 'classpath' => '',
2199 'description' => 'Adds a related competency',
2200 'type' => 'write',
2201 'capabilities' => 'moodle/competency:competencymanage',
2202 'ajax' => true,
2203 ),
2204 'core_competency_remove_related_competency' => array(
2205 'classname' => 'core_competency\external',
2206 'methodname' => 'remove_related_competency',
2207 'classpath' => '',
2208 'description' => 'Remove a related competency',
2209 'type' => 'write',
2210 'capabilities' => 'moodle/competency:competencymanage',
2211 'ajax' => true,
2212 ),
2213 'core_competency_read_user_evidence' => array(
2214 'classname' => 'core_competency\external',
2215 'methodname' => 'read_user_evidence',
2216 'classpath' => '',
2217 'description' => 'Read an evidence of prior learning.',
2218 'type' => 'read',
2219 'capabilities' => 'moodle/competency:userevidenceview',
2220 'ajax' => true,
2221 ),
2222 'core_competency_delete_user_evidence' => array(
2223 'classname' => 'core_competency\external',
2224 'methodname' => 'delete_user_evidence',
2225 'classpath' => '',
2226 'description' => 'Delete an evidence of prior learning.',
2227 'type' => 'write',
2228 'capabilities' => 'moodle/competency:userevidencemanageown',
2229 'ajax' => true,
2230 ),
2231 'core_competency_create_user_evidence_competency' => array(
2232 'classname' => 'core_competency\external',
2233 'methodname' => 'create_user_evidence_competency',
2234 'classpath' => '',
2235 'description' => 'Create an evidence of prior learning relationship with a competency.',
2236 'type' => 'read',
2237 'capabilities' => 'moodle/competency:userevidencemanageown, moodle/competency:competencyview',
2238 'ajax' => true,
2239 ),
2240 'core_competency_delete_user_evidence_competency' => array(
2241 'classname' => 'core_competency\external',
2242 'methodname' => 'delete_user_evidence_competency',
2243 'classpath' => '',
2244 'description' => 'Delete an evidence of prior learning relationship with a competency.',
2245 'type' => 'write',
2246 'capabilities' => 'moodle/competency:userevidencemanageown',
2247 'ajax' => true,
2248 ),
2249 'core_competency_user_competency_cancel_review_request' => array(
2250 'classname' => 'core_competency\external',
2251 'methodname' => 'user_competency_cancel_review_request',
2252 'classpath' => '',
2253 'description' => 'Cancel a review request.',
2254 'type' => 'write',
2255 'capabilities' => 'moodle/competency:userevidencemanageown',
2256 'ajax' => true,
2257 ),
2258 'core_competency_user_competency_request_review' => array(
2259 'classname' => 'core_competency\external',
2260 'methodname' => 'user_competency_request_review',
2261 'classpath' => '',
2262 'description' => 'Request a review.',
2263 'type' => 'write',
2264 'capabilities' => 'moodle/competency:userevidencemanageown',
2265 'ajax' => true,
2266 ),
2267 'core_competency_user_competency_start_review' => array(
2268 'classname' => 'core_competency\external',
2269 'methodname' => 'user_competency_start_review',
2270 'classpath' => '',
2271 'description' => 'Start a review.',
2272 'type' => 'write',
2273 'capabilities' => 'moodle/competency:competencygrade',
2274 'ajax' => true,
2275 ),
2276 'core_competency_user_competency_stop_review' => array(
2277 'classname' => 'core_competency\external',
2278 'methodname' => 'user_competency_stop_review',
2279 'classpath' => '',
2280 'description' => 'Stop a review.',
2281 'type' => 'write',
2282 'capabilities' => 'moodle/competency:competencygrade',
2283 'ajax' => true,
2284 ),
2285 'core_competency_user_competency_viewed' => array(
2286 'classname' => 'core_competency\external',
2287 'methodname' => 'user_competency_viewed',
2288 'classpath' => '',
2289 'description' => 'Log the user competency viewed event.',
2290 'type' => 'read',
2291 'capabilities' => 'moodle/competency:usercompetencyview',
2292 'ajax' => true,
3123c2cf 2293 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
81de839f
FM
2294 ),
2295 'core_competency_user_competency_viewed_in_plan' => array(
2296 'classname' => 'core_competency\external',
2297 'methodname' => 'user_competency_viewed_in_plan',
2298 'classpath' => '',
2299 'description' => 'Log the user competency viewed in plan event.',
2300 'type' => 'read',
2301 'capabilities' => 'moodle/competency:usercompetencyview',
2302 'ajax' => true,
3123c2cf 2303 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
81de839f
FM
2304 ),
2305 'core_competency_user_competency_viewed_in_course' => array(
2306 'classname' => 'core_competency\external',
2307 'methodname' => 'user_competency_viewed_in_course',
2308 'classpath' => '',
2309 'description' => 'Log the user competency viewed in course event',
2310 'type' => 'read',
2311 'capabilities' => 'moodle/competency:usercompetencyview',
2312 'ajax' => true,
3123c2cf 2313 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
81de839f
FM
2314 ),
2315 'core_competency_user_competency_plan_viewed' => array(
2316 'classname' => 'core_competency\external',
2317 'methodname' => 'user_competency_plan_viewed',
2318 'classpath' => '',
2319 'description' => 'Log the user competency plan viewed event.',
2320 'type' => 'read',
2321 'capabilities' => 'moodle/competency:usercompetencyview',
2322 'ajax' => true,
3123c2cf 2323 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
81de839f
FM
2324 ),
2325 'core_competency_grade_competency' => array(
2326 'classname' => 'core_competency\external',
2327 'methodname' => 'grade_competency',
2328 'classpath' => '',
2329 'description' => 'Grade a competency.',
2330 'type' => 'write',
2331 'capabilities' => 'moodle/competency:competencygrade',
2332 'ajax' => true,
2333 ),
2334 'core_competency_grade_competency_in_plan' => array(
2335 'classname' => 'core_competency\external',
2336 'methodname' => 'grade_competency_in_plan',
2337 'classpath' => '',
2338 'description' => 'Grade a competency from the user plan page.',
2339 'type' => 'write',
2340 'capabilities' => 'moodle/competency:competencygrade',
2341 'ajax' => true,
2342 ),
2343 'core_competency_grade_competency_in_course' => array(
2344 'classname' => 'core_competency\external',
2345 'methodname' => 'grade_competency_in_course',
2346 'classpath' => '',
2347 'description' => 'Grade a competency from the course page.',
2348 'type' => 'write',
2349 'capabilities' => 'moodle/competency:competencygrade',
2350 'ajax' => true,
3123c2cf 2351 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
81de839f
FM
2352 ),
2353 'core_competency_unlink_plan_from_template' => array(
2354 'classname' => 'core_competency\external',
2355 'methodname' => 'unlink_plan_from_template',
2356 'classpath' => '',
2357 'description' => 'Unlink a plan form it template.',
2358 'type' => 'write',
2359 'capabilities' => 'moodle/competency:planmanage',
2360 'ajax' => true,
2361 ),
2362 'core_competency_template_viewed' => array(
2363 'classname' => 'core_competency\external',
2364 'methodname' => 'template_viewed',
2365 'classpath' => '',
2366 'description' => 'Log event template viewed',
2367 'type' => 'read',
2368 'capabilities' => 'moodle/competency:templateview',
2369 'ajax' => true,
2370 ),
2371 'core_competency_request_review_of_user_evidence_linked_competencies' => array(
2372 'classname' => 'core_competency\external',
2373 'methodname' => 'request_review_of_user_evidence_linked_competencies',
2374 'classpath' => '',
2375 'description' => 'Send user evidence competencies in review',
2376 'type' => 'write',
2377 'capabilities' => 'moodle/competency:userevidencemanageown',
2378 'ajax' => true,
2379 ),
2380 'core_competency_update_course_competency_settings' => array(
2381 'classname' => 'core_competency\external',
2382 'methodname' => 'update_course_competency_settings',
2383 'classpath' => '',
2384 'description' => 'Update the course competency settings',
2385 'type' => 'write',
2386 'capabilities' => 'moodle/competency:coursecompetencyconfigure',
2387 'ajax' => true,
2388 ),
1e99f31e
FM
2389 'core_competency_delete_evidence' => array(
2390 'classname' => 'core_competency\external',
2391 'methodname' => 'delete_evidence',
2392 'classpath' => '',
2393 'description' => 'Delete an evidence',
2394 'type' => 'write',
2395 'capabilities' => 'moodle/competency:evidencedelete',
2396 'ajax' => true,
3123c2cf 2397 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
1e99f31e 2398 ),
f23e9b6b
CB
2399
2400 'core_webservice_get_site_info' => array(
2401 'classname' => 'core_webservice_external',
2402 'methodname' => 'get_site_info',
2403 'classpath' => 'webservice/externallib.php',
2404 'description' => 'Return some site info / user info / list web service functions',
2405 'type' => 'read',
ee7295ee 2406 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
8446ba36
JL
2407 ),
2408
2409 // Blocks functions.
2410 'core_block_get_course_blocks' => array(
2411 'classname' => 'core_block_external',
2412 'methodname' => 'get_course_blocks',
2413 'description' => 'Returns blocks information for a course.',
2414 'type' => 'read',
2415 'capabilities' => '',
2416 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
2417 ),
66ef16d3 2418
0f8b2604
JL
2419 'core_block_get_dashboard_blocks' => array(
2420 'classname' => 'core_block_external',
2421 'methodname' => 'get_dashboard_blocks',
2422 'description' => 'Returns blocks information for the given user dashboard.',
2423 'type' => 'read',
2424 'capabilities' => '',
2425 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
2426 ),
2427
66ef16d3
JL
2428 // Filters functions.
2429 'core_filters_get_available_in_context' => array(
2430 'classname' => 'core_filters\external',
2431 'methodname' => 'get_available_in_context',
2432 'description' => 'Returns the filters available in the given contexts.',
2433 'type' => 'read',
2434 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
3cfff885 2435 ),
9a0df45a 2436);
c1b65883
JM
2437
2438$services = array(
96e0194c 2439 'Moodle mobile web service' => array(
12c52b91 2440 'functions' => array(), // Unused as we add the service in each function definition, third party services would use this.
96e0194c
SH
2441 'enabled' => 0,
2442 'restrictedusers' => 0,
af03513f 2443 'shortname' => MOODLE_OFFICIAL_MOBILE_SERVICE,
106c55fb
DW
2444 'downloadfiles' => 1,
2445 'uploadfiles' => 1
96e0194c
SH
2446 ),
2447);