Class OpenFinContainer

Hierarchy

WebContainerBase
- OpenFinContainer

Index

Constructors

constructor

new OpenFinContainer(desktop?: any, win?: Window, options?: any): OpenFinContainer
Parameters
- Optional desktop: any
- Optional win: Window
- Optional options: any
Returns OpenFinContainer
Overrides WebContainerBase.constructor
- Defined in desktopjs-openfin/src/openfin.ts:381

Properties

globalShortcut

globalShortcut: GlobalShortcutManager

`Readonly` globalWindow

globalWindow: Window

hostType

hostType: string

screen

screen: ScreenManager

Retrieve information about screen size and displays.

storage

storage: Storage

uuid

uuid: string

windowOptionsMap

windowOptionsMap: PropertyMap = OpenFinContainer.windowOptionsMap

`Static` `Readonly` layoutsPropertyKey

layoutsPropertyKey: string

`Static` menuHtml

menuHtml: string = ...

`Static` replaceNotificationApi

replaceNotificationApi: boolean = true

Gets or sets whether to replace the native web Notification API with OpenFin notifications.

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)): OpenFinContainer
Parameters
- eventName: ContainerEventType
- listener: ((event: ContainerEventArgs) => void)
  - - (event: ContainerEventArgs): void
    - Parameters
      
      event: ContainerEventArgs
      
      Returns void
Returns OpenFinContainer
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-openfin/src/openfin.ts:606

buildLayout

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

`Protected` closeAllWindows

closeAllWindows(): Promise<void>
Returns Promise<void>
Overrides WebContainerBase.closeAllWindows
- Defined in desktopjs-openfin/src/openfin.ts:632

`Protected` createMessageBus

createMessageBus(): MessageBus
Returns MessageBus
- Defined in desktopjs-openfin/src/openfin.ts:438

createWindow

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

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-openfin/src/openfin.ts:650

getCurrentWindow

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

getInfo

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

`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-openfin/src/openfin.ts:491

`Protected` getMenuHtml

getMenuHtml(): string
Returns string
- Defined in desktopjs-openfin/src/openfin.ts:540

`Protected` getMenuItemHtml

getMenuItemHtml(item: MenuItem): string
Parameters
- item: MenuItem
Returns string
- Defined in desktopjs-openfin/src/openfin.ts:544

getOptions

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

getWindowById

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

getWindowByName

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

`Protected` getWindowOptions

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

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>
Parameters
- level: "error" | "debug" | "info" | "warn"
- message: string
Returns Promise<void>
Overrides WebContainerBase.log
- Defined in desktopjs-openfin/src/openfin.ts:467

`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>
Overrides WebContainerBase.ready
- Defined in desktopjs-openfin/src/openfin.ts:473

`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-openfin/src/openfin.ts:442

removeListener

removeListener(eventName: ContainerEventType, listener: ((event: ContainerEventArgs) => void)): OpenFinContainer
Parameters
- eventName: ContainerEventType
- listener: ((event: ContainerEventArgs) => void)
  - - (event: ContainerEventArgs): void
    - Parameters
      
      event: ContainerEventArgs
      
      Returns void
Returns OpenFinContainer
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-openfin/src/openfin.ts:405

showNotification

showNotification(title: string, options?: NotificationOptions): void
Parameters
- title: string
- Optional options: NotificationOptions
Returns void
Inherited from WebContainerBase.showNotification
- Defined in desktopjs/dist/desktopjs.d.ts:96

`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): OpenFinContainerWindow
Parameters
- containerWindow: any
Returns OpenFinContainerWindow
Overrides WebContainerBase.wrapWindow
- Defined in desktopjs-openfin/src/openfin.ts:520

`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 OpenFinContainer

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Optional desktop: any

Optional win: Window

Optional options: any

Returns OpenFinContainer

Properties

globalShortcut

Readonly globalWindow

hostType

screen

storage

uuid

windowOptionsMap

Static Readonly layoutsPropertyKey

Static menuHtml

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 OpenFinContainer

addTrayIcon

Parameters

details: TrayIconDetails

listener: (() => void)

Returns void

Optional menuItems: MenuItem[]

Returns void

buildLayout

Returns Promise<PersistedWindowLayout>

Protected closeAllWindows

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

Parameters

name: string

Returns void

emit

Parameters

eventName: ContainerEventType

eventArgs: ContainerEventArgs

Returns void

Protected ensureAbsoluteUrl

`Optional` desktop: any

`Optional` win: Window

`Optional` options: any

`Readonly` globalWindow

`Static` `Readonly` layoutsPropertyKey

`Static` menuHtml

`Static` replaceNotificationApi

`Static` `Readonly` windowOptionsMap

`Static` `Readonly` windowOptionsPropertyKey

`Static` ipc

`Optional` menuItems: MenuItem[]

`Protected` closeAllWindows

`Protected` createMessageBus

`Optional` options: any

`Protected` deleteLayoutFromStorage

`Protected` ensureAbsoluteUrl

`Protected` getLayoutFromStorage

`Protected` getMenuHtml

`Protected` getMenuItemHtml

`Protected` getWindowOptions

`Optional` options: any

`Protected` onOpen

`Rest` ...args: any[]

`Rest` ...args: any[]

`Protected` postProcessArgs

`Protected` preProcessArgs

`Protected` registerAndWrapListener