Skip to content

Commit 58582b7

Browse files
committed
deprecate : Deprecate the existing MFA APIs in favor of the new MfaApiClient
1 parent 146448c commit 58582b7

1 file changed

Lines changed: 21 additions & 0 deletions

File tree

auth0/src/main/java/com/auth0/android/authentication/AuthenticationAPIClient.kt

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -174,6 +174,7 @@ public class AuthenticationAPIClient @VisibleForTesting(otherwise = VisibleForTe
174174
return loginWithToken(requestParameters)
175175
}
176176

177+
177178
/**
178179
* Log in a user using the One Time Password code after they have received the 'mfa_required' error.
179180
* The MFA token tells the server the username or email, password, and realm values sent on the first request.
@@ -196,6 +197,11 @@ public class AuthenticationAPIClient @VisibleForTesting(otherwise = VisibleForTe
196197
* MFA application such as Google Authenticator or Guardian.
197198
* @return a request to configure and start that will yield [Credentials]
198199
*/
200+
@Deprecated(
201+
message = """loginWithOTP method is deprecated and will be removed in the next major version of the SDK.
202+
"Use the APIs in the [com.auth0.android.authentication.mfa.MfaApiClient] class instead.""",
203+
level = DeprecationLevel.WARNING
204+
)
199205
public fun loginWithOTP(mfaToken: String, otp: String): AuthenticationRequest {
200206
val parameters = ParameterBuilder.newBuilder()
201207
.setGrantType(ParameterBuilder.GRANT_TYPE_MFA_OTP)
@@ -409,6 +415,11 @@ public class AuthenticationAPIClient @VisibleForTesting(otherwise = VisibleForTe
409415
* This is usually an OTP-like code delivered as part of the challenge message.
410416
* @return a request to configure and start that will yield [Credentials]
411417
*/
418+
@Deprecated(
419+
message = """loginWithOOB is deprecated and will be removed in the next major version of the SDK.
420+
"Use the APIs in the [com.auth0.android.authentication.mfa.MfaApiClient] class instead.""",
421+
level = DeprecationLevel.WARNING
422+
)
412423
public fun loginWithOOB(
413424
mfaToken: String,
414425
oobCode: String,
@@ -445,6 +456,11 @@ public class AuthenticationAPIClient @VisibleForTesting(otherwise = VisibleForTe
445456
* @return a request to configure and start that will yield [Credentials]. It might also include a [recoveryCode] field,
446457
* which your application must display to the end-user to be stored securely for future use.
447458
*/
459+
@Deprecated(
460+
message = """loginWithRecoveryCode is deprecated and will be removed in the next major version of the SDK.
461+
"Use the APIs in the [com.auth0.android.authentication.mfa.MfaApiClient] class instead.""",
462+
level = DeprecationLevel.WARNING
463+
)
448464
public fun loginWithRecoveryCode(
449465
mfaToken: String,
450466
recoveryCode: String
@@ -478,6 +494,11 @@ public class AuthenticationAPIClient @VisibleForTesting(otherwise = VisibleForTe
478494
* @param authenticatorId The ID of the authenticator to challenge.
479495
* @return a request to configure and start that will yield [Challenge]
480496
*/
497+
@Deprecated(
498+
message = """multifactorChallenge is deprecated and will be removed in the next major version of the SDK.
499+
"Use the APIs in the [com.auth0.android.authentication.mfa.MfaApiClient] class instead.""",
500+
level = DeprecationLevel.WARNING
501+
)
481502
public fun multifactorChallenge(
482503
mfaToken: String,
483504
challengeType: String? = null,

0 commit comments

Comments
 (0)