Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface that contains functions for integrating with Storefront.

Hierarchy

  • StorefrontAPI

Index

Methods

deregister

  • deregister(id: string): Promise<void>
  • Deregister a provider.

    Parameters

    • id: string

      the id of the provider.

    Returns Promise<void>

hide

  • hide(): Promise<void>
  • Hides the Storefront window. Awaits for the latest [[Storefront.register()]] internally, so you don't have to. Throws an error if a StorefrontProvider doesn't exist (i.e., because register() was not called previously).

    Returns Promise<void>

register

  • Registers a StorefrontProvider. Upon registering a provider, the title of your provider appears in the menu of the Storefront UI. When a user selects your Storefront, the methods on the provider object are called to populate the UI. Throws an error if a provider with the same id already exists.

    Parameters

    Returns Promise<void>

show

  • show(): Promise<void>
  • Shows the Storefront window. Awaits for the latest [[Storefront.register()]] internally, so you don't have to. Throws an error if a StorefrontProvider doesn't exist (i.e., because register() not called previously).

    Returns Promise<void>

Generated using TypeDoc