From f89055372e6b382adeee6c3d2598b135f5627abd Mon Sep 17 00:00:00 2001
From: Mark Nelson <markn@moodle.com>
Date: Tue, 20 Nov 2018 11:32:02 +0800
Subject: [PATCH] MDL-64018 core_message: deprecated get_contacts web service

---
 lib/db/services.php     |  3 ++-
 message/externallib.php | 12 ++++++++++++
 message/upgrade.txt     |  1 +
 3 files changed, 15 insertions(+), 1 deletion(-)

diff --git a/lib/db/services.php b/lib/db/services.php
index 9f7392362d9..54636310e99 100644
--- a/lib/db/services.php
+++ b/lib/db/services.php
@@ -1075,7 +1075,8 @@ $functions = array(
         'classname' => 'core_message_external',
         'methodname' => 'get_contacts',
         'classpath' => 'message/externallib.php',
-        'description' => 'Retrieve the contact list',
+        'description' => '** DEPRECATED ** Please do not call this function any more.
+                          Retrieve the contact list',
         'type' => 'read',
         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
     ),
diff --git a/message/externallib.php b/message/externallib.php
index f842b85a2f2..b56cd464845 100644
--- a/message/externallib.php
+++ b/message/externallib.php
@@ -2391,6 +2391,7 @@ class core_message_external extends external_api {
     /**
      * Get contacts parameters description.
      *
+     * @deprecated since 3.6
      * @return external_function_parameters
      * @since Moodle 2.5
      */
@@ -2401,6 +2402,7 @@ class core_message_external extends external_api {
     /**
      * Get contacts.
      *
+     * @deprecated since 3.6
      * @return external_description
      * @since Moodle 2.5
      */
@@ -2482,6 +2484,7 @@ class core_message_external extends external_api {
     /**
      * Get contacts return description.
      *
+     * @deprecated since 3.6
      * @return external_description
      * @since Moodle 2.5
      */
@@ -2528,6 +2531,15 @@ class core_message_external extends external_api {
         );
     }
 
+    /**
+     * Marking the method as deprecated.
+     *
+     * @return bool
+     */
+    public static function get_contacts_is_deprecated() {
+        return true;
+    }
+
     /**
      * Search contacts parameters description.
      *
diff --git a/message/upgrade.txt b/message/upgrade.txt
index 868178cf154..cc7ee4fda52 100644
--- a/message/upgrade.txt
+++ b/message/upgrade.txt
@@ -49,6 +49,7 @@ information provided here is intended especially for developers.
   - core_message_external::data_for_messagearea_messages().
   - core_message_external::data_for_messagearea_get_most_recent_message().
   - core_message_external::data_for_messagearea_get_profile().
+  - core_message_external::get_contacts().
 * The following function has been added for getting the privacy messaging preference:
   - get_user_privacy_messaging_preference()