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