Options
All
  • Public
  • Public/Protected
  • All
Menu

Index

References

Re-exports App
Re-exports AppIntent
Re-exports AppManifestType
Re-exports Image
Re-exports StoreButtonConfig
Re-exports StoreRegistration
Re-exports StorefrontAppGrid
Re-exports StorefrontDetailedNavigationItem
Re-exports StorefrontFooter
Re-exports StorefrontLandingPage
Re-exports StorefrontLandingPageBottomRow
Re-exports StorefrontLandingPageItem
Re-exports StorefrontLandingPageMiddleRow
Re-exports StorefrontLandingPageTopRow
Re-exports StorefrontLink
Re-exports StorefrontNavigationItem
Re-exports StorefrontNavigationItemAppGrid
Re-exports StorefrontNavigationItemBase
Re-exports StorefrontNavigationItemDetails
Re-exports StorefrontNavigationItemLandingPage
Re-exports StorefrontNavigationSection
Re-exports StorefrontProvider
Re-exports StorefrontTemplate
Re-exports UpdateButtonConfigRequest

Functions

  • deregister(providerId: string): Promise<void>
  • API function to deregister a Storefront provider.

    example
    import { Storefront, StorefrontProvider } from "@openfin/workspace";

    const myStorefrontProvider: StorefrontProvider = {
    id: "my-storefront-id"
    title: "My StoreFrontProvider"
    icon: "https://cdn.openfin.co/demos/notifications/generator/images/icon-blue.png",
    getApps: () => {...},
    getNavigation: () => {...},
    getLandingPage: () => {...},
    getFooter: () => {...},
    launchApp: () => {...}
    };

    await Storefront.register(myStorefrontProvider);

    await Storefront.deregister("my-storefront-id");

    Parameters

    • providerId: string

    Returns Promise<void>

    promise - resolves once the provider is deregistered.

  • hide(): Promise<void>
  • API function to hide the Storefront window.

    example
    import { Storefront } from "@openfin/workspace";

    await Storefront.hide();

    Returns Promise<void>

    promise - invokes hide action

  • Registers a StorefrontProvider.

    Throws an error if a provider with the same id already exists.

    example
    import { Storefront, StorefrontProvider } from "@openfin/workspace";

    const myStorefrontProvider: StorefrontProvider = {
    id: "my-storefront-id"
    title: "My StorefrontProvider"
    icon: "https://cdn.openfin.co/demos/notifications/generator/images/icon-blue.png",
    getApps: () => {...},
    getNavigation: () => {...},
    getLandingPage: () => {...},
    getFooter: () => {...},
    launchApp: () => {...}
    };

    await Storefront.register(myStorefrontProvider);

    Parameters

    Returns Promise<StoreRegistration>

  • show(): Promise<void>
  • API function to show the Storefront window.

    example
    import { Storefront } from "@openfin/workspace";

    await Storefront.show();

    Returns Promise<void>

    promise - invokes show action

Generated using TypeDoc