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