Interface SignupMembers

screen

transaction

federatedSignup

• federatedSignup(payload: Screens.FederatedSignupPayloadOptions): Promise<void>

  Parameters

  • payload: Screens.FederatedSignupPayloadOptions

  Returns Promise<void>

getSignupIdentifiers

• getSignupIdentifiers(): Screens.Identifier[] | null
  Utility Feature

  Returns a list of enabled identifiers (e.g. email, phone, username) based on the current transaction state.

  Identifiers may be required or optional depending on the connection strategy and configuration provided during the authentication or signup flow.

  Returns Screens.Identifier[] | null

  An array of enabled Identifier objects, or null if the transaction is not initialized.

  Example

  const identifiers = authClient.getSignupIdentifiers();
  if (identifiers) {
    identifiers.forEach(({ type, required }) => {
      console.log(`${type} is ${required ? 'required' : 'optional'}`);
    });
  }
  Copy

  See

  Identifier

pickCountryCode

• pickCountryCode(payload?: Screens.CustomOptions): Promise<void>

  Parameters

  • Optionalpayload: Screens.CustomOptions

  Returns Promise<void>

signup

• signup(payload: Screens.SignupPayloadOptions): Promise<void>

  Parameters

  • payload: Screens.SignupPayloadOptions

  Returns Promise<void>

validatePassword

• validatePassword(password: string): Screens.PasswordValidationResult

  Parameters

  • password: string

  Returns Screens.PasswordValidationResult

validateUsername

• validateUsername(username: string): Screens.UsernameValidationResult

  Parameters

  • username: string

  Returns Screens.UsernameValidationResult