Class WebContainerBase`Abstract`

Represents a common Container to be used as a base for any custom web based implementation.

Hierarchy

ContainerBase
- WebContainerBase
  - DefaultContainer

Constructors

constructor

new WebContainerBase(win?: Window): WebContainerBase
Parameters
- Optional win: Window
Returns WebContainerBase
Overrides ContainerBase.constructor
- Defined in desktopjs/src/container.ts:344

Properties

globalShortcut

globalShortcut: GlobalShortcutManager

`Readonly` globalWindow

globalWindow: Window

hostType

hostType: string

Display type of current Container.

screen

screen: ScreenManager

Retrieve information about screen size and displays.

storage

storage: Storage = ...

Persistent storage

uuid

uuid: string = ...

Unique v4 GUID for this Container instance

`Static` `Readonly` layoutsPropertyKey

layoutsPropertyKey: string = "desktopJS-layouts"

`Static` `Readonly` windowOptionsPropertyKey

windowOptionsPropertyKey: string = "desktopJS-options"

Accessors

ipc

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

Returns MessageBus
Inherited from ContainerBase.ipc
- Defined in desktopjs/src/container.ts:124
set ipc(value: MessageBus): void
Parameters
- value: MessageBus
Returns void
Inherited from ContainerBase.ipc
- Defined in desktopjs/src/container.ts:128

`Static` ipc

get ipc(): MessageBus
Returns MessageBus
Inherited from ContainerBase.ipc
- Defined in desktopjs/src/container.ts:113
set ipc(value: MessageBus): void
Set message bus used for static event broadcasting across windows.
Parameters
- value: MessageBus
Returns void
Inherited from ContainerBase.ipc
- Defined in desktopjs/src/container.ts:117

Methods

addListener

addListener(eventName: ContainerEventType, listener: ((event: ContainerEventArgs) => void)): WebContainerBase
Registers an event listener on the specified event.
Parameters
- eventName: ContainerEventType
  
  The type of the event.
- listener: ((event: ContainerEventArgs) => void)
  
  The event handler function.
  - - (event: ContainerEventArgs): void
    - Parameters
      
      event: ContainerEventArgs
      
      Returns void
Returns WebContainerBase
Inherited from ContainerBase.addListener
- Defined in desktopjs/src/container.ts:147

addTrayIcon

addTrayIcon(details: TrayIconDetails, listener?: (() => void), menuItems?: MenuItem[]): void
Adds an icon and context menu to the system notification area.
Parameters
- details: TrayIconDetails
  
  Details for the tray icon.
- Optional listener: (() => void)
  
  (Optional) Callback for when the tray icon is clicked.
  - - (): void
    - Returns void
- Optional menuItems: MenuItem[]
  
  (Optional) Context menu.
Returns void
Inherited from ContainerBase.addTrayIcon
- Defined in desktopjs/src/container.ts:190

`Abstract` buildLayout

buildLayout(): Promise<PersistedWindowLayout>
Builds the current window layout

Returns Promise<PersistedWindowLayout>
Inherited from ContainerBase.buildLayout
- Defined in desktopjs/src/container.ts:291

`Protected` `Abstract` closeAllWindows

closeAllWindows(excludeSelf?: boolean): Promise<void>
Parameters
- Optional excludeSelf: boolean
Returns Promise<void>
Inherited from ContainerBase.closeAllWindows
- Defined in desktopjs/src/container.ts:229

`Abstract` createWindow

createWindow(url: string, options?: any): Promise<ContainerWindow>
Creates a new ContainerWindow.

Returns
A new native container window wrapped within a generic ContainerWindow.
Parameters
- url: string
  
  url
- Optional options: any
  
  (Optional)
Returns Promise<ContainerWindow>
Inherited from ContainerBase.createWindow
- Defined in desktopjs/src/container.ts:78

deleteLayout

deleteLayout(name: string): Promise<void>
Persists a window layout
Parameters
- name: string
  
  Name of the window layout to delete
Returns Promise<void>
Inherited from ContainerBase.deleteLayout
- Defined in desktopjs/src/container.ts:299

`Protected` deleteLayoutFromStorage

deleteLayoutFromStorage(name: string): void
Parameters
- name: string
Returns void
Inherited from ContainerBase.deleteLayoutFromStorage
- Defined in desktopjs/src/container.ts:216

emit

emit(eventName: ContainerEventType, eventArgs: ContainerEventArgs): void
Invokes each listener registered for the specified event type.
Parameters
- eventName: ContainerEventType
  
  The type of the event.
- eventArgs: ContainerEventArgs
Returns void
Inherited from ContainerBase.emit
- Defined in desktopjs/src/container.ts:155

`Protected` ensureAbsoluteUrl

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

Returns
An absolute url
Parameters
- url: string
  
  url
Returns string
- Defined in desktopjs/src/container.ts:374

`Abstract` getAllWindows

getAllWindows(): Promise<ContainerWindow[]>
Retrieves a list of ContainerWindow wrapped native windows.

Returns
- A promise that returns an array of ContainerWindow if resolved
Returns Promise<ContainerWindow[]>
Inherited from ContainerBase.getAllWindows
- Defined in desktopjs/src/container.ts:100

`Abstract` getCurrentWindow

getCurrentWindow(): ContainerWindow
Gets the current ContainerWindow

Returns
The current ContainerWindow

Returns ContainerWindow
Inherited from ContainerBase.getCurrentWindow
- Defined in desktopjs/src/container.ts:76

getInfo

getInfo(): Promise<string>
Returns Promise<string>
Inherited from ContainerBase.getInfo
- Defined in desktopjs/src/container.ts:60

`Protected` getLayoutFromStorage

getLayoutFromStorage(name: string): PersistedWindowLayout
Parameters
- name: string
Returns PersistedWindowLayout
Inherited from ContainerBase.getLayoutFromStorage
- Defined in desktopjs/src/container.ts:198

getLayouts

getLayouts(): Promise<PersistedWindowLayout[]>
Retrieve a list of persisted window layouts

Returns
- A promise that returns an array of PersistedWindowLayout if resolved
Returns Promise<PersistedWindowLayout[]>
Inherited from ContainerBase.getLayouts
- Defined in desktopjs/src/container.ts:303

`Abstract` getMainWindow

getMainWindow(): ContainerWindow
Gets the main ContainerWindow of the application.

Returns
The main ContainerWindow.

Returns ContainerWindow
Inherited from ContainerBase.getMainWindow
- Defined in desktopjs/src/container.ts:74

`Abstract` getOptions

getOptions(): Promise<any>
Returns Promise<any>
Inherited from ContainerBase.getOptions
- Defined in desktopjs/src/container.ts:111

`Abstract` getWindowById

getWindowById(id: string): Promise<ContainerWindow>
Retrieve a ContainerWindow with provided id.

Returns
- A promise that returns a {ContainerWindow} if resolved
Parameters
- id: string
Returns Promise<ContainerWindow>
Inherited from ContainerBase.getWindowById
- Defined in desktopjs/src/container.ts:102

`Abstract` getWindowByName

getWindowByName(name: string): Promise<ContainerWindow>
Retrieve a ContainerWindow with provided name.

Returns
- A promise that returns a {ContainerWindow} if resolved
Parameters
- name: string
Returns Promise<ContainerWindow>
Inherited from ContainerBase.getWindowByName
- Defined in desktopjs/src/container.ts:104

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 ContainerBase.listeners
- Defined in desktopjs/src/events.ts:113

loadLayout

loadLayout(layout: string | PersistedWindowLayout): Promise<PersistedWindowLayout>
Loads a window layout

Returns
- A promise that returns PersistedWindowLayout that is loaded
Parameters
- layout: string | PersistedWindowLayout
Returns Promise<PersistedWindowLayout>
Inherited from ContainerBase.loadLayout
- Defined in desktopjs/src/container.ts:231

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 ContainerBase.log
- Defined in desktopjs/src/container.ts:316

`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
- Defined in desktopjs/src/container.ts:363

`Protected` postProcessArgs

postProcessArgs(args: EventArgs): void
Parameters
- args: EventArgs
Returns void
Inherited from ContainerBase.postProcessArgs
- Defined in desktopjs/src/events.ts:76

`Protected` preProcessArgs

preProcessArgs(args: EventArgs): void
Parameters
- args: EventArgs
Returns void
Inherited from ContainerBase.preProcessArgs
- Defined in desktopjs/src/events.ts:72

ready

ready(): Promise<void>
Returns Promise<void>
Inherited from ContainerBase.ready
- Defined in desktopjs/src/container.ts:70

`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 ContainerBase.registerAndWrapListener
- Defined in desktopjs/src/events.ts:56

removeListener

removeListener(eventName: ContainerEventType, listener: ((event: ContainerEventArgs) => void)): WebContainerBase
Removes a previous registered event listener from the specified event.
Parameters
- eventName: ContainerEventType
  
  The type of the event.
- listener: ((event: ContainerEventArgs) => void)
  
  The event handler function.
  - - (event: ContainerEventArgs): void
    - Parameters
      
      event: ContainerEventArgs
      
      Returns void
Returns WebContainerBase
Inherited from ContainerBase.removeListener
- Defined in desktopjs/src/container.ts:151

saveLayout

saveLayout(name: string): Promise<PersistedWindowLayout>
Persists a window layout

Returns
- A promise that returns PersistedWindowLayout if resolved
Parameters
- name: string
  
  Name of the window layout to save
Returns Promise<PersistedWindowLayout>
Inherited from ContainerBase.saveLayout
- Defined in desktopjs/src/container.ts:293

`Protected` saveLayoutToStorage

saveLayoutToStorage(name: string, layout: PersistedWindowLayout): void
Parameters
- name: string
- layout: PersistedWindowLayout
Returns void
Inherited from ContainerBase.saveLayoutToStorage
- Defined in desktopjs/src/container.ts:202

`Abstract` setOptions

setOptions(options: any): any
Set information on the container based on the options
Parameters
- options: any
Returns any
Inherited from ContainerBase.setOptions
- Defined in desktopjs/src/container.ts:109

showNotification

showNotification(title: string, options?: NotificationOptions): void
Display a notification.
Parameters
- title: string
  
  Defines a title for the notification. Depending on container and choice of notification mechanism, this might not be shown.
- Optional options: NotificationOptions
  
  Notification options.
Returns void
Inherited from ContainerBase.showNotification
- Defined in desktopjs/src/container.ts:186

`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 ContainerBase.unwrapAndUnRegisterListener
- Defined in desktopjs/src/events.ts:82

`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 ContainerBase.wrapListener
- Defined in desktopjs/src/events.ts:62

`Abstract` wrapWindow

wrapWindow(window: any): ContainerWindow
Parameters
- window: any
Returns ContainerWindow
- Defined in desktopjs/src/container.ts:367

`Static` addListener

addListener(eventName: ContainerEventType, listener: ((event: ContainerEventArgs) => void)): void
Registers an event listener on the specified static event.
Parameters
- eventName: ContainerEventType
  
  The type of the event.
- listener: ((event: ContainerEventArgs) => void)
  
  The event handler function.
  - - (event: ContainerEventArgs): void
    - Parameters
      
      event: ContainerEventArgs
      
      Returns void
Returns void
Inherited from ContainerBase.addListener
- Defined in desktopjs/src/container.ts:159

`Static` emit

emit(eventName: ContainerEventType, eventArgs: ContainerEventArgs): void
Parameters
- eventName: ContainerEventType
- eventArgs: ContainerEventArgs
Returns void
Inherited from ContainerBase.emit
- Defined in desktopjs/src/container.ts:167

`Static` listeners

listeners(eventName: string): ((event: EventArgs) => void)[]
Gets an array of listeners for a specific static event type.
Parameters
- eventName: string
  
  eventName The type of the event.
Returns ((event: EventArgs) => void)[]
Inherited from ContainerBase.listeners
- Defined in desktopjs/src/container.ts:171

`Static` removeListener

removeListener(eventName: ContainerEventType, listener: ((event: ContainerEventArgs) => void)): void
Removes a previous registered event listener from the specified static event.
Parameters
- eventName: ContainerEventType
  
  The type of the event.
- listener: ((event: ContainerEventArgs) => void)
  
  The event handler function.
  - - (event: ContainerEventArgs): void
    - Parameters
      
      event: ContainerEventArgs
      
      Returns void
Returns void
Inherited from ContainerBase.removeListener
- Defined in desktopjs/src/container.ts:163

Class WebContainerBaseAbstract

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Optional win: Window

Returns WebContainerBase

Properties

globalShortcut

Readonly globalWindow

hostType

screen

storage

uuid

Static Readonly layoutsPropertyKey

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 WebContainerBase

addTrayIcon

Parameters

details: TrayIconDetails

Optional listener: (() => void)

Returns void

Optional menuItems: MenuItem[]

Returns void

Abstract buildLayout

Returns Promise<PersistedWindowLayout>

Protected Abstract closeAllWindows

Parameters

Optional excludeSelf: boolean

Returns Promise<void>

Abstract createWindow

Returns

Parameters

url: string

Optional options: any

Returns Promise<ContainerWindow>

deleteLayout

Parameters

name: string

Returns Promise<void>

Protected deleteLayoutFromStorage

Parameters

name: string

Returns void

emit

Parameters

eventName: ContainerEventType

eventArgs: ContainerEventArgs

Returns void

Protected ensureAbsoluteUrl

Returns

Parameters

url: string

Returns string

Abstract getAllWindows

Returns

Class WebContainerBase`Abstract`

`Optional` win: Window

`Readonly` globalWindow

`Static` `Readonly` layoutsPropertyKey

`Static` `Readonly` windowOptionsPropertyKey

`Static` ipc

`Optional` listener: (() => void)

`Optional` menuItems: MenuItem[]

`Abstract` buildLayout

`Protected` `Abstract` closeAllWindows

`Optional` excludeSelf: boolean

`Abstract` createWindow

`Optional` options: any

`Protected` deleteLayoutFromStorage

`Protected` ensureAbsoluteUrl

`Abstract` getAllWindows

`Abstract` getCurrentWindow

`Protected` getLayoutFromStorage

`Abstract` getMainWindow

`Abstract` getOptions

`Abstract` getWindowById

`Abstract` getWindowByName

`Protected` onOpen

`Rest` ...args: any[]

`Rest` ...args: any[]

`Protected` postProcessArgs

`Protected` preProcessArgs

`Protected` registerAndWrapListener