Interface OrganizationPickerMembers

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

interface OrganizationPickerMembers {
    branding: BrandingMembers;
    client: ClientMembers;
    organization: OrganizationMembers;
    prompt: PromptMembers;
    screen: ScreenMembers;
    tenant: TenantMembers;
    transaction: TransactionMembers;
    untrustedData: UntrustedDataMembers;
    user: UserMembers;
    selectOrganization(payload: {
        organization: string;
        state: string;
    }): Promise<void>;
    skipOrganizationSelection(payload?: CustomOptions): Promise<void>;
}

Hierarchy

  • BaseMembers
    • OrganizationPickerMembers

Implemented by

Properties

branding: BrandingMembers
organization: OrganizationMembers
transaction: TransactionMembers
untrustedData: UntrustedDataMembers

Methods

  • Selects an organization for the user.

    Parameters

    • payload: {
          organization: string;
          state: string;
      }

      The options containing the organization ID.

      • organization: string
      • state: string

    Returns Promise<void>

  • Skips the organization selection, proceeding with the user's personal account.

    Parameters

    • Optionalpayload: CustomOptions

      Optional custom options to include with the request.

    Returns Promise<void>