MDL-63466 core_message: deprecated methods and services
[moodle.git] / message / upgrade.txt
1 This files describes API changes in /message/ messaging system,
2 information provided here is intended especially for developers.
4 === 3.6 ===
6 * The following functions have been finally deprecated and can not be used anymore:
7   * message_get_course_contexts()
8   * message_remove_url_params()
9   * message_count_messages()
10   * message_count_blocked_users()
11   * message_contact_link()
12   * message_history_link()
13   * message_shorten_message()
14   * message_get_fragment()
15   * message_get_contact_add_remove_link()
16   * message_get_contact_block_link()
17   * message_mark_messages_read()
18   * message_page_type_list()
19   * message_can_post_message()
20   * message_is_user_non_contact_blocked()
21   * message_is_user_blocked()
22 * The following functions have been deprecated and should not be used any more:
23   - message_add_contact()
24   - message_remove_contact()
25   - message_unblock_contact()
26   - message_block_contact()
27   - message_get_contact()
28   Please see their declaration in lib/deprecatedlib.php to view their alternatives (if applicable).
29 * The following methods have been deprecated and should not be used any more:
30   - \core_message\api::is_user_blocked()
31   - \core_message\api::delete_conversation()
32   - \core_message\api::is_user_non_contact_blocked()
33   - \core_message\api::create_conversation_between_users()
34   - \core_message\api::get_messages()
35   - \core_message\api::get_most_recent_message()
36   - \core_message\helper::get_messages()
37   - \core_message\helper::create_messages()
38 * The method \core_message\api::can_delete_conversation() now expects a 'conversationid' to be passed
39   as the second parameter.
40 * The following web services have been deprecated. Please do not call these any more.
41   - core_message_external::block_contacts(), please use core_message_external::block_user() instead.
42   - core_message_external::unblock_contacts(), please use core_message_external::unblock_user() instead.
43   - core_message_external::create_contacts(), please use core_message_external::create_contact_request() instead.
44   - core_message_external::delete_conversation(), please use core_message_external::delete_conversations_by_id() instead.
45   - core_message_external::core_message_mark_all_messages_as_read(), please use
46     core_message_external::core_message_mark_all_conversation_messages_as_read() instead.
47 * The following function has been added for getting the privacy messaging preference:
48   - get_user_privacy_messaging_preference()
50 === 3.5 ===
52 * Changed the database structure so there are no longer two tables for messages, with the only
53   difference being that one stores read messages. The 'message' and 'message_read' tables are
54   still present in core but will no longer be populated by core APIs. The data will be
55   transferred to the new database structure via an ad-hoc task. Please be patient. This can
56   take time.
57   The new database structure is as follows -
58   'messages' - Stores the messages with a 'useridfrom' field specifying the user who sent the
59                message and a 'conversationid' field specifying which conversation it is for.
60   'message_conversations' - The list of conversations.
61   'message_conversation_members' - The list of users in each conversation.
62   'message_user_actions' - The list of user actions against a message, eg. read/deleted.
63   'notifications' - This has a very similar structure to the old table 'message' and still
64                     has a one-to-one relation between users.
65   Due to these huge differences the events message_sent, message_deleted and message_viewed
66   have changed quite a lot. Please, if you have any observers or are triggering these events
67   in your code you will have to make some changes!
68 * The webservice external function 'core_message_mark_message_read' now only marks messages as
69   read, and not notifications. A new external function 'core_message_mark_notification_read' was
70   added to mark notifications as read.
71 * Deprecated the following functions.
72   - message_move_userfrom_unread2read
73   - message_get_blocked_users
74   - message_get_contacts
75   - message_mark_message_read
76   - message_can_delete_message
77   - message_delete_message
78   - \core_message\api::mark_all_read_for_user
79   Please see their declaration in lib/deprecatedlib.php to view their alternatives (if applicable).
80 * Final deprecation of the following functions.
81   - message_get_recent_notifications
82   - message_search
83   - message_get_history
84   - message_get_recent_conversations
85 * Added new events for when a notification is sent and viewed.
86 * Removed the database table 'message_working'. The 'message_working' table was introduced when
87   the messaging system was first introduced in Moodle, so, a long time ago. It was never necessary.
88 * Replaced the usage of the table 'message_popup' to a new table 'message_popup_notifications'.
90 === 3.2 ===
92 * Removed all message_print_* functions as well as the files search.html, search_advanced.html and
93   send_form.php due to messaging UI rehaul.
94 * Deprecated the following functions as they are no longer used.
95     - message_get_course_contexts
96     - message_remove_url_params
97     - message_count_messages
98     - message_count_blocked_users
99     - message_contact_link
100     - message_get_recent_notifications
101     - message_history_link
102     - message_search
103     - message_shorten_message
104     - message_get_fragment
105     - message_get_history
106     - message_get_contact_add_remove_link
107     - message_get_contact_block_link
108     - message_mark_messages_read
109     - message_page_type_list
110     - message_can_post_message
111     - message_is_user_non_contact_blocked
112     - message_is_user_blocked
114 === 3.1 ===
115 * get_message_processors accepts an addition parameter for testing, which will just reset processor and exit.
116 * Deprecated method message_current_user_is_involved() has been removed.
118 === 2.9 ===
119 * Renderer method \core_message_renderer::manage_messagingoptions now accepts a user id parameter as well.
121 === 2.6 ===
122 * Message processor extending message_output, should return true in can_send_to_any_users()
123   if it supports message sending to internal (noreply/support) users.
124 * Message API has been changed to allow attachments. Message processors that can support
125   attachments can now use additional parameter as a part of $eventdata. To send attachments,
126   $eventdata should contain properties called "attachment" (must be stored_file) and
127   "attachname" (string). Currently, email message processor is the only one to support
128   attachments.
130 === 2.2 ===
132 required changes:
133 * lib/messagelib.php message_send($eventdata)
134   $eventdata->userto should contain a property called "emailstop", $eventdata->userto->emailstop
135   If it is absent it will be retrieved from the user table causing an additional database query