CDP Frontend SDK
    Preparing search index...

    Interface SignInState

    The state of the SignIn component.

    interface SignInState {
        authMethod: AuthMethod;
        canResetOTP: boolean;
        email: string;
        error: null | string | APIError;
        flowId: string;
        isPending: boolean;
        isSuccess: boolean;
        otp: string;
        phoneNumber: string;
        step: "credentials" | "verification";
    }
    Index

    Properties

    authMethod canResetOTP email error flowId isPending isSuccess otp phoneNumber step

    Properties

    authMethod: AuthMethod

    The auth method selected by the user.

    canResetOTP: boolean

    Whether the user can request a new OTP.

    email: string

    The email address of the user.

    error: null | string | APIError

    The error message or APIError object.

    flowId: string

    The flow ID of the current sign-in flow.

    isPending: boolean

    Whether the form state is pending.

    isSuccess: boolean

    Whether the sign-in flow is successful.

    otp: string

    The OTP code entered by the user.

    phoneNumber: string

    The phone number of the user.

    step: "credentials" | "verification"

    The current step of the sign-in flow.

    Settings

    Member Visibility

    On This Page

    Properties