Skip to main content
Login screen members interface extending base members
Example
export interface LoginMembers extends BaseMembers {
  screen: ScreenMembersOnLogin;
  transaction: TransactionMembersOnLogin;
  /**
   * Performs login with username/password
   * @param payload The login options
   */
  login(payload: LoginOptions): Promise<void>;
  /**
   * Performs login with social provider
   * @param payload The social login options
   */
  federatedLogin(payload: FederatedLoginOptions): Promise<void>;
  /**
   * Picks country code for phone number input
   * @param payload Optional custom options
   */
  pickCountryCode(payload?: CustomOptions): Promise<void>;
  /**
   * Gets the active identifier types for the login screen
   * @returns An array of active identifier types or null if none are active
   * @utilityFeature
   */
  getLoginIdentifiers(): IdentifierType[] | null;
}

Properties

branding
client
organization
prompt
screen
tenant
transaction
untrustedData
user

Methods

federatedLogin
Promise<void>
Performs login with social provider
getLoginIdentifiers
Utility FeatureGets the active identifier types for the login screenAn array of active identifier types or null if none are active
login
Promise<void>
Performs login with username/password
pickCountryCode
Promise<void>
Picks country code for phone number input