Interface LoginMembers

Login screen members interface extending base members

interface LoginMembers {
    branding: Screens.BrandingMembers;
    client: Screens.ClientMembers;
    organization: Screens.OrganizationMembers;
    prompt: Screens.PromptMembers;
    screen: Screens.ScreenMembersOnLogin;
    tenant: Screens.TenantMembers;
    transaction: Screens.TransactionMembersOnLogin;
    untrustedData: Screens.UntrustedDataMembers;
    user: Screens.UserMembers;
    changeLanguage(options: Screens.LanguageChangeOptions): Promise<void>;
    federatedLogin(
        payload: Screens.FederatedLoginPayloadOptions,
    ): Promise<void>;
    getErrors(): Screens.Error[];
    getLoginIdentifiers(): Screens.IdentifierType[] | null;
    login(payload: Screens.LoginPayloadOptions): Promise<void>;
    pickCountryCode(payload?: Screens.CustomOptions): Promise<void>;
}

Hierarchy (View Summary)

Screens.BaseMembers
- LoginMembers

Implemented by

Login

Index

Properties

branding client organization prompt screen tenant transaction untrustedData user

Methods

changeLanguage federatedLogin getErrors getLoginIdentifiers login pickCountryCode

Properties

branding

branding: Screens.BrandingMembers

client

client: Screens.ClientMembers

organization

organization: Screens.OrganizationMembers

prompt

prompt: Screens.PromptMembers

screen

screen: Screens.ScreenMembersOnLogin

tenant

tenant: Screens.TenantMembers

transaction

transaction: Screens.TransactionMembersOnLogin

untrustedData

untrustedData: Screens.UntrustedDataMembers

user

user: Screens.UserMembers

Methods

changeLanguage

changeLanguage(options: Screens.LanguageChangeOptions): Promise<void>
Parameters
- options: Screens.LanguageChangeOptions
Returns Promise<void>
Inherited from BaseMembers.changeLanguage
- Defined in interfaces/models/base-context.ts:35

federatedLogin

federatedLogin(payload: Screens.FederatedLoginPayloadOptions): Promise<void>
Performs login with social provider
Parameters
- payload: Screens.FederatedLoginPayloadOptions
  The social login options
Returns Promise<void>
- Defined in interfaces/screens/login.ts:92

getErrors

getErrors(): Screens.Error[]
Returns Screens.Error[]
Inherited from BaseMembers.getErrors
- Defined in interfaces/models/base-context.ts:34

getLoginIdentifiers

getLoginIdentifiers(): Screens.IdentifierType[] | null
Utility Feature
Gets the active identifier types for the login screen

Returns Screens.IdentifierType[] | null
An array of active identifier types or null if none are active
- Defined in interfaces/screens/login.ts:103

login(payload: Screens.LoginPayloadOptions): Promise<void>
Performs login with username/password
Parameters
- payload: Screens.LoginPayloadOptions
  The login options
Returns Promise<void>
- Defined in interfaces/screens/login.ts:87

pickCountryCode

pickCountryCode(payload?: Screens.CustomOptions): Promise<void>
Picks country code for phone number input
Parameters
- Optionalpayload: Screens.CustomOptions
  Optional custom options
Returns Promise<void>
- Defined in interfaces/screens/login.ts:97