Options
All
  • Public
  • Public/Protected
  • All
Menu

Module store

Index

References

Functions

References

App

Re-exports App

AppIntent

Re-exports AppIntent

AppManifestType

Re-exports AppManifestType

Image

Re-exports Image

StoreButtonConfig

Re-exports StoreButtonConfig

StoreRegistration

Re-exports StoreRegistration

StorefrontAppGrid

Re-exports StorefrontAppGrid

StorefrontDetailedNavigationItem

Re-exports StorefrontDetailedNavigationItem

StorefrontFooter

Re-exports StorefrontFooter

StorefrontLandingPage

Re-exports StorefrontLandingPage

StorefrontLandingPageBottomRow

Re-exports StorefrontLandingPageBottomRow

StorefrontLandingPageItem

Re-exports StorefrontLandingPageItem

StorefrontLandingPageMiddleRow

Re-exports StorefrontLandingPageMiddleRow

StorefrontLandingPageTopRow

Re-exports StorefrontLandingPageTopRow

StorefrontLink

Re-exports StorefrontLink

StorefrontNavigationItem

Re-exports StorefrontNavigationItem

StorefrontNavigationItemAppGrid

Re-exports StorefrontNavigationItemAppGrid

StorefrontNavigationItemBase

Re-exports StorefrontNavigationItemBase

StorefrontNavigationItemDetails

Re-exports StorefrontNavigationItemDetails

StorefrontNavigationItemLandingPage

Re-exports StorefrontNavigationItemLandingPage

StorefrontNavigationSection

Re-exports StorefrontNavigationSection

StorefrontProvider

Re-exports StorefrontProvider

StorefrontTemplate

Re-exports StorefrontTemplate

UpdateButtonConfigRequest

Re-exports UpdateButtonConfigRequest

Functions

deregister

  • 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

  • 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

register

  • 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

  • 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