Merge branch 'MDL-63915_master' of git://github.com/markn86/moodle
[moodle.git] / message / classes / api.php
index b033693..b15a97e 100644 (file)
@@ -151,10 +151,9 @@ class api {
     /**
      * Handles searching for user in a particular course in the message area.
      *
-     * TODO: This function should be removed once the new group messaging UI is in place and the old messaging UI is removed.
-     * For now we are not removing/deprecating this function for backwards compatibility with messaging UI.
-     * But we are deprecating data_for_messagearea_search_users_in_course external function.
-     * Followup: MDL-63915
+     * TODO: This function should be removed once the related web service goes through final deprecation.
+     * The related web service is data_for_messagearea_search_users_in_course.
+     * Followup: MDL-63261
      *
      * @param int $userid The user id doing the searching
      * @param int $courseid The id of the course we are searching in
@@ -197,10 +196,9 @@ class api {
     /**
      * Handles searching for user in the message area.
      *
-     * TODO: This function should be removed once the new group messaging UI is in place and the old messaging UI is removed.
-     * For now we are not removing/deprecating this function for backwards compatibility with messaging UI.
-     * But we are deprecating data_for_messagearea_search_users external function.
-     * Followup: MDL-63915
+     * TODO: This function should be removed once the related web service goes through final deprecation.
+     * The related web service is data_for_messagearea_search_users.
+     * Followup: MDL-63261
      *
      * @param int $userid The user id doing the searching
      * @param string $search The string the user is searching
@@ -1029,9 +1027,9 @@ class api {
     /**
      * Returns the contacts to display in the contacts area.
      *
-     * TODO: This function should be removed once the new group messaging UI is in place and the old messaging UI is removed.
-     * For now we are not removing/deprecating this function for backwards compatibility with messaging UI.
-     * Followup: MDL-63915
+     * TODO: This function should be removed once the related web service goes through final deprecation.
+     * The related web service is data_for_messagearea_contacts.
+     * Followup: MDL-63261
      *
      * @param int $userid The user id
      * @param int $limitfrom
@@ -1199,9 +1197,9 @@ class api {
     /**
      * Returns the messages to display in the message area.
      *
-     * TODO: This function should be removed once the new group messaging UI is in place and the old messaging UI is removed.
-     * For now we are not removing/deprecating this function for backwards compatibility with messaging UI.
-     * Followup: MDL-63915
+     * TODO: This function should be removed once the related web service goes through final deprecation.
+     * The related web service is data_for_messagearea_messages.
+     * Followup: MDL-63261
      *
      * @param int $userid the current user
      * @param int $otheruserid the other user
@@ -1280,9 +1278,9 @@ class api {
     /**
      * Returns the most recent message between two users.
      *
-     * TODO: This function should be removed once the new group messaging UI is in place and the old messaging UI is removed.
-     * For now we are not removing/deprecating this function for backwards compatibility with messaging UI.
-     * Followup: MDL-63915
+     * TODO: This function should be removed once the related web service goes through final deprecation.
+     * The related web service is data_for_messagearea_get_most_recent_message.
+     * Followup: MDL-63261
      *
      * @param int $userid the current user
      * @param int $otheruserid the other user
@@ -1325,9 +1323,9 @@ class api {
     /**
      * Returns the profile information for a contact for a user.
      *
-     * TODO: This function should be removed once the new group messaging UI is in place and the old messaging UI is removed.
-     * For now we are not removing/deprecating this function for backwards compatibility with messaging UI.
-     * Followup: MDL-63915
+     * TODO: This function should be removed once the related web service goes through final deprecation.
+     * The related web service is data_for_messagearea_get_profile.
+     * Followup: MDL-63261
      *
      * @param int $userid The user id
      * @param int $otheruserid The id of the user whose profile we want to view.