Class DefaultContainer

Hierarchy

WebContainerBase
- DefaultContainer

Constructors

constructor

new DefaultContainer(win?: Window): DefaultContainer
Parameters
- Optional win: Window
Returns DefaultContainer
Overrides WebContainerBase.constructor
- Defined in desktopjs/src/Default/default.ts:217

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

windowOptionsMap

windowOptionsMap: PropertyMap = DefaultContainer.defaultWindowOptionsMap

`Static` `Readonly` defaultWindowOptionsMap

defaultWindowOptionsMap: PropertyMap = ...

`Static` `Readonly` layoutsPropertyKey

layoutsPropertyKey: string = "desktopJS-layouts"

`Static` `Readonly` windowNamePropertyKey

windowNamePropertyKey: string = "desktopJS-name"

`Static` `Readonly` windowOptionsPropertyKey

windowOptionsPropertyKey: string = "desktopJS-options"

`Static` `Readonly` windowUuidPropertyKey

windowUuidPropertyKey: string = "desktopJS-uuid"

`Static` `Readonly` windowsPropertyKey

windowsPropertyKey: string = "desktopJS-windows"

Accessors

ipc

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

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

`Static` ipc

get ipc(): MessageBus
Returns MessageBus
Inherited from WebContainerBase.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 WebContainerBase.ipc
- Defined in desktopjs/src/container.ts:117

Methods

addListener

addListener(eventName: ContainerEventType, listener: ((event: ContainerEventArgs) => void)): DefaultContainer
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 DefaultContainer
Inherited from WebContainerBase.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 WebContainerBase.addTrayIcon
- Defined in desktopjs/src/container.ts:190

buildLayout

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

Returns Promise<PersistedWindowLayout>
Overrides WebContainerBase.buildLayout
- Defined in desktopjs/src/Default/default.ts:388

`Protected` closeAllWindows

closeAllWindows(excludeSelf?: boolean): Promise<void>
Parameters
- excludeSelf: boolean = false
Returns Promise<void>
Overrides WebContainerBase.closeAllWindows
- Defined in desktopjs/src/Default/default.ts:353

`Protected` createMessageBus

createMessageBus(): MessageBus
Returns MessageBus
- Defined in desktopjs/src/Default/default.ts:232

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>
Overrides WebContainerBase.createWindow
- Defined in desktopjs/src/Default/default.ts:303

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 WebContainerBase.deleteLayout
- Defined in desktopjs/src/container.ts:299

`Protected` deleteLayoutFromStorage

deleteLayoutFromStorage(name: string): void
Parameters
- name: string
Returns void
Inherited from WebContainerBase.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 WebContainerBase.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
Inherited from WebContainerBase.ensureAbsoluteUrl
- Defined in desktopjs/src/container.ts:374

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[]>
Overrides WebContainerBase.getAllWindows
- Defined in desktopjs/src/Default/default.ts:363

getCurrentWindow

getCurrentWindow(): ContainerWindow
Gets the current ContainerWindow

Returns
The current ContainerWindow

Returns ContainerWindow
Overrides WebContainerBase.getCurrentWindow
- Defined in desktopjs/src/Default/default.ts:258

getInfo

getInfo(): Promise<string>
Returns Promise<string>
Overrides WebContainerBase.getInfo
- Defined in desktopjs/src/Default/default.ts:245

`Protected` getLayoutFromStorage

getLayoutFromStorage(name: string): PersistedWindowLayout
Parameters
- name: string
Returns PersistedWindowLayout
Inherited from WebContainerBase.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 WebContainerBase.getLayouts
- Defined in desktopjs/src/container.ts:303

getMainWindow

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

Returns
The main ContainerWindow.

Returns ContainerWindow
Overrides WebContainerBase.getMainWindow
- Defined in desktopjs/src/Default/default.ts:249

getOptions

getOptions(): Promise<any>
Returns Promise<any>
Overrides WebContainerBase.getOptions
- Defined in desktopjs/src/Default/default.ts:240

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>
Overrides WebContainerBase.getWindowById
- Defined in desktopjs/src/Default/default.ts:372

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>
Overrides WebContainerBase.getWindowByName
- Defined in desktopjs/src/Default/default.ts:377

`Protected` getWindowOptions

getWindowOptions(options?: any): any
Parameters
- Optional options: any
Returns any
- Defined in desktopjs/src/Default/default.ts:262

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/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 WebContainerBase.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 WebContainerBase.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
Overrides WebContainerBase.onOpen
- Defined in desktopjs/src/Default/default.ts:270

`Protected` postProcessArgs

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

`Protected` preProcessArgs

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

ready

ready(): Promise<void>
Returns Promise<void>
Inherited from WebContainerBase.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 WebContainerBase.registerAndWrapListener
- Defined in desktopjs/src/events.ts:56

removeListener

removeListener(eventName: ContainerEventType, listener: ((event: ContainerEventArgs) => void)): DefaultContainer
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 DefaultContainer
Inherited from WebContainerBase.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 WebContainerBase.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 WebContainerBase.saveLayoutToStorage
- Defined in desktopjs/src/container.ts:202

setOptions

setOptions(options: any): void
Set information on the container based on the options
Parameters
- options: any
Returns void
Overrides WebContainerBase.setOptions
- Defined in desktopjs/src/Default/default.ts:236

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
Overrides WebContainerBase.showNotification
- Defined in desktopjs/src/Default/default.ts:338

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

wrapWindow

wrapWindow(containerWindow: any): DefaultContainerWindow
Parameters
- containerWindow: any
Returns DefaultContainerWindow
Overrides WebContainerBase.wrapWindow
- Defined in desktopjs/src/Default/default.ts:266

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

Class DefaultContainer

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Optional win: Window

Returns DefaultContainer

Properties

globalShortcut

Readonly globalWindow

hostType

screen

storage

uuid

windowOptionsMap

Static Readonly defaultWindowOptionsMap

Static Readonly layoutsPropertyKey

Static Readonly windowNamePropertyKey

Static Readonly windowOptionsPropertyKey

Static Readonly windowUuidPropertyKey

Static Readonly windowsPropertyKey

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 DefaultContainer

addTrayIcon

Parameters

details: TrayIconDetails

Optional listener: (() => void)

Returns void

Optional menuItems: MenuItem[]

Returns void

buildLayout

Returns Promise<PersistedWindowLayout>

Protected closeAllWindows

Parameters

excludeSelf: boolean = false

Returns Promise<void>

Protected createMessageBus

Returns MessageBus

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

`Optional` win: Window

`Readonly` globalWindow

`Static` `Readonly` defaultWindowOptionsMap

`Static` `Readonly` layoutsPropertyKey

`Static` `Readonly` windowNamePropertyKey

`Static` `Readonly` windowOptionsPropertyKey

`Static` `Readonly` windowUuidPropertyKey

`Static` `Readonly` windowsPropertyKey

`Static` ipc

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

`Optional` menuItems: MenuItem[]

`Protected` closeAllWindows

`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