Properties
Private #private
#private: any
Application
Application: Application
Layout
Layout: LayoutModule
addListener
add
Listener
: <E>
(eventType
: E, listener
: (payload
: E extends string | number ? PlatformEvents[E] : any,
...args
: any[]) => void, options
?: SubscriptionOptions) => Promise<WorkspacePlatformModule>Type declaration
- <E>(eventType: E, listener: (payload: E extends string | number ? PlatformEvents[E] : any, ...args: any[]) => void, options?: SubscriptionOptions): Promise<WorkspacePlatformModule>
Type parameters
Parameters
eventType: E
listener: (payload: E extends string | number ? PlatformEvents[E] : any, ...args: any[]) => void
- (payload: E extends string | number ? PlatformEvents[E] : any, ...args: any[]): void
Parameters
payload: E extends string | number ? PlatformEvents[E] : any
Rest ...args: any[]
Returns void
Optional options: SubscriptionOptions
Protected deregisterAllListeners
deregisterAllListeners: (eventType: string | symbol) => Promise<void | EventEmitter>
Type declaration
- (eventType: string | symbol): Promise<void | EventEmitter>
Parameters
eventType: string | symbol
Returns Promise<void | EventEmitter>
Protected deregisterEventListener
deregisterEventListener: (eventType: string | symbol, options?: SubscriptionOptions) => Promise<void | EventEmitter>
Type declaration
- (eventType: string | symbol, options?: SubscriptionOptions): Promise<void | EventEmitter>
Parameters
eventType: string | symbol
Optional options: SubscriptionOptions
Returns Promise<void | EventEmitter>
emit
emit: <E>(eventName: E, payload: E extends string ? PlatformEvents[E] : any, ...args: any[]) => boolean
Type declaration
- <E>(eventName: E, payload: E extends string ? PlatformEvents[E] : any, ...args: any[]): boolean
Type parameters
Parameters
eventName: E
payload: E extends string ? PlatformEvents[E] : any
Rest ...args: any[]
Returns boolean
eventNames
eventNames: () => (string | symbol)[]
Type declaration
Returns (string | symbol)[]
getClient
getClient: (identity?: ApplicationIdentity) => Promise<default>
Type declaration
- (identity?: ApplicationIdentity): Promise<default>
Parameters
Optional identity: ApplicationIdentity
Returns Promise<default>
identity
identity: ApplicationIdentity
Protected isNodeEnvironment
isNodeEnvironment: () => boolean
Protected isOpenFinEnvironment
isOpenFinEnvironment: () => boolean
launchLegacyManifest
launchLegacyManifest: (manifestUrl: string) => Promise<Platform>
Type declaration
- (manifestUrl: string): Promise<Platform>
Parameters
Returns Promise<Platform>
listenerCount
listenerCount: (type: string | symbol) => number
Type declaration
- (type: string | symbol): number
listeners
listeners: (type: string | symbol) => Function[]
Type declaration
- (type: string | symbol): Function[]
Parameters
Returns Function[]
on
on
: <E>
(eventType
: E, listener
: (payload
: E extends string | number ? PlatformEvents[E] : any,
...args
: any[]) => void, options
?: SubscriptionOptions) => Promise<WorkspacePlatformModule>Type declaration
- <E>(eventType: E, listener: (payload: E extends string | number ? PlatformEvents[E] : any, ...args: any[]) => void, options?: SubscriptionOptions): Promise<WorkspacePlatformModule>
Type parameters
Parameters
eventType: E
listener: (payload: E extends string | number ? PlatformEvents[E] : any, ...args: any[]) => void
- (payload: E extends string | number ? PlatformEvents[E] : any, ...args: any[]): void
Parameters
payload: E extends string | number ? PlatformEvents[E] : any
Rest ...args: any[]
Returns void
Optional options: SubscriptionOptions
once
once
: <E>
(eventType
: E, listener
: (payload
: E extends string | number ? PlatformEvents[E] : any,
...args
: any[]) => void, options
?: SubscriptionOptions) => Promise<WorkspacePlatformModule>Type declaration
- <E>(eventType: E, listener: (payload: E extends string | number ? PlatformEvents[E] : any, ...args: any[]) => void, options?: SubscriptionOptions): Promise<WorkspacePlatformModule>
Type parameters
Parameters
eventType: E
listener: (payload: E extends string | number ? PlatformEvents[E] : any, ...args: any[]) => void
- (payload: E extends string | number ? PlatformEvents[E] : any, ...args: any[]): void
Parameters
payload: E extends string | number ? PlatformEvents[E] : any
Rest ...args: any[]
Returns void
Optional options: SubscriptionOptions
prependListener
prepend
Listener
: <E>
(eventType
: E, listener
: (payload
: E extends string | number ? PlatformEvents[E] : any,
...args
: any[]) => void, options
?: SubscriptionOptions) => Promise<WorkspacePlatformModule>Type declaration
- <E>(eventType: E, listener: (payload: E extends string | number ? PlatformEvents[E] : any, ...args: any[]) => void, options?: SubscriptionOptions): Promise<WorkspacePlatformModule>
Type parameters
Parameters
eventType: E
listener: (payload: E extends string | number ? PlatformEvents[E] : any, ...args: any[]) => void
- (payload: E extends string | number ? PlatformEvents[E] : any, ...args: any[]): void
Parameters
payload: E extends string | number ? PlatformEvents[E] : any
Rest ...args: any[]
Returns void
Optional options: SubscriptionOptions
prependOnceListener
prepend
Once
Listener
: <E>
(eventType
: E, listener
: (payload
: E extends string | number ? PlatformEvents[E] : any,
...args
: any[]) => void, options
?: SubscriptionOptions) => Promise<WorkspacePlatformModule>Type declaration
- <E>(eventType: E, listener: (payload: E extends string | number ? PlatformEvents[E] : any, ...args: any[]) => void, options?: SubscriptionOptions): Promise<WorkspacePlatformModule>
Type parameters
Parameters
eventType: E
listener: (payload: E extends string | number ? PlatformEvents[E] : any, ...args: any[]) => void
- (payload: E extends string | number ? PlatformEvents[E] : any, ...args: any[]): void
Parameters
payload: E extends string | number ? PlatformEvents[E] : any
Rest ...args: any[]
Returns void
Optional options: SubscriptionOptions
Protected registerEventListener
registerEventListener: (eventType: string | symbol, options: SubscriptionOptions, applySubscription: (emitter: EventEmitter) => void, undoSubscription: (emitter: EventEmitter) => void) => Promise<void>
Type declaration
- (eventType: string | symbol, options: SubscriptionOptions, applySubscription: (emitter: EventEmitter) => void, undoSubscription: (emitter: EventEmitter) => void): Promise<void>
Parameters
eventType: string | symbol
options: SubscriptionOptions
applySubscription: (emitter: EventEmitter) => void
- (emitter: EventEmitter): void
undoSubscription: (emitter: EventEmitter) => void
- (emitter: EventEmitter): void
Returns Promise<void>
removeAllListeners
Type declaration
Parameters
Optional eventType: string | symbol
removeListener
remove
Listener
: <E>
(eventType
: E, listener
: (payload
: E extends string | number ? PlatformEvents[E] : any,
...args
: any[]) => void, options
?: SubscriptionOptions) => Promise<WorkspacePlatformModule>Type declaration
- <E>(eventType: E, listener: (payload: E extends string | number ? PlatformEvents[E] : any, ...args: any[]) => void, options?: SubscriptionOptions): Promise<WorkspacePlatformModule>
Type parameters
Parameters
eventType: E
listener: (payload: E extends string | number ? PlatformEvents[E] : any, ...args: any[]) => void
- (payload: E extends string | number ? PlatformEvents[E] : any, ...args: any[]): void
Parameters
payload: E extends string | number ? PlatformEvents[E] : any
Rest ...args: any[]
Returns void
Optional options: SubscriptionOptions
wire
wire: Transport<EntityType>
Controller for a Workspace Platform.