MDL-64018 core_message: deprecated get_contacts web service

This commit is contained in:
Mark Nelson 2018-11-20 11:32:02 +08:00
parent 0225ad42ea
commit f89055372e
3 changed files with 15 additions and 1 deletions

View 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),
),

View 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.
*

View 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()