0c2e46165ecb3eeef3f1fad934c69556b19196c4
[moodle.git] / mod / lti / upgrade.txt
1 This files describes API changes in the lti code.
3 === 3.7 ===
5 * Deprecated functions to add support for LTI 1 tools to access services:
6     - mod_lti\local\ltiservice\service_base->check_tool_proxy()
7     - mod_lti\local\ltiservice\service_base->check_type()
8     - mod_lti\local\ltiservice\resource_base->check_tool_proxy()
9     - mod_lti\local\ltiservice\resource_base->check_type()
10     - mod_lti_edit_types_form->get_lti_advantage_services()
11   replaced by:
12     - mod_lti\local\ltiservice\service_base->check_tool()
13     - mod_lti\local\ltiservice\resource_base->check_tool()
14     - mod_lti_edit_types_form->get_lti_services()
15 * Deprecated functions to prevent name clashes with service-related parameters:
16     - mod_lti\local\ltiservice\service_base->get_configuration_parameter_names()
17     - mod_lti\local\ltiservice\service_base->get_configuration_options()
18     - ltiservice_gradebookservices\local\service\gradebookservices\get_configuration_options()
19 * Deprecated functions to simplify implementation of LTI scopes for accessing services:
20     - mod_lti\local\ltiservice\resource_base->get_permissions()
21     - ltiservice_gradebookservices\local\resources\lineitem\get_permissions()
22     - ltiservice_gradebookservices\local\resources\lineitems\get_permissions()
23     - ltiservice_gradebookservices\local\resources\results\get_permissions()
24     - ltiservice_gradebookservices\local\resources\scores\get_permissions()
25     - ltiservice_memberships\local\resources\contextmemberships\get_permissions()
26     replaced by:
27     - mod_lti\local\ltiservice\service_base->get_permitted_scopes()
28     - ltiservice_gradebookservices\local\service\gradebookservices->get_permitted_scopes()
29     - ltiservice_memberships\local\service\memberships\->get_permitted_scopes()
30 * Deprecated function to remove definition as static:
31     - ltiservice_memberships\local\service\memberships\get_users_json()
32     replaced by:
33     - ltiservice_memberships\local\service\memberships\get_members_json()
35 === 3.4 ===
37 * The following functions, previously used (exclusively) by upgrade steps are not available
38   anymore because of the upgrade cleanup performed for this version. See MDL-57432 for more info:
39     - mod_lti_upgrade_custom_separator()
41 === 3.2 ===
43 * Support for LTI ContentItem message type.
44 * New function lti_build_content_item_selection_request() for building an LTI ContentItemSelectionRequest.
45 * New Select content button in External tool configuration page that lets the user configure an external tool by fetching tool
46   configuration content from the preconfigured tool's content selection interface.
48 === 3.1 ===
50 * When requesting a grade from the outcome service, and empty grade will now be returned as
51   an empty grade in accordance with the spec. Previously a grade of 0 would be returned.
53 === 3.0 ===
55 * Function lti_view (locallib.php) was renamed to lti_launch_tool.
56   A new and different lti_view function was created in the module lib.php containing the code
57   for launching events and update the completion status for the module.
60 === 2.8 ===
62 * Support for LTI 2 added, including extensible services implemented as ltiservice plugins.
63 * Function sendOAuthBodyPOST removed from OAuthBody.php because it was not being used.
64 * The field 'grade' in the table {lti} is now an integer rather than a numeric to bring it
65   in line with the 'grade' field in other activities.
67 === 2.7 ===
69 * mod_lti\event\unknown_service_api_called now has less data stored in 'other'
70   but everything is still available for event observers via method get_message_data()