Interface OrganizationPickerMembers

Interface defining the available methods and properties for the organization-picker screen

interface OrganizationPickerMembers {
    branding: Screens.BrandingMembers;
    client: Screens.ClientMembers;
    organization: Screens.OrganizationMembers;
    prompt: Screens.PromptMembers;
    screen: Screens.ScreenMembers;
    tenant: Screens.TenantMembers;
    transaction: Screens.TransactionMembers;
    untrustedData: Screens.UntrustedDataMembers;
    user: Screens.UserMembers;
    changeLanguage(options: Screens.LanguageChangeOptions): Promise<void>;
    getErrors(): Screens.Error[];
    selectOrganization(
        payload: { organization: string; state: string },
    ): Promise<void>;
    skipOrganizationSelection(payload?: Screens.CustomOptions): Promise<void>;
}

Hierarchy (View Summary)

Screens.BaseMembers
- OrganizationPickerMembers

Implemented by

OrganizationPicker

Index

Properties

branding client organization prompt screen tenant transaction untrustedData user

Methods

changeLanguage getErrors selectOrganization skipOrganizationSelection

Properties

branding

branding: Screens.BrandingMembers

client

client: Screens.ClientMembers

organization

organization: Screens.OrganizationMembers

prompt

prompt: Screens.PromptMembers

screen

screen: Screens.ScreenMembers

tenant

tenant: Screens.TenantMembers

transaction

transaction: Screens.TransactionMembers

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

getErrors

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

selectOrganization

selectOrganization(
payload: { organization: string; state: string },
): Promise<void>
Selects an organization for the user.
Parameters
- payload: { organization: string; state: string }
  The options containing the organization ID.
Returns Promise<void>
- Defined in interfaces/screens/organization-picker.ts:17

skipOrganizationSelection

skipOrganizationSelection(payload?: Screens.CustomOptions): Promise<void>
Skips the organization selection, proceeding with the user's personal account.
Parameters
- Optionalpayload: Screens.CustomOptions
  Optional custom options to include with the request.
Returns Promise<void>
- Defined in interfaces/screens/organization-picker.ts:23