Adding authsigninstep

aws-amplify · Nov 17, 2023 · 8c3c037 · 8c3c037
1 parent 6e138b8
commit 8c3c037
Show file tree

Hide file tree

Showing 2 changed files with 24 additions and 1 deletion.
diff --git a/core/src/main/java/com/amplifyframework/auth/result/step/AuthSignInStep.java b/core/src/main/java/com/amplifyframework/auth/result/step/AuthSignInStep.java
@@ -79,6 +79,22 @@ public enum AuthSignInStep {
      */
     CONFIRM_SIGN_IN_WITH_TOTP_CODE,
 
+    /**
+     * Passwordless is enabled on this account and requires the user to confirm with the OTP code.
+     * Call {@link com.amplifyframework.auth.AuthCategoryBehavior#confirmSignInWithOTP (String, Consumer, Consumer)}
+     * with OTP Code.
+     */
+    CONFIRM_SIGN_IN_WITH_OTP,
+
+    /**
+     * Passwordless is enabled on this account and requires the user to confirm with the Magic Link code.
+     * Call {@link
+     * com.amplifyframework.auth.AuthCategoryBehavior#confirmSignInWithMagicLink(String, Consumer, Consumer)
+     * }
+     * with OTP Code.
+     */
+    CONFIRM_SIGN_IN_WITH_MAGIC_LINK,
+
     /**
      * No further steps are needed in the sign in flow.
      */

diff --git a/rxbindings/src/main/java/com/amplifyframework/rx/RxAuthCategoryBehavior.java b/rxbindings/src/main/java/com/amplifyframework/rx/RxAuthCategoryBehavior.java
@@ -17,7 +17,6 @@
 
 import android.app.Activity;
 import android.content.Intent;
-
 import androidx.annotation.NonNull;
 import androidx.annotation.Nullable;
 
@@ -153,6 +152,8 @@ Single<AuthSignInResult> signIn(
      *             AuthPasswordlessFlow.SIGNIN for signing in.
      * @param redirectURL This is the custom URL that your app can recognize and open from an external source
      * @param options Advanced options such as a map of auth information for custom auth
+     * @return An Rx {@link Single} which emits {@link AuthSignInResult} on success,
+     * {@link AuthException} on failure
      * */
     Single<AuthSignInResult> signInWithMagicLink(
             @NonNull String username,
@@ -166,6 +167,8 @@ Single<AuthSignInResult> signInWithMagicLink(
      * activate their account.
      * @param challengeResponse challenge response that is sent to specified source
      * @param options Advanced options such as a map of auth information for custom auth
+     * @return An Rx {@link Single} which emits {@link AuthSignInResult} on success,
+     * {@link AuthException} on failure
      * */
     Single<AuthSignInResult> confirmSignInWithMagicLink(
             @NonNull String challengeResponse,
@@ -181,6 +184,8 @@ Single<AuthSignInResult> confirmSignInWithMagicLink(
      *             AuthPasswordlessFlow.SIGNIN for signing in.
      * @param destination AuthPasswordlessDeliveryDestination where OTP is sent
      * @param options Advanced options such as a map of auth information for OTP authentication
+     * @return An Rx {@link Single} which emits {@link AuthSignInResult} on success,
+     * {@link AuthException} on failure
      * */
     Single<AuthSignInResult> signInWithOTP(
             @NonNull String username,
@@ -194,6 +199,8 @@ Single<AuthSignInResult> signInWithOTP(
      * their account.
      * @param challengeResponse challenge response that is sent to specified source
      * @param options Advanced options such as a map of auth information for OTP authentication
+     * @return An Rx {@link Single} which emits {@link AuthSignInResult} on success,
+     * {@link AuthException} on failure
      * */
     Single<AuthSignInResult> confirmSignInWithOTP(
             @NonNull String challengeResponse,