MDL-63547 core_message: deprecate delete_conversation web service

TheVirtualLtd · Oct 17, 2018 · fa02482 · fa02482
1 parent 15663b0
commit fa02482
Show file tree

Hide file tree

Showing 3 changed files with 18 additions and 5 deletions.
diff --git a/lib/db/services.php b/lib/db/services.php
@@ -917,7 +917,8 @@
         'classname' => 'core_message_external',
         'methodname' => 'delete_conversation',
         'classpath' => 'message/externallib.php',
-        'description' => 'Deletes a conversation.',
+        'description' => '** DEPRECATED ** Please do not call this function any more.
+                          Deletes a conversation.',
         'type' => 'write',
         'capabilities' => 'moodle/site:deleteownmessage',
         'ajax' => true,

diff --git a/message/externallib.php b/message/externallib.php
@@ -2541,6 +2541,7 @@ public static function mark_all_messages_as_read_returns() {
     /**
      * Returns description of method parameters.
      *
+     * @deprecated since 3.6
      * @return external_function_parameters
      * @since 3.2
      */
@@ -2556,6 +2557,7 @@ public static function delete_conversation_parameters() {
     /**
      * Deletes a conversation.
      *
+     * @deprecated since 3.6
      * @param int $userid The user id of who we want to delete the conversation for
      * @param int $otheruserid The user id of the other user in the conversation
      * @return array
@@ -2609,6 +2611,7 @@ public static function delete_conversation($userid, $otheruserid) {
     /**
      * Returns description of method result value.
      *
+     * @deprecated since 3.6
      * @return external_description
      * @since 3.2
      */
@@ -2621,6 +2624,15 @@ public static function delete_conversation_returns() {
         );
     }
 
+    /**
+     * Marking the method as deprecated.
+     *
+     * @return bool
+     */
+    public static function delete_conversation_is_deprecated() {
+        return true;
+    }
+
     /**
      * Returns description of method parameters
      *
@@ -3017,7 +3029,6 @@ public static function get_user_notification_preferences_returns() {
         );
     }
 
-
     /**
      * Returns description of method parameters
      *

diff --git a/message/upgrade.txt b/message/upgrade.txt
@@ -32,9 +32,10 @@ information provided here is intended especially for developers.
 * The method \core_message\api::can_delete_conversation() now expects a 'conversationid' to be passed
   as the second parameter.
 * The following web services have been deprecated. Please do not call these any more.
-  - core_message_external::block_contacts, please use core_message_external::block_user instead.
-  - core_message_external::unblock_contacts, please use core_message_external::unblock_user instead.
-  - core_message_external::create_contacts, please use core_message_external::create_contact_request instead.
+  - core_message_external::block_contacts(), please use core_message_external::block_user() instead.
+  - core_message_external::unblock_contacts(), please use core_message_external::unblock_user() instead.
+  - core_message_external::create_contacts(), please use core_message_external::create_contact_request() instead.
+  - core_message_external::delete_conversation(), please use core_message_external::delete_conversation_by_id() instead.
 
 === 3.5 ===