Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IModuleScreenManager

System manager for managing module's screen component. Through this you can run module's screen component.

api-version

1

user

Hierarchy

Index

Methods

  • Bind to a PiP screen component of desired module package.

    api-version

    1

    user

    Parameters

    Returns Promise<boolean>

    Return true if the request has been operated successfully, otherwise false.

  • startModuleScreen(message: Message): Promise<boolean>
  • Start a screen component of desired module package. The screen component will be display on a new screen. If the screen component already started, then the screen that contains the screen will be focused. Only a context which has a system permission could use Message.CATEGORY_FULL_SCREEN or Message.CATEGORY_POPUP_SCREEN.

    api-version

    1

    user

    Parameters

    • message: Message

      The Message which is described about desired screen component.

    Returns Promise<boolean>

    Return Fulfills with true if the request has been operated successfully, otherwise false.

  • startPipModuleScreen(message: Message, container: HTMLElement): Promise<boolean>
  • Start a PiP screen component as PiP (Picture-in-Picture) of desired module package. The screen component will be appended to caller's HTMLElement. You can only append a screen component which is defined as Message.CATEGORY_PIP_SCREEN in manifest.json - 'screens'.

    api-version

    1

    user

    Parameters

    • message: Message

      The Message which is described about desired screen component.

    • container: HTMLElement

      A caller's HTMLElement that is destination to append a screen component.

    Returns Promise<boolean>

    Return Fulfills with true if the request has been operated successfully, otherwise false.

  • stopPipModuleScreen(message: Message, container: HTMLElement): Promise<boolean>
  • Stop a PiP screen component which has been started as PiP of desired module package. The screen component will be removed from caller's HTMLElement. You can only remove a screen component which is defined as Message.CATEGORY_PIP_SCREEN in manifest.json - 'screens'.

    api-version

    1

    user

    Parameters

    • message: Message

      The Message which is described about desired screen component.

    • container: HTMLElement

      A caller's HTMLElement that is contains the desired screen component.

    Returns Promise<boolean>

    Return Fulfills with true if the request has been operated successfully, otherwise false.

Generated using TypeDoc