Merge pull request aws-amplify#1451 from powerful23/cognito-deprecate…

…-methods deprecate methods disableMFA and enableMFA
b1zantine · Aug 15, 2018 · 52a4a1a · 52a4a1a
2 parents bedbe81 + fe1324f
commit 52a4a1a
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 0 deletions.
diff --git a/packages/amazon-cognito-identity-js/README.md b/packages/amazon-cognito-identity-js/README.md
@@ -394,6 +394,8 @@ Note that the inputVerificationCode method needs to be defined but does not need
 
 **Use case 9.** Enabling MFA for a user on a pool that has an optional MFA setting for an authenticated user.
 
+Note: this method is now deprecated. Please use `setUserMfaPreference` instead.
+
 ```javascript
     cognitoUser.enableMFA(function(err, result) {
         if (err) {
@@ -406,6 +408,8 @@ Note that the inputVerificationCode method needs to be defined but does not need
 
 **Use case 10.** Disabling MFA for a user on a pool that has an optional MFA setting for an authenticated user.
 
+Note: this method is now deprecated. Please use `setUserMfaPreference` instead.
+
 ```javascript
     cognitoUser.disableMFA(function(err, result) {
         if (err) {

diff --git a/packages/amazon-cognito-identity-js/src/CognitoUser.js b/packages/amazon-cognito-identity-js/src/CognitoUser.js
@@ -864,6 +864,7 @@ export default class CognitoUser {
 
   /**
    * This is used by an authenticated user to enable MFA for himself
+   * @deprecated
    * @param {nodeCallback<string>} callback Called on success or error.
    * @returns {void}
    */
@@ -918,6 +919,7 @@ export default class CognitoUser {
 
   /**
    * This is used by an authenticated user to disable MFA for himself
+   * @deprecated
    * @param {nodeCallback<string>} callback Called on success or error.
    * @returns {void}
    */