Class Container`Abstract`

Represents a concrete container.

Hierarchy

EventEmitter
- Container
  - ContainerBase

Implements

Constructors

constructor

new Container(): Container
Returns Container

Inherited from EventEmitter.constructor

Properties

globalShortcut

globalShortcut: GlobalShortcutManager

`Abstract` hostType

hostType: string

Display type of current Container.

screen

screen: ScreenManager

Retrieve information about screen size and displays.

storage

storage: Storage

Persistent storage

`Abstract` uuid

uuid: string

Unique v4 GUID for this Container instance

`Static` `Readonly` windowOptionsPropertyKey

windowOptionsPropertyKey: string = "desktopJS-options"

Accessors

ipc

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

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

`Static` ipc

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

Methods

addListener

addListener(eventName: ContainerEventType, listener: ((event: ContainerEventArgs) => void)): Container
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 Container
Overrides EventEmitter.addListener
- Defined in desktopjs/src/container.ts:147

`Abstract` addTrayIcon

addTrayIcon(details: TrayIconDetails, listener?: (() => void), menuItems?: MenuItem[]): any
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 any
- Defined in desktopjs/src/container.ts:96

`Abstract` buildLayout

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

Returns Promise<PersistedWindowLayout>
Implementation of ContainerWindowManager.buildLayout
- Defined in desktopjs/src/container.ts:80

`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>
Implementation of ContainerWindowManager.createWindow
- Defined in desktopjs/src/container.ts:78

`Abstract` deleteLayout

deleteLayout(layout: string): Promise<void>
Persists a window layout
Parameters
- layout: string
  
  Name of the window layout to delete
Returns Promise<void>
Implementation of ContainerWindowManager.deleteLayout
- Defined in desktopjs/src/container.ts:86

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
Overrides EventEmitter.emit
- Defined in desktopjs/src/container.ts:155

`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[]>
Implementation of ContainerWindowManager.getAllWindows
- Defined in desktopjs/src/container.ts:100

`Abstract` getCurrentWindow

getCurrentWindow(): ContainerWindow
Gets the current ContainerWindow

Returns
The current ContainerWindow

Returns ContainerWindow
Implementation of ContainerWindowManager.getCurrentWindow
- Defined in desktopjs/src/container.ts:76

getInfo

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

`Abstract` 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[]>
Implementation of ContainerWindowManager.getLayouts
- Defined in desktopjs/src/container.ts:88

`Abstract` getMainWindow

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

Returns
The main ContainerWindow.

Returns ContainerWindow
Implementation of ContainerWindowManager.getMainWindow
- Defined in desktopjs/src/container.ts:74

`Abstract` getOptions

getOptions(): Promise<any>
Returns Promise<any>
- 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>
Implementation of ContainerWindowManager.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>
Implementation of ContainerWindowManager.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 EventEmitter.listeners
- Defined in desktopjs/src/events.ts:113

`Abstract` 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>
Implementation of ContainerWindowManager.loadLayout
- Defined in desktopjs/src/container.ts:84

`Protected` postProcessArgs

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

`Protected` preProcessArgs

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

ready

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

removeListener

removeListener(eventName: ContainerEventType, listener: ((event: ContainerEventArgs) => void)): Container
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 Container
Overrides EventEmitter.removeListener
- Defined in desktopjs/src/container.ts:151

`Abstract` 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>
Implementation of ContainerWindowManager.saveLayout
- Defined in desktopjs/src/container.ts:82

`Abstract` setOptions

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

`Abstract` showNotification

showNotification(title: string, options?: NotificationOptions): any
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 any
Implementation of ContainerNotificationManager.showNotification
- Defined in desktopjs/src/container.ts:98

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

`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
Overrides EventEmitter.addListener
- Defined in desktopjs/src/container.ts:159

`Static` emit

emit(eventName: ContainerEventType, eventArgs: ContainerEventArgs): void
Parameters
- eventName: ContainerEventType
- eventArgs: ContainerEventArgs
Returns void
Overrides EventEmitter.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)[]
Overrides EventEmitter.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
Overrides EventEmitter.removeListener
- Defined in desktopjs/src/container.ts:163

Class ContainerAbstract

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns Container

Properties

globalShortcut

Abstract hostType

screen

storage

Abstract uuid

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 Container

Abstract addTrayIcon

Parameters

details: TrayIconDetails

Optional listener: (() => void)

Returns void

Optional menuItems: MenuItem[]

Returns any

Abstract buildLayout

Returns Promise<PersistedWindowLayout>

Abstract createWindow

Returns

Parameters

url: string

Optional options: any

Returns Promise<ContainerWindow>

Abstract deleteLayout

Parameters

layout: string

Returns Promise<void>

emit

Parameters

eventName: ContainerEventType

eventArgs: ContainerEventArgs

Returns void

Abstract getAllWindows

Returns

Returns Promise<ContainerWindow[]>

Abstract getCurrentWindow

Returns

Returns ContainerWindow

getInfo

Returns Promise<string>

Abstract getLayouts

Returns

Returns Promise<PersistedWindowLayout[]>

Abstract getMainWindow

Returns

Returns ContainerWindow

Abstract getOptions

Returns Promise<any>

Abstract getWindowById

Returns

Class Container`Abstract`

`Abstract` hostType

`Abstract` uuid

`Static` `Readonly` windowOptionsPropertyKey

`Static` ipc

`Abstract` addTrayIcon

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

`Optional` menuItems: MenuItem[]

`Abstract` buildLayout

`Abstract` createWindow

`Optional` options: any

`Abstract` deleteLayout

`Abstract` getAllWindows

`Abstract` getCurrentWindow

`Abstract` getLayouts

`Abstract` getMainWindow

`Abstract` getOptions

`Abstract` getWindowById

`Abstract` getWindowByName

`Abstract` loadLayout

`Protected` postProcessArgs

`Protected` preProcessArgs

`Protected` registerAndWrapListener

`Abstract` saveLayout

`Abstract` setOptions

`Abstract` showNotification

`Optional` options: NotificationOptions

`Protected` unwrapAndUnRegisterListener