Interface ModeSwitchServiceInterface

interface ModeSwitchServiceInterface {
getAvailableModes(): ModeState[];
switchToMode(name: ModeState, onClose?: (() => {})): Promise<void>;
}

Index

Methods

getAvailableModes switchToMode

Methods

getAvailableModes

getAvailableModes(): ModeState[]
This method will return the currently available modes considering the site's state (published or draft).

Returns ModeState[]
Array list of modeState names.

switchToMode

switchToMode(name, onClose?): Promise<void>
Switch to given mode if authorized. Closes current mode and related toolbox.
Parameters
- name: ModeState
  The mode to switch to
- OptionalonClose: (() => {})
  Callback when the mode is closed
  - - (): {}
    - Returns {}
Returns Promise<void>