MDL-64656 core_tag: Add existing WebServices to the mobile app service
[moodle.git] / course / upgrade.txt
CommitLineData
9df9f1f0
JL
1This files describes API changes in /course/*,
2information provided here is intended especially for developers.
3
76724712 4=== 3.7 ===
98c49e1a 5
76724712
MJ
6 * External function core_course_external::get_course_contents new returns the following additional completiondata field:
7 - valueused (indicates whether the completion state affects the availability of other content)
9b8aed89 8 * External function core_course_external::get_course_contents now returns a new contentsinfo field with summary files information.
76724712 9
a487a3ed
DK
10=== 3.6 ===
11
1206a487 12 * External function core_course_external::get_course_public_information now returns the roles and the primary role of course
a487a3ed 13 contacts.
1206a487
JL
14 * External function core_course_external::get_course_contents now return the following additional file fields:
15 - onclick (onclick javascript action code)
16 - afterlink (after link info to be displayed)
17 - customdata (module custom data (JSON encoded))
1de51367
JL
18 - completion (to indicate if completion is enabled or not)
19 - completiondata (completion status for the current user in the module)
f3507f59 20 * External function core_group_external::get_course_user_groups now can return all user courses group information.
a487a3ed 21
8c52eb2a 22=== 3.5 ===
a487a3ed 23
7afa724c 24 * There is a new capability 'moodle/course:setforcedlanguage' to control which users can force the course
8c52eb2a 25 language; create_course and update_course functions delegate access control to the caller code; if you
7afa724c 26 are calling those functions you may be interested in checking if the logged in user has 'moodle/course:setforcedlanguage' capability.
8c52eb2a 27
e45fc71e
JL
28=== 3.3 ===
29
30 * External function core_course_external::get_courses_by_field now returns the course filters list and status.
ef83fc2a 31 * External function core_course_external::get_courses_by_field now returns the end date of the course.
dbc404de
JL
32 * External function core_course_external::get_course_contents now return the following additional file fields:
33 - mimetype (the file mime type)
34 - isexternalfile (if is a file reference to a external repository)
35 - repositorytype (the repository name in case is a external file)
36 Those fields are VALUE_OPTIONAL for backwards compatibility.
935429e2
JL
37 * External function core_course_external::get_course_contents now return the following fields for section and modules:
38 - uservisible (whether the section or module is visible by the user)
39 - availabilityinfo (availability information if the course or module has any access restriction set
e45fc71e 40
9df9f1f0
JL
41=== 3.2 ===
42
43 * External function core_course_external::get_course_contents now returns the section's number in the course (new section field).
82f5802a 44 * External function core_course_external::get_course_contents now returns if a section is hidden in the course format.
14590070
JL
45 * External functions that were returning file information now return the following file fields:
46 filename, filepath, mimetype, filesize, timemodified and fileurl.
47 Those fields are now marked as VALUE_OPTIONAL for backwards compatibility.
4f2378d9
FM
48 * The modchooser now uses a renderable and a template, thus its associated renderer
49 methods have been deprecated. Note that the call to core_course_render::course_modchooser,
50 is still required. Deprecated methods:
51 - core_course_renderer::course_modchooser_module_types
52 - core_course_renderer::course_modchooser_module
53 - core_course_renderer::course_modchooser_title
8643c576
DM
54 * You can now specify a course end date when calling core_course_external::create_courses and core_course_external::update_courses
55 external functions. core_course_external::get_courses external function is now returning courses end date values.