message/upgrade.txt

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