Interface SiteServiceInterface

Service that provides access to the currently active site

interface SiteServiceInterface {
    activeSite: SiteInterface;
    activeSiteSelected: Signal<ActiveSiteSelectedHandler>;
    loadSite(site): Promise<void>;
}

Index

Properties

activeSite activeSiteSelected

Methods

Properties

activeSite

activeSite: SiteInterface

The active site. Can be undefined in case no site is active.

activeSiteSelected

activeSiteSelected: Signal<ActiveSiteSelectedHandler>

Signal that is emitted when a site is selected. Also fires (with undefined) when a site is left.

Methods

loadSite

loadSite(site): Promise<void>
Change the active site to the provided one. If undefined, the active site is unloaded and the site selection screen is shown.
Parameters
- site: SiteInterface
  Site to load (or undefined)
Returns Promise<void>

Generated using TypeDoc