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