Hierarchy

  • WebContainerBase
    • ElectronContainer

Constructors

Properties

app: any
browserWindow: any
electron: any
globalShortcut: GlobalShortcutManager

Register/unregister global keyboard shortcut with the operating system.

globalWindow: Window
hostType: string
internalIpc: any
isRemote: boolean = true
menu: any
screen: ScreenManager

Retrieve information about screen size and displays.

storage: Storage
tray: any
uuid: string
windowOptionsMap: PropertyMap = ElectronContainer.windowOptionsMap
layoutsPropertyKey: string
replaceNotificationApi: boolean = true

Gets or sets whether to replace the native web Notification API with a wrapper around showNotification.

Default

true

windowOptionsMap: PropertyMap = ...
windowOptionsPropertyKey: string

Accessors

  • get ipc(): MessageBus
  • A messaging bus for sending and receiving messages

    Returns MessageBus

  • set ipc(value: MessageBus): void
  • Parameters

    • value: MessageBus

    Returns void

  • get ipc(): MessageBus
  • Returns MessageBus

  • set ipc(value: MessageBus): void
  • Parameters

    • value: MessageBus

    Returns void

Methods

  • Parameters

    • eventName: ContainerEventType
    • listener: ((event: ContainerEventArgs) => void)
        • (event: ContainerEventArgs): void
        • Parameters

          • event: ContainerEventArgs

          Returns void

    Returns ElectronContainer

  • Parameters

    • details: TrayIconDetails
    • listener: (() => void)
        • (): void
        • Returns void

    • Optional menuItems: MenuItem[]

    Returns void

  • Parameters

    • Optional excludeSelf: boolean

    Returns Promise<void>

  • Parameters

    • url: string
    • Optional options: any

    Returns Promise<ContainerWindow>

  • Parameters

    • name: string

    Returns Promise<void>

  • Parameters

    • name: string

    Returns void

  • Parameters

    • eventName: ContainerEventType
    • eventArgs: ContainerEventArgs

    Returns void

  • Returns an absolute url

    Returns

    An absolute url

    Parameters

    • url: string

      url

    Returns string

  • Parameters

    • name: string

    Returns PersistedWindowLayout

  • Returns Promise<PersistedWindowLayout[]>

  • Parameters

    • id: string

    Returns Promise<ContainerWindow>

  • Parameters

    • name: string

    Returns Promise<ContainerWindow>

  • Gets an array of listeners for a specific event type.

    Parameters

    • eventName: string

      eventName The type of the event.

    Returns ((event: EventArgs) => void)[]

  • Parameters

    • layout: string | PersistedWindowLayout

    Returns Promise<PersistedWindowLayout>

  • Write a log message

    Parameters

    • level: "error" | "debug" | "info" | "warn"

      The log level for the entry

    • message: string

      The log message text

    Returns Promise<void>

  • Parameters

    • open: ((...args: any[]) => Window)
        • (...args: any[]): Window
        • Parameters

          • Rest ...args: any[]

          Returns Window

    • Rest ...args: any[]

    Returns Window

  • Parameters

    • args: EventArgs

    Returns void

  • Parameters

    • args: EventArgs

    Returns void

  • Returns Promise<void>

  • Parameters

    • eventName: string
    • listener: ((event: EventArgs) => void)
        • (event: EventArgs): void
        • Parameters

          • event: EventArgs

          Returns void

    Returns ((event: EventArgs) => void)

      • (event: EventArgs): void
      • Parameters

        • event: EventArgs

        Returns void

  • Parameters

    • eventName: ContainerEventType
    • listener: ((event: ContainerEventArgs) => void)
        • (event: ContainerEventArgs): void
        • Parameters

          • event: ContainerEventArgs

          Returns void

    Returns ElectronContainer

  • Parameters

    • name: string

    Returns Promise<PersistedWindowLayout>

  • Parameters

    • name: string
    • layout: PersistedWindowLayout

    Returns void

  • Parameters

    • title: string
    • Optional options: NotificationOptions

    Returns void

  • Parameters

    • listener: ((event: EventArgs) => void)
        • (event: EventArgs): void
        • Parameters

          • event: EventArgs

          Returns void

    Returns ((event: EventArgs) => void)

      • (event: EventArgs): void
      • Parameters

        • event: EventArgs

        Returns void

  • Parameters

    • eventName: string
    • listener: ((event: EventArgs) => void)
        • (event: EventArgs): void
        • Parameters

          • event: EventArgs

          Returns void

    Returns ((event: EventArgs) => void)

      • (event: EventArgs): void
      • Parameters

        • event: EventArgs

        Returns void

  • Parameters

    • eventName: ContainerEventType
    • listener: ((event: ContainerEventArgs) => void)
        • (event: ContainerEventArgs): void
        • Parameters

          • event: ContainerEventArgs

          Returns void

    Returns void

  • Parameters

    • eventName: ContainerEventType
    • eventArgs: ContainerEventArgs

    Returns void

  • Parameters

    • eventName: string

    Returns ((event: EventArgs) => void)[]

  • Parameters

    • eventName: ContainerEventType
    • listener: ((event: ContainerEventArgs) => void)
        • (event: ContainerEventArgs): void
        • Parameters

          • event: ContainerEventArgs

          Returns void

    Returns void