MDL-63211 core_message: deprecated functions and added new API

This commit is contained in:
Mark Nelson 2018-08-30 12:08:29 +08:00
parent bacebf3738
commit 0b3eadcd96
6 changed files with 674 additions and 155 deletions

View file

@ -191,6 +191,7 @@ class core_message_external extends external_api {
/**
* Create contacts parameters description.
*
* @deprecated since Moodle 3.6
* @return external_function_parameters
* @since Moodle 2.5
*/
@ -210,6 +211,7 @@ class core_message_external extends external_api {
/**
* Create contacts.
*
* @deprecated since Moodle 3.6
* @param array $userids array of user IDs.
* @param int $userid The id of the user we are creating the contacts for
* @return external_description
@ -256,6 +258,7 @@ class core_message_external extends external_api {
/**
* Create contacts return description.
*
* @deprecated since Moodle 3.6
* @return external_description
* @since Moodle 2.5
*/
@ -263,6 +266,15 @@ class core_message_external extends external_api {
return new external_warnings();
}
/**
* Marking the method as deprecated.
*
* @return bool
*/
public static function create_contacts_is_deprecated() {
return true;
}
/**
* Delete contacts parameters description.
*
@ -334,6 +346,7 @@ class core_message_external extends external_api {
/**
* Block contacts parameters description.
*
* @deprecated since Moodle 3.6
* @return external_function_parameters
* @since Moodle 2.5
*/
@ -353,6 +366,7 @@ class core_message_external extends external_api {
/**
* Block contacts.
*
* @deprecated since Moodle 3.6
* @param array $userids array of user IDs.
* @param int $userid The id of the user we are blocking the contacts for
* @return external_description
@ -399,6 +413,7 @@ class core_message_external extends external_api {
/**
* Block contacts return description.
*
* @deprecated since Moodle 3.6
* @return external_description
* @since Moodle 2.5
*/
@ -406,9 +421,19 @@ class core_message_external extends external_api {
return new external_warnings();
}
/**
* Marking the method as deprecated.
*
* @return bool
*/
public static function block_contacts_is_deprecated() {
return true;
}
/**
* Unblock contacts parameters description.
*
* @deprecated since Moodle 3.6
* @return external_function_parameters
* @since Moodle 2.5
*/
@ -428,6 +453,7 @@ class core_message_external extends external_api {
/**
* Unblock contacts.
*
* @deprecated since Moodle 3.6
* @param array $userids array of user IDs.
* @param int $userid The id of the user we are unblocking the contacts for
* @return null
@ -467,6 +493,7 @@ class core_message_external extends external_api {
/**
* Unblock contacts return description.
*
* @deprecated since Moodle 3.6
* @return external_description
* @since Moodle 2.5
*/
@ -474,6 +501,15 @@ class core_message_external extends external_api {
return null;
}
/**
* Marking the method as deprecated.
*
* @return bool
*/
public static function unblock_contacts_is_deprecated() {
return true;
}
/**
* Return the structure of a message area contact.
*