BackstageItemManager Class

Beta

Controls registering of BackstageItemProviders and calls the provider's methods when populating different parts of the User Interface.

Methods

Name Description
createCommandLauncherItemSpec(itemId: string, groupPriority: number, itemPriority: number, execute: () => void, label: string, subTitle?: string, toolTip?: string, iconSpec?: string): ActionItemSpec Static Method to create JSON object for a command launcher item  
createCustomBackstageItemSpec(providerId: string, itemId: string, groupPriority: number, itemPriority: number, label: string, subTitle?: string, toolTip?: string, iconSpec?: string): CustomItemSpec Static Method to create JSON object for a custom backstage item  
createFrontstageLauncherItemSpec(frontstageId: string, groupPriority: number, itemPriority: number, label: string, subTitle?: string, toolTip?: string, iconSpec?: string): StageLauncher Static Method to create JSON object for a stage launcher item  
getBackstageItemProvider(providerId: string): BackstageItemProvider | undefined Static Retrieves a previously loaded BackstageItemProvider.  
getBackstageItemSpecs(): BackstageItemSpec[] Static Called when the application is populating backstage so that any registered BackstageItemProvider can add their own items.  
register(itemProvider: BackstageItemProvider): void Static Registers a BackstageItemProvider with the BackstageItemManager.  
unregister(itemProviderId: string): void Static Remove a specific BackstageItemProvider from the list of available providers.  

Properties

Name Type Description
hasRegisteredProviders Accessor StaticReadOnly boolean Return true if there is any registered UiProvider.  
onBackstageItemProviderRegisteredEvent Static BeEvent<(ev: BackstageItemProviderRegisteredEventArgs) => void> Event raised any time a UiProvider is registered or unregistered.  

Defined in

Last Updated: 10 September, 2019