Merge pull request #425 from auth0/rf-canceled-auth

Deprecate isAuthenticationCanceled in favor of isCanceled
auth0 · Jan 11, 2021 · 1b3c05e · 1b3c05e
2 parents deee9bf + 9aaaea5
commit 1b3c05e
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 0 deletions.
diff --git a/auth0/src/main/java/com/auth0/android/authentication/AuthenticationException.kt b/auth0/src/main/java/com/auth0/android/authentication/AuthenticationException.kt
@@ -143,7 +143,11 @@ public class AuthenticationException : Auth0Exception {
         get() = "a0.invalid_configuration" == code
 
     // When a user closes the browser app and in turn, cancels the authentication
+    @Deprecated("This property can refer to both log in and log out actions.", replaceWith = ReplaceWith("isCanceled"))
     public val isAuthenticationCanceled: Boolean
+        get() = isCanceled
+
+    public val isCanceled: Boolean
         get() = "a0.authentication_canceled" == code
 
     /// When MFA code is required to authenticate

diff --git a/auth0/src/test/java/com/auth0/android/authentication/AuthenticationExceptionTest.kt b/auth0/src/test/java/com/auth0/android/authentication/AuthenticationExceptionTest.kt
@@ -408,6 +408,15 @@ public class AuthenticationExceptionTest {
         MatcherAssert.assertThat(ex.isAuthenticationCanceled, CoreMatchers.`is`(true))
     }
 
+    @Test
+    public fun shouldHaveCanceled() {
+        values[CODE_KEY] = "a0.authentication_canceled"
+        val ex = AuthenticationException(
+            values
+        )
+        MatcherAssert.assertThat(ex.isCanceled, CoreMatchers.`is`(true))
+    }
+
     @Test
     public fun shouldHavePasswordLeaked() {
         values[CODE_KEY] = "password_leaked"