MDL-64018 core_message: deprecated get_contacts web service
authorMark Nelson <markn@moodle.com>
Tue, 20 Nov 2018 03:32:02 +0000 (11:32 +0800)
committerMark Nelson <markn@moodle.com>
Wed, 21 Nov 2018 03:09:11 +0000 (11:09 +0800)
lib/db/services.php
message/externallib.php
message/upgrade.txt

index 9f73923..5463631 100644 (file)
@@ -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),
     ),
index f842b85..b56cd46 100644 (file)
@@ -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.
      *
index 868178c..cc7ee4f 100644 (file)
@@ -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()