Class ElectronContainer

Hierarchy

WebContainerBase
- ElectronContainer

Index

Constructors

Properties

app browserWindow electron globalShortcut globalWindow hostType internalIpc isRemote menu screen storage tray uuid windowOptionsMap layoutsPropertyKey replaceNotificationApi windowOptionsMap windowOptionsPropertyKey

Accessors

ipc ipc

Constructors

constructor

new ElectronContainer(electron?: any, ipc?: any, win?: any, options?: any): ElectronContainer
Parameters
- Optional electron: any
- Optional ipc: any
- Optional win: any
- Optional options: any
Returns ElectronContainer
Overrides WebContainerBase.constructor
- Defined in desktopjs-electron/src/electron.ts:302

Properties

`Protected` app

app: any

browserWindow

browserWindow: any

`Protected` electron

electron: any

globalShortcut

globalShortcut: GlobalShortcutManager

`Readonly` globalWindow

globalWindow: Window

hostType

hostType: string

internalIpc

internalIpc: any

`Protected` isRemote

isRemote: boolean = true

`Protected` menu

menu: any

screen

screen: ScreenManager

Retrieve information about screen size and displays.

storage

storage: Storage

`Protected` tray

tray: any

uuid

uuid: string

windowOptionsMap

windowOptionsMap: PropertyMap = ElectronContainer.windowOptionsMap

`Static` `Readonly` layoutsPropertyKey

layoutsPropertyKey: string

`Static` replaceNotificationApi

replaceNotificationApi: boolean = true

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

Default

true

`Static` `Readonly` windowOptionsMap

windowOptionsMap: PropertyMap = ...

`Static` `Readonly` windowOptionsPropertyKey

windowOptionsPropertyKey: string

Accessors

ipc

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

Returns MessageBus
Inherited from WebContainerBase.ipc
- Defined in desktopjs/dist/desktopjs.d.ts:66
set ipc(value: MessageBus): void
Parameters
- value: MessageBus
Returns void
Inherited from WebContainerBase.ipc
- Defined in desktopjs/dist/desktopjs.d.ts:67

`Static` ipc

get ipc(): MessageBus
Returns MessageBus
Inherited from WebContainerBase.ipc
- Defined in desktopjs/dist/desktopjs.d.ts:61
set ipc(value: MessageBus): void
Parameters
- value: MessageBus
Returns void
Inherited from WebContainerBase.ipc
- Defined in desktopjs/dist/desktopjs.d.ts:62

Methods

addListener

addListener(eventName: ContainerEventType, listener: ((event: ContainerEventArgs) => void)): ElectronContainer
Parameters
- eventName: ContainerEventType
- listener: ((event: ContainerEventArgs) => void)
  - - (event: ContainerEventArgs): void
    - Parameters
      
      event: ContainerEventArgs
      
      Returns void
Returns ElectronContainer
Inherited from WebContainerBase.addListener
- Defined in desktopjs/dist/desktopjs.d.ts:80

addTrayIcon

addTrayIcon(details: TrayIconDetails, listener: (() => void), menuItems?: MenuItem[]): void
Parameters
- details: TrayIconDetails
- listener: (() => void)
  - - (): void
    - Returns void
- Optional menuItems: MenuItem[]
Returns void
Overrides WebContainerBase.addTrayIcon
- Defined in desktopjs-electron/src/electron.ts:482

buildLayout

buildLayout(): Promise<PersistedWindowLayout>
Returns Promise<PersistedWindowLayout>
Overrides WebContainerBase.buildLayout
- Defined in desktopjs-electron/src/electron.ts:520

`Protected` closeAllWindows

closeAllWindows(excludeSelf?: boolean): Promise<void>
Parameters
- Optional excludeSelf: boolean
Returns Promise<void>
Overrides WebContainerBase.closeAllWindows
- Defined in desktopjs-electron/src/electron.ts:498

`Protected` createMessageBus

createMessageBus(): MessageBus
Returns MessageBus
- Defined in desktopjs-electron/src/electron.ts:387

createWindow

createWindow(url: string, options?: any): Promise<ContainerWindow>
Parameters
- url: string
- Optional options: any
Returns Promise<ContainerWindow>
Overrides WebContainerBase.createWindow
- Defined in desktopjs-electron/src/electron.ts:440

deleteLayout

deleteLayout(name: string): Promise<void>
Parameters
- name: string
Returns Promise<void>
Inherited from WebContainerBase.deleteLayout
- Defined in desktopjs/dist/desktopjs.d.ts:106

`Protected` deleteLayoutFromStorage

deleteLayoutFromStorage(name: string): void
Parameters
- name: string
Returns void
Inherited from WebContainerBase.deleteLayoutFromStorage
- Defined in desktopjs/dist/desktopjs.d.ts:101

emit

emit(eventName: ContainerEventType, eventArgs: ContainerEventArgs): void
Parameters
- eventName: ContainerEventType
- eventArgs: ContainerEventArgs
Returns void
Inherited from WebContainerBase.emit
- Defined in desktopjs/dist/desktopjs.d.ts:82

`Protected` ensureAbsoluteUrl

ensureAbsoluteUrl(url: string): string
Returns an absolute url

Returns
An absolute url
Parameters
- url: string
  
  url
Returns string
Inherited from WebContainerBase.ensureAbsoluteUrl
- Defined in desktopjs/dist/desktopjs.d.ts:129

getAllWindows

getAllWindows(): Promise<ContainerWindow[]>
Returns Promise<ContainerWindow[]>
Overrides WebContainerBase.getAllWindows
- Defined in desktopjs-electron/src/electron.ts:506

getCurrentWindow

getCurrentWindow(): ContainerWindow
Returns ContainerWindow
Overrides WebContainerBase.getCurrentWindow
- Defined in desktopjs-electron/src/electron.ts:423

getInfo

getInfo(): Promise<string>
Returns Promise<string>
Overrides WebContainerBase.getInfo
- Defined in desktopjs-electron/src/electron.ts:407

`Protected` getLayoutFromStorage

getLayoutFromStorage(name: string): PersistedWindowLayout
Parameters
- name: string
Returns PersistedWindowLayout
Inherited from WebContainerBase.getLayoutFromStorage
- Defined in desktopjs/dist/desktopjs.d.ts:99

getLayouts

getLayouts(): Promise<PersistedWindowLayout[]>
Returns Promise<PersistedWindowLayout[]>
Inherited from WebContainerBase.getLayouts
- Defined in desktopjs/dist/desktopjs.d.ts:107

getMainWindow

getMainWindow(): ContainerWindow
Returns ContainerWindow
Overrides WebContainerBase.getMainWindow
- Defined in desktopjs-electron/src/electron.ts:411

getOptions

getOptions(): Promise<any>
Returns Promise<any>
Overrides WebContainerBase.getOptions
- Defined in desktopjs-electron/src/electron.ts:374

getWindowById

getWindowById(id: string): Promise<ContainerWindow>
Parameters
- id: string
Returns Promise<ContainerWindow>
Overrides WebContainerBase.getWindowById
- Defined in desktopjs-electron/src/electron.ts:510

getWindowByName

getWindowByName(name: string): Promise<ContainerWindow>
Parameters
- name: string
Returns Promise<ContainerWindow>
Overrides WebContainerBase.getWindowByName
- Defined in desktopjs-electron/src/electron.ts:515

`Protected` getWindowOptions

getWindowOptions(options?: any): any
Parameters
- Optional options: any
Returns any
- Defined in desktopjs-electron/src/electron.ts:427

listeners

listeners(eventName: string): ((event: EventArgs) => void)[]
Gets an array of listeners for a specific event type.
Parameters
- eventName: string
  
  eventName The type of the event.
Returns ((event: EventArgs) => void)[]
Inherited from WebContainerBase.listeners
- Defined in desktopjs/dist/desktopjs.d.ts:164

loadLayout

loadLayout(layout: string | PersistedWindowLayout): Promise<PersistedWindowLayout>
Parameters
- layout: string | PersistedWindowLayout
Returns Promise<PersistedWindowLayout>
Inherited from WebContainerBase.loadLayout
- Defined in desktopjs/dist/desktopjs.d.ts:103

log

log(level: "error" | "debug" | "info" | "warn", message: string): Promise<void>
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>
Inherited from WebContainerBase.log
- Defined in desktopjs/dist/desktopjs.d.ts:113

`Protected` onOpen

onOpen(open: ((...args: any[]) => Window), ...args: any[]): Window
Parameters
- open: ((...args: any[]) => Window)
  - - (...args: any[]): Window
    - Parameters
      
      Rest ...args: any[]
      
      Returns Window
- Rest ...args: any[]
Returns Window
Inherited from WebContainerBase.onOpen
- Defined in desktopjs/dist/desktopjs.d.ts:122

`Protected` postProcessArgs

postProcessArgs(args: EventArgs): void
Parameters
- args: EventArgs
Returns void
Inherited from WebContainerBase.postProcessArgs
- Defined in desktopjs/dist/desktopjs.d.ts:152

`Protected` preProcessArgs

preProcessArgs(args: EventArgs): void
Parameters
- args: EventArgs
Returns void
Inherited from WebContainerBase.preProcessArgs
- Defined in desktopjs/dist/desktopjs.d.ts:151

ready

ready(): Promise<void>
Returns Promise<void>
Inherited from WebContainerBase.ready
- Defined in desktopjs/dist/desktopjs.d.ts:36

`Protected` registerAndWrapListener

registerAndWrapListener(eventName: string, listener: ((event: EventArgs) => void)): ((event: EventArgs) => 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
Inherited from WebContainerBase.registerAndWrapListener
- Defined in desktopjs/dist/desktopjs.d.ts:149

`Protected` registerNotificationsApi

registerNotificationsApi(): void
Returns void
- Defined in desktopjs-electron/src/electron.ts:391

removeListener

removeListener(eventName: ContainerEventType, listener: ((event: ContainerEventArgs) => void)): ElectronContainer
Parameters
- eventName: ContainerEventType
- listener: ((event: ContainerEventArgs) => void)
  - - (event: ContainerEventArgs): void
    - Parameters
      
      event: ContainerEventArgs
      
      Returns void
Returns ElectronContainer
Inherited from WebContainerBase.removeListener
- Defined in desktopjs/dist/desktopjs.d.ts:81

saveLayout

saveLayout(name: string): Promise<PersistedWindowLayout>
Parameters
- name: string
Returns Promise<PersistedWindowLayout>
Inherited from WebContainerBase.saveLayout
- Defined in desktopjs/dist/desktopjs.d.ts:105

`Protected` saveLayoutToStorage

saveLayoutToStorage(name: string, layout: PersistedWindowLayout): void
Parameters
- name: string
- layout: PersistedWindowLayout
Returns void
Inherited from WebContainerBase.saveLayoutToStorage
- Defined in desktopjs/dist/desktopjs.d.ts:100

setOptions

setOptions(options: any): void
Parameters
- options: any
Returns void
Overrides WebContainerBase.setOptions
- Defined in desktopjs-electron/src/electron.ts:337

showNotification

showNotification(title: string, options?: NotificationOptions): void
Parameters
- title: string
- Optional options: NotificationOptions
Returns void
Overrides WebContainerBase.showNotification
- Defined in desktopjs-electron/src/electron.ts:469

`Protected` unwrapAndUnRegisterListener

unwrapAndUnRegisterListener(listener: ((event: EventArgs) => void)): ((event: EventArgs) => 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
Inherited from WebContainerBase.unwrapAndUnRegisterListener
- Defined in desktopjs/dist/desktopjs.d.ts:153

`Protected` wrapListener

wrapListener(eventName: string, listener: ((event: EventArgs) => void)): ((event: EventArgs) => 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
Inherited from WebContainerBase.wrapListener
- Defined in desktopjs/dist/desktopjs.d.ts:150

wrapWindow

wrapWindow(containerWindow: any): ElectronContainerWindow
Parameters
- containerWindow: any
Returns ElectronContainerWindow
Overrides WebContainerBase.wrapWindow
- Defined in desktopjs-electron/src/electron.ts:436

`Static` addListener

addListener(eventName: ContainerEventType, listener: ((event: ContainerEventArgs) => void)): void
Parameters
- eventName: ContainerEventType
- listener: ((event: ContainerEventArgs) => void)
  - - (event: ContainerEventArgs): void
    - Parameters
      
      event: ContainerEventArgs
      
      Returns void
Returns void
Inherited from WebContainerBase.addListener
- Defined in desktopjs/dist/desktopjs.d.ts:83

`Static` emit

emit(eventName: ContainerEventType, eventArgs: ContainerEventArgs): void
Parameters
- eventName: ContainerEventType
- eventArgs: ContainerEventArgs
Returns void
Inherited from WebContainerBase.emit
- Defined in desktopjs/dist/desktopjs.d.ts:85

`Static` listeners

listeners(eventName: string): ((event: EventArgs) => void)[]
Parameters
- eventName: string
Returns ((event: EventArgs) => void)[]
Inherited from WebContainerBase.listeners
- Defined in desktopjs/dist/desktopjs.d.ts:86

`Static` removeListener

removeListener(eventName: ContainerEventType, listener: ((event: ContainerEventArgs) => void)): void
Parameters
- eventName: ContainerEventType
- listener: ((event: ContainerEventArgs) => void)
  - - (event: ContainerEventArgs): void
    - Parameters
      
      event: ContainerEventArgs
      
      Returns void
Returns void
Inherited from WebContainerBase.removeListener
- Defined in desktopjs/dist/desktopjs.d.ts:84

Class ElectronContainer

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Optional electron: any

Optional ipc: any

Optional win: any

Optional options: any

Returns ElectronContainer

Properties

Protected app

browserWindow

Protected electron

globalShortcut

Readonly globalWindow

hostType

internalIpc

Protected isRemote

Protected menu

screen

storage

Protected tray

uuid

windowOptionsMap

Static Readonly layoutsPropertyKey

Static replaceNotificationApi

Default

Static Readonly windowOptionsMap

Static Readonly windowOptionsPropertyKey

Accessors

ipc

Returns MessageBus

Parameters

value: MessageBus

Returns void

Static ipc

Returns MessageBus

Parameters

value: MessageBus

Returns void

Methods

addListener

Parameters

eventName: ContainerEventType

listener: ((event: ContainerEventArgs) => void)

Parameters

event: ContainerEventArgs

Returns void

Returns ElectronContainer

addTrayIcon

Parameters

details: TrayIconDetails

listener: (() => void)

Returns void

Optional menuItems: MenuItem[]

Returns void

buildLayout

Returns Promise<PersistedWindowLayout>

Protected closeAllWindows

Parameters

Optional excludeSelf: boolean

Returns Promise<void>

Protected createMessageBus

Returns MessageBus

createWindow

Parameters

url: string

Optional options: any

Returns Promise<ContainerWindow>

deleteLayout

Parameters

name: string

Returns Promise<void>

Protected deleteLayoutFromStorage

`Optional` electron: any

`Optional` ipc: any

`Optional` win: any

`Optional` options: any

`Protected` app

`Protected` electron

`Readonly` globalWindow

`Protected` isRemote

`Protected` menu

`Protected` tray

`Static` `Readonly` layoutsPropertyKey

`Static` replaceNotificationApi

`Static` `Readonly` windowOptionsMap

`Static` `Readonly` windowOptionsPropertyKey

`Static` ipc

`Optional` menuItems: MenuItem[]

`Protected` closeAllWindows

`Optional` excludeSelf: boolean

`Protected` createMessageBus

`Optional` options: any

`Protected` deleteLayoutFromStorage

`Protected` ensureAbsoluteUrl

`Protected` getLayoutFromStorage

`Protected` getWindowOptions

`Optional` options: any

`Protected` onOpen

`Rest` ...args: any[]

`Rest` ...args: any[]

`Protected` postProcessArgs

`Protected` preProcessArgs