Skip to main content

Module: main

Namespaces​

Interfaces​

References​

AppDefinition​

Re-exports AppDefinition

Desktop​

Re-exports Desktop

FDC3​

Re-exports FDC3

Interop​

Re-exports Interop

REST​

Re-exports REST

SelectConnectAppList​

Re-exports SelectConnectAppList

ShowWindowParams​

Re-exports ShowWindowParams

SpawnParams​

Re-exports SpawnParams

Startup​

Re-exports Startup

StoreModel​

Re-exports StoreModel

WindowBounds​

Re-exports WindowBounds

WindowDescriptor​

Re-exports WindowDescriptor

WindowEventName​

Re-exports WindowEventName

WindowIdentifier​

Re-exports WindowIdentifier

WindowLocator​

Re-exports WindowLocator

WorkspaceEventName​

Re-exports WorkspaceEventName

WrapState​

Re-exports WrapState

Type Aliases​

AppConfig​

Ƭ AppConfig: Record<string, any>

CallbackError​

Ƭ CallbackError: Object

Type declaration​

NameType
codestring
messagestring

FinsembleConfig​

Ƭ FinsembleConfig: Record<string, any>

Manifest​

Ƭ Manifest: Record<string, any>

StandardCallback​

Ƭ StandardCallback<E, R>: (err: E, response?: R) => void

Type parameters​

NameType
EStandardError
Rany

Type declaration​

▸ (err, response?): void

Parameters​
NameType
errE
response?R
Returns​

void

StandardError​

Ƭ StandardError: Error | string | null | undefined

StandardErrorCallback​

Ƭ StandardErrorCallback<R>: (err: StandardError, response?: R) => void

Type parameters​

NameType
Rany

Type declaration​

▸ (err, response?): void

Parameters​
NameType
errStandardError
response?R
Returns​

void

StandardPromise​

Ƭ StandardPromise<R>: Promise<{ data?: R ; err?: StandardError }>

Type parameters​

NameType
Rany

StandardResponse​

Ƭ StandardResponse<R>: Object

Type parameters​

NameType
Rany

Type declaration​

NameType
data?R
err?StandardError

Variables​

Clients​

• Const Clients: Object

Type declaration​

NameType
AuthenticationClient{ appAcceptSignOn: (signOnKey: any) => void ; appRejectAndRetrySignOn: (signOnKey: string, params: { userMsg?: string }, cb: StandardCallback<StandardError, any>) => void ; appRejectSignOn: (signOnKey: any) => void ; appSignOn: (signOnKey: any, params: { force: boolean ; icon: string ; prompt: string ; userMsg?: string }, cb?: StandardCallback<StandardError, any>) => Promise<{ data?: any ; err?: StandardError }> ; beginAuthentication: (params: { profile?: string ; spawnParams?: SpawnParams }, cb?: StandardErrorCallback<any>) => StandardPromise<any> ; completeOAUTH: (err?: string, params?: any, cb?: StandardErrorCallback<any>) => StandardPromise<any> ; getCurrentCredentials: (cb?: StandardErrorCallback<any>) => StandardPromise<any> ; initialize: () => void ; onReady: (cb?: any) => void ; publishAuthorization: (user: string, credentials: any) => void ; transmitSignOnToAuthService: (signOnData: { error?: string ; password?: string ; signOnKey: string ; username?: string }) => void }
AuthenticationClient.appAcceptSignOn(signOnKey: any) => void
AuthenticationClient.appRejectAndRetrySignOn(signOnKey: string, params: { userMsg?: string }, cb: StandardCallback<StandardError, any>) => void
AuthenticationClient.appRejectSignOn(signOnKey: any) => void
AuthenticationClient.appSignOn(signOnKey: any, params: { force: boolean ; icon: string ; prompt: string ; userMsg?: string }, cb?: StandardCallback<StandardError, any>) => Promise<{ data?: any ; err?: StandardError }>
AuthenticationClient.beginAuthentication(params: { profile?: string ; spawnParams?: SpawnParams }, cb?: StandardErrorCallback<any>) => StandardPromise<any>
AuthenticationClient.completeOAUTH(err?: string, params?: any, cb?: StandardErrorCallback<any>) => StandardPromise<any>
AuthenticationClient.getCurrentCredentials(cb?: StandardErrorCallback<any>) => StandardPromise<any>
AuthenticationClient.initialize() => void
AuthenticationClient.onReady(cb?: any) => void
AuthenticationClient.publishAuthorization(user: string, credentials: any) => void
AuthenticationClient.transmitSignOnToAuthService(signOnData: { error?: string ; password?: string ; signOnKey: string ; username?: string }) => void
ConfigClient{ addListener: <T>(params: { field: null | string }, fn: ListenerFunction<T>, cb?: () => void) => Promise<void> ; addListeners: <T>(params: string[] | ListenerParam[], fn: ListenerFunction<T>, cb?: () => void) => undefined | Promise<void> ; getManifest: (cb?: StandardErrorCallback<Manifest>) => StandardPromise<Manifest> ; getPreferences: (cb?: StandardErrorCallback<null | Record<string, any>>) => StandardPromise<null | Record<string, any>> ; getValue: <T>(params: string | FieldOnlyParam, cb?: StandardErrorCallback<T>) => StandardPromise<T> ; getValues: <T>(fields?: null | string[] | FieldOnlyParam[], cb?: StandardErrorCallback<Record<string, T>>) => StandardPromise<Record<string, T>> ; onReady: (cb?: any) => void ; processAndSet: (params: { newConfig: Record<string, any> ; overwrite: boolean ; replace: boolean }, cb?: StandardErrorCallback<QueryResponse<Manifest>>) => StandardPromise<Manifest> ; removeListener: (params: { field: null | string }, fn: ListenerFunction<any>, cb?: Function) => void ; removeListeners: (params: RemoveListenersType, fn?: ListenerFunction<any>, cb?: StandardErrorCallback<boolean>) => void ; removeValue: (field: String, cb?: StandardErrorCallback<void>) => Promise<{ err: undefined | null | string }> ; removeValues: (params: FieldAndValueParams, cb?: StandardErrorCallback<void>) => Promise<{ err: StandardError }> ; setPreference: (params: FieldAndValueParam, cb?: StandardErrorCallback<void>) => StandardPromise<void> ; setValue: (params: FieldAndValueParam, cb?: StandardErrorCallback<void>) => Promise<{ err: undefined | null | string }> ; setValues: (fields: FieldAndValueParams, cb?: StandardErrorCallback<void>) => Promise<{ err: undefined | null | string }> ; unsetPreference: (params: FieldOnlyParam, cb?: StandardErrorCallback<void>) => StandardPromise<void> ; changeSub: (change: string) => Promise<void> ; handleChanges: (err: StandardError, response: { data: { field: null | string ; store: string ; storeData: any ; value: any } }) => void ; initialize: () => void ; triggerListeners: (listenerKey: string, data: any) => void }
ConfigClient.addListener<T>(params: { field: null | string }, fn: ListenerFunction<T>, cb?: () => void) => Promise<void>
ConfigClient.addListeners<T>(params: string[] | ListenerParam[], fn: ListenerFunction<T>, cb?: () => void) => undefined | Promise<void>
ConfigClient.getManifest(cb?: StandardErrorCallback<Manifest>) => StandardPromise<Manifest>
ConfigClient.getPreferences(cb?: StandardErrorCallback<null | Record<string, any>>) => StandardPromise<null | Record<string, any>>
ConfigClient.getValue<T>(params: string | FieldOnlyParam, cb?: StandardErrorCallback<T>) => StandardPromise<T>
ConfigClient.getValues<T>(fields?: null | string[] | FieldOnlyParam[], cb?: StandardErrorCallback<Record<string, T>>) => StandardPromise<Record<string, T>>
ConfigClient.onReady(cb?: any) => void
ConfigClient.processAndSet(params: { newConfig: Record<string, any> ; overwrite: boolean ; replace: boolean }, cb?: StandardErrorCallback<QueryResponse<Manifest>>) => StandardPromise<Manifest>
ConfigClient.removeListener(params: { field: null | string }, fn: ListenerFunction<any>, cb?: Function) => void
ConfigClient.removeListeners(params: RemoveListenersType, fn?: ListenerFunction<any>, cb?: StandardErrorCallback<boolean>) => void
ConfigClient.removeValue(field: String, cb?: StandardErrorCallback<void>) => Promise<{ err: undefined | null | string }>
ConfigClient.removeValues(params: FieldAndValueParams, cb?: StandardErrorCallback<void>) => Promise<{ err: StandardError }>
ConfigClient.setPreference(params: FieldAndValueParam, cb?: StandardErrorCallback<void>) => StandardPromise<void>
ConfigClient.setValue(params: FieldAndValueParam, cb?: StandardErrorCallback<void>) => Promise<{ err: undefined | null | string }>
ConfigClient.setValues(fields: FieldAndValueParams, cb?: StandardErrorCallback<void>) => Promise<{ err: undefined | null | string }>
ConfigClient.unsetPreference(params: FieldOnlyParam, cb?: StandardErrorCallback<void>) => StandardPromise<void>
ConfigClient.changeSub[object Object]
ConfigClient.handleChanges[object Object]
ConfigClient.initialize[object Object]
ConfigClient.triggerListeners[object Object]
DialogManager{ createStore: (cb?: () => void) => Promise<void> ; getAvailableDialog: (type: string, cb?: (dialog: null | WindowIdentifier) => void) => Promise<null | WindowIdentifier> ; getParametersFromInDialog: () => Promise<any> ; hideModal: () => Promise<null | string> ; initialize: () => void ; onReady: (cb?: any) => void ; open: (type: string, options: any, onUserInput: StandardErrorCallback<any>) => Promise<null | string> ; registerDialogCallback: (cb?: StandardErrorCallback<ResponderMessage<any, any>>) => Promise<void> ; registerModal: () => Promise<null | string> ; respondAndExitFromInDialog: (responseParameters: any) => Promise<void> ; respondToOpener: (data?: any) => Promise<void> ; sendQueryToDialog: (identifier: WindowIdentifier, options: any, onUserInput: StandardErrorCallback<any>) => Promise<void> ; showDialog: () => Promise<void> ; showModal: (cb?: (error?: string) => void) => Promise<null | string> ; spawnDialog: (params: SpawnParams, inputParams: any, dialogResponseCallback: StandardErrorCallback<any>, cb?: StandardErrorCallback<SpawnResponse>) => StandardPromise<SpawnResponse> ; openerMessage: ; userInputTimeout: }
DialogManager.createStore(cb?: () => void) => Promise<void>
DialogManager.getAvailableDialog(type: string, cb?: (dialog: null | WindowIdentifier) => void) => Promise<null | WindowIdentifier>
DialogManager.getParametersFromInDialog() => Promise<any>
DialogManager.hideModal() => Promise<null | string>
DialogManager.initialize() => void
DialogManager.onReady(cb?: any) => void
DialogManager.open(type: string, options: any, onUserInput: StandardErrorCallback<any>) => Promise<null | string>
DialogManager.registerDialogCallback(cb?: StandardErrorCallback<ResponderMessage<any, any>>) => Promise<void>
DialogManager.registerModal() => Promise<null | string>
DialogManager.respondAndExitFromInDialog(responseParameters: any) => Promise<void>
DialogManager.respondToOpener(data?: any) => Promise<void>
DialogManager.sendQueryToDialog(identifier: WindowIdentifier, options: any, onUserInput: StandardErrorCallback<any>) => Promise<void>
DialogManager.showDialog() => Promise<void>
DialogManager.showModal(cb?: (error?: string) => void) => Promise<null | string>
DialogManager.spawnDialog(params: SpawnParams, inputParams: any, dialogResponseCallback: StandardErrorCallback<any>, cb?: StandardErrorCallback<SpawnResponse>) => StandardPromise<SpawnResponse>
get` **openerMessage**(): null` \| [ResponderMessage](/docs/7.x/reference/typedocs/modules/RouterClient#respondermessage)<any, any\>[object Object]
set` **userInputTimeout**(`timeout`): `void[object Object]
DistributedStoreClient{ createGlobalStore: ; createStore: (params: { global?: boolean ; persist?: boolean ; store: string ; values?: any }, cb?: StandardErrorCallback<StoreModel>) => StandardPromise<StoreModel> ; getStore: (params: { global?: boolean ; store: string ; waitForPersistentStoreToLoad?: boolean }, cb?: StandardErrorCallback<StoreModel>) => StandardPromise<StoreModel> ; initialize: () => void ; onReady: (cb?: any) => void ; removeStore: (params: { global?: boolean ; store: string }, cb?: StandardErrorCallback<boolean>) => StandardPromise<boolean> }
DistributedStoreClient.createGlobalStore
DistributedStoreClient.createStore(params: { global?: boolean ; persist?: boolean ; store: string ; values?: any }, cb?: StandardErrorCallback<StoreModel>) => StandardPromise<StoreModel>
DistributedStoreClient.getStore(params: { global?: boolean ; store: string ; waitForPersistentStoreToLoad?: boolean }, cb?: StandardErrorCallback<StoreModel>) => StandardPromise<StoreModel>
DistributedStoreClient.initialize() => void
DistributedStoreClient.onReady(cb?: any) => void
DistributedStoreClient.removeStore(params: { global?: boolean ; store: string }, cb?: StandardErrorCallback<boolean>) => StandardPromise<boolean>
DragAndDropClientDragAndDropClient
HotkeyClient{ addBrowserHotkey: ; addGlobalHotkey: (keyArr: string[], handler: any, cb?: StandardErrorCallback<void>) => StandardPromise<void> ; addLocalHotkey: (keyArr: string[], handler: (...args: any[]) => void, cb?: StandardErrorCallback<void>) => StandardPromise<void> ; initialize: () => void ; onClose: ; onReady: (cb?: any) => void ; removeAllHotkeys: (cb?: StandardErrorCallback<void>) => StandardPromise<void> ; removeGlobalHotkey: (keyArr: string[], handler: any, cb?: StandardErrorCallback<void>) => StandardPromise<void> ; removeLocalHotkey: (keyArr: string[], handler: (...args: any[]) => void, cb?: StandardErrorCallback<void>) => StandardPromise<void> }
HotkeyClient.addBrowserHotkey
HotkeyClient.addGlobalHotkey(keyArr: string[], handler: any, cb?: StandardErrorCallback<void>) => StandardPromise<void>
HotkeyClient.addLocalHotkey(keyArr: string[], handler: (...args: any[]) => void, cb?: StandardErrorCallback<void>) => StandardPromise<void>
HotkeyClient.initialize() => void
HotkeyClient.onClose
HotkeyClient.onReady(cb?: any) => void
HotkeyClient.removeAllHotkeys(cb?: StandardErrorCallback<void>) => StandardPromise<void>
HotkeyClient.removeGlobalHotkey(keyArr: string[], handler: any, cb?: StandardErrorCallback<void>) => StandardPromise<void>
HotkeyClient.removeLocalHotkey(keyArr: string[], handler: (...args: any[]) => void, cb?: StandardErrorCallback<void>) => StandardPromise<void>
LauncherClient{ addToGroups: ; addUserDefinedComponent: ; addWindowsToGroup: ; bringWindowsToFront: (params: { componentType?: string ; groupName?: string ; windowList?: string[] | WindowIdentifier[] }, cb: Function) => Promise<void> ; createWindowGroup: ; getActiveAndPendingWindowNames: ; getActiveDescriptors: (cb?: StandardErrorCallback<Record<string, WindowDescriptor>>) => StandardPromise<Record<string, WindowDescriptor>> ; getComponentDefaultConfig: (componentType: string, cb?: StandardErrorCallback<ComponentDescriptor>) => StandardPromise<ComponentDescriptor> ; getComponentList: (cb?: StandardErrorCallback<ComponentList>) => StandardPromise<ComponentList> ; getComponentsThatCanReceiveDataTypes: ; getGroupsForWindow: ; getMonitor: ; getMonitorInfo: (params: { monitor?: MonitorCommand ; windowIdentifier?: WindowIdentifier }, cb?: StandardErrorCallback<MonitorInfoDetail>) => StandardPromise<MonitorInfoDetail> ; getMonitorInfoAll: (cb?: StandardErrorCallback<MonitorInfoDetail[]>) => StandardPromise<MonitorInfoDetail[]> ; getMyWindowIdentifier: (cb?: (windowIdentifier: WindowIdentifier) => void) => Promise<WindowIdentifier> ; getPendingWindows: ; hyperFocus: ; initialize: () => void ; minimizeWindows: (params: { componentType?: string ; groupName?: string ; windowList?: string[] | WindowIdentifier[] }, cb?: Function) => Promise<void> ; onReady: (cb?: any) => void ; registerComponent: (params: { componentType: string ; manifest: ComponentDescriptor }, cb: StandardErrorCallback<string>) => StandardPromise<string> ; removeUserDefinedComponent: ; removeWindowsFromGroup: ; showWindow: (windowLocator: WindowLocator, params: any, cb?: StandardErrorCallback<SpawnResponse>) => StandardPromise<SpawnResponse> ; spawn: (component: string, params: SpawnParams, cb?: StandardErrorCallback<SpawnResponse>) => Promise<{ error?: StandardError ; response?: SpawnResponse }> ; toggleWindowOnClick: (element: HTMLElement, windowLocator: WindowLocator, params: any) => void ; unRegisterComponent: (params: { componentType: string }, cb?: StandardErrorCallback<string>) => StandardPromise<string> }
LauncherClient.addToGroups
LauncherClient.addUserDefinedComponent
LauncherClient.addWindowsToGroup
LauncherClient.bringWindowsToFront(params: { componentType?: string ; groupName?: string ; windowList?: string[] | WindowIdentifier[] }, cb: Function) => Promise<void>
LauncherClient.createWindowGroup
LauncherClient.getActiveAndPendingWindowNames
LauncherClient.getActiveDescriptors(cb?: StandardErrorCallback<Record<string, WindowDescriptor>>) => StandardPromise<Record<string, WindowDescriptor>>
LauncherClient.getComponentDefaultConfig(componentType: string, cb?: StandardErrorCallback<ComponentDescriptor>) => StandardPromise<ComponentDescriptor>
LauncherClient.getComponentList(cb?: StandardErrorCallback<ComponentList>) => StandardPromise<ComponentList>
LauncherClient.getComponentsThatCanReceiveDataTypes
LauncherClient.getGroupsForWindow
LauncherClient.getMonitor
LauncherClient.getMonitorInfo(params: { monitor?: MonitorCommand ; windowIdentifier?: WindowIdentifier }, cb?: StandardErrorCallback<MonitorInfoDetail>) => StandardPromise<MonitorInfoDetail>
LauncherClient.getMonitorInfoAll(cb?: StandardErrorCallback<MonitorInfoDetail[]>) => StandardPromise<MonitorInfoDetail[]>
LauncherClient.getMyWindowIdentifier(cb?: (windowIdentifier: WindowIdentifier) => void) => Promise<WindowIdentifier>
LauncherClient.getPendingWindows
LauncherClient.hyperFocus
LauncherClient.initialize() => void
LauncherClient.minimizeWindows(params: { componentType?: string ; groupName?: string ; windowList?: string[] | WindowIdentifier[] }, cb?: Function) => Promise<void>
LauncherClient.onReady(cb?: any) => void
LauncherClient.registerComponent(params: { componentType: string ; manifest: ComponentDescriptor }, cb: StandardErrorCallback<string>) => StandardPromise<string>
LauncherClient.removeUserDefinedComponent
LauncherClient.removeWindowsFromGroup
LauncherClient.showWindow(windowLocator: WindowLocator, params: any, cb?: StandardErrorCallback<SpawnResponse>) => StandardPromise<SpawnResponse>
LauncherClient.spawn(component: string, params: SpawnParams, cb?: StandardErrorCallback<SpawnResponse>) => Promise<{ error?: StandardError ; response?: SpawnResponse }>
LauncherClient.toggleWindowOnClick(element: HTMLElement, windowLocator: WindowLocator, params: any) => void
LauncherClient.unRegisterComponent(params: { componentType: string }, cb?: StandardErrorCallback<string>) => StandardPromise<string>
LinkerClientLinkerClient
Logger{ callStack: () => string ; channelFilter: (channel: string) => boolean ; console: { debug: (...args: any[]) => void ; deprecated: (...args: any[]) => void ; error: (...args: any[]) => void ; info: (...args: any[]) => void ; log: (...args: any[]) => void ; verbose: (...args: any[]) => void ; warn: (...args: any[]) => void } ; debug: (...args: any[]) => void ; deprecated: ; error: (...args: any[]) => void ; info: (...args: any[]) => void ; log: (...args: any[]) => void ; perf: { debug: (...args: any[]) => void ; deprecated: (...args: any[]) => void ; error: (...args: any[]) => void ; info: (...args: any[]) => void ; log: (...args: any[]) => void ; verbose: (...args: any[]) => void ; warn: (...args: any[]) => void } ; setRouterClient: (routerClient: { addListener: <T>(channel: string, eventHandler: ListenerCallback<T>) => RouterListenerUnsubscribe ; addPubSubResponder: <T>(topic: string | RegExp, initialState?: object, params?: { publishCallback?: PublishCallback<T> ; subscribeCallback?: SubscribeCallback<T> ; unsubscribeCallback?: UnsubscribeCallback }, callback?: (err?: string | Error, result?: "success") => void) => void ; addResponder: <Q, R>(channel: string, queryEventHandler: StandardErrorCallback<ResponderMessage<Q, R>>) => void ; calibrateTimeWithRouterService: ; disconnectAll: () => void ; onReady: (cb?: () => void) => Promise<void> ; publish: <T>(topic: string, event: T) => void ; query: <Q, R>(responderChannel: string, queryEvent: Q, queryParams?: { logWhenNoResponder?: boolean ; timeout?: number } | QueryResponseCallback<R>, responseEventHandler?: QueryResponseCallback<R>) => Promise<StandardQueryResponse<R>> ; removeListener: (channel: string, eventHandler: Function) => void ; removePubSubResponder: (topic: string | RegExp) => void ; removeResponder: (responderChannel: string) => void ; subscribe: <T>(topic: string, notifyCallback: (err: StandardError, response: SubscriberResponse<T>) => void) => { subscribeID: string ; topic: string } ; transmit: <T>(toChannel: string, data: T, options?: { suppressWarnings: boolean }) => void ; trustedMessage: (incomingMessage: RouterMessage<any>) => boolean ; unsubscribe: (subscribeIDStruct: { subscribeID: string ; topic: string }) => void }) => void ; setting: () => CentralLoggerClientState ; start: (routerClient?: { addListener: <T>(channel: string, eventHandler: ListenerCallback<T>) => RouterListenerUnsubscribe ; addPubSubResponder: <T>(topic: string | RegExp, initialState?: object, params?: { publishCallback?: PublishCallback<T> ; subscribeCallback?: SubscribeCallback<T> ; unsubscribeCallback?: UnsubscribeCallback }, callback?: (err?: string | Error, result?: "success") => void) => void ; addResponder: <Q, R>(channel: string, queryEventHandler: StandardErrorCallback<ResponderMessage<Q, R>>) => void ; calibrateTimeWithRouterService: ; disconnectAll: () => void ; onReady: (cb?: () => void) => Promise<void> ; publish: <T>(topic: string, event: T) => void ; query: <Q, R>(responderChannel: string, queryEvent: Q, queryParams?: { logWhenNoResponder?: boolean ; timeout?: number } | QueryResponseCallback<R>, responseEventHandler?: QueryResponseCallback<R>) => Promise<StandardQueryResponse<R>> ; removeListener: (channel: string, eventHandler: Function) => void ; removePubSubResponder: (topic: string | RegExp) => void ; removeResponder: (responderChannel: string) => void ; subscribe: <T>(topic: string, notifyCallback: (err: StandardError, response: SubscriberResponse<T>) => void) => { subscribeID: string ; topic: string } ; transmit: <T>(toChannel: string, data: T, options?: { suppressWarnings: boolean }) => void ; trustedMessage: (incomingMessage: RouterMessage<any>) => boolean ; unsubscribe: (subscribeIDStruct: { subscribeID: string ; topic: string }) => void }) => void ; system: { debug: (...args: any[]) => void ; deprecated: (...args: any[]) => void ; error: (...args: any[]) => void ; info: (...args: any[]) => void ; log: (...args: any[]) => void ; verbose: (...args: any[]) => void ; warn: (...args: any[]) => void } ; unregisterClient: (params?: { clientName: string ; deleteFromPersistence?: boolean ; viewId?: number }, cb?: (err: StandardError, data?: any) => void) => void ; verbose: (...args: any[]) => void ; warn: (...args: any[]) => void ; onStateChanged: (cb: (newState: CentralLoggerClientState) => void) => void }
Logger.callStack() => string
Logger.channelFilter(channel: string) => boolean
Logger.console{ debug: (...args: any[]) => void ; deprecated: (...args: any[]) => void ; error: (...args: any[]) => void ; info: (...args: any[]) => void ; log: (...args: any[]) => void ; verbose: (...args: any[]) => void ; warn: (...args: any[]) => void }
Logger.console.debug(...args: any[]) => void
Logger.console.deprecated(...args: any[]) => void
Logger.console.error(...args: any[]) => void
Logger.console.info(...args: any[]) => void
Logger.console.log(...args: any[]) => void
Logger.console.verbose(...args: any[]) => void
Logger.console.warn(...args: any[]) => void
Logger.debug(...args: any[]) => void
Logger.deprecated
Logger.error(...args: any[]) => void
Logger.info(...args: any[]) => void
Logger.log(...args: any[]) => void
Logger.perf{ debug: (...args: any[]) => void ; deprecated: (...args: any[]) => void ; error: (...args: any[]) => void ; info: (...args: any[]) => void ; log: (...args: any[]) => void ; verbose: (...args: any[]) => void ; warn: (...args: any[]) => void }
Logger.perf.debug(...args: any[]) => void
Logger.perf.deprecated(...args: any[]) => void
Logger.perf.error(...args: any[]) => void
Logger.perf.info(...args: any[]) => void
Logger.perf.log(...args: any[]) => void
Logger.perf.verbose(...args: any[]) => void
Logger.perf.warn(...args: any[]) => void
Logger.setRouterClient(routerClient: { addListener: <T>(channel: string, eventHandler: ListenerCallback<T>) => RouterListenerUnsubscribe ; addPubSubResponder: <T>(topic: string | RegExp, initialState?: object, params?: { publishCallback?: PublishCallback<T> ; subscribeCallback?: SubscribeCallback<T> ; unsubscribeCallback?: UnsubscribeCallback }, callback?: (err?: string | Error, result?: "success") => void) => void ; addResponder: <Q, R>(channel: string, queryEventHandler: StandardErrorCallback<ResponderMessage<Q, R>>) => void ; calibrateTimeWithRouterService: ; disconnectAll: () => void ; onReady: (cb?: () => void) => Promise<void> ; publish: <T>(topic: string, event: T) => void ; query: <Q, R>(responderChannel: string, queryEvent: Q, queryParams?: { logWhenNoResponder?: boolean ; timeout?: number } | QueryResponseCallback<R>, responseEventHandler?: QueryResponseCallback<R>) => Promise<StandardQueryResponse<R>> ; removeListener: (channel: string, eventHandler: Function) => void ; removePubSubResponder: (topic: string | RegExp) => void ; removeResponder: (responderChannel: string) => void ; subscribe: <T>(topic: string, notifyCallback: (err: StandardError, response: SubscriberResponse<T>) => void) => { subscribeID: string ; topic: string } ; transmit: <T>(toChannel: string, data: T, options?: { suppressWarnings: boolean }) => void ; trustedMessage: (incomingMessage: RouterMessage<any>) => boolean ; unsubscribe: (subscribeIDStruct: { subscribeID: string ; topic: string }) => void }) => void
Logger.setting() => CentralLoggerClientState
Logger.start(routerClient?: { addListener: <T>(channel: string, eventHandler: ListenerCallback<T>) => RouterListenerUnsubscribe ; addPubSubResponder: <T>(topic: string | RegExp, initialState?: object, params?: { publishCallback?: PublishCallback<T> ; subscribeCallback?: SubscribeCallback<T> ; unsubscribeCallback?: UnsubscribeCallback }, callback?: (err?: string | Error, result?: "success") => void) => void ; addResponder: <Q, R>(channel: string, queryEventHandler: StandardErrorCallback<ResponderMessage<Q, R>>) => void ; calibrateTimeWithRouterService: ; disconnectAll: () => void ; onReady: (cb?: () => void) => Promise<void> ; publish: <T>(topic: string, event: T) => void ; query: <Q, R>(responderChannel: string, queryEvent: Q, queryParams?: { logWhenNoResponder?: boolean ; timeout?: number } | QueryResponseCallback<R>, responseEventHandler?: QueryResponseCallback<R>) => Promise<StandardQueryResponse<R>> ; removeListener: (channel: string, eventHandler: Function) => void ; removePubSubResponder: (topic: string | RegExp) => void ; removeResponder: (responderChannel: string) => void ; subscribe: <T>(topic: string, notifyCallback: (err: StandardError, response: SubscriberResponse<T>) => void) => { subscribeID: string ; topic: string } ; transmit: <T>(toChannel: string, data: T, options?: { suppressWarnings: boolean }) => void ; trustedMessage: (incomingMessage: RouterMessage<any>) => boolean ; unsubscribe: (subscribeIDStruct: { subscribeID: string ; topic: string }) => void }) => void
Logger.system{ debug: (...args: any[]) => void ; deprecated: (...args: any[]) => void ; error: (...args: any[]) => void ; info: (...args: any[]) => void ; log: (...args: any[]) => void ; verbose: (...args: any[]) => void ; warn: (...args: any[]) => void }
Logger.system.debug(...args: any[]) => void
Logger.system.deprecated(...args: any[]) => void
Logger.system.error(...args: any[]) => void
Logger.system.info(...args: any[]) => void
Logger.system.log(...args: any[]) => void
Logger.system.verbose(...args: any[]) => void
Logger.system.warn(...args: any[]) => void
Logger.unregisterClient(params?: { clientName: string ; deleteFromPersistence?: boolean ; viewId?: number }, cb?: (err: StandardError, data?: any) => void) => void
Logger.verbose(...args: any[]) => void
Logger.warn(...args: any[]) => void
Logger.onStateChanged[object Object]
NotificationClient{ Action: typeof Action ; ActionTypes: typeof ActionTypes ; Filter: typeof Filter ; Notification: typeof Notification ; Subscription: typeof Subscription ; actionTypes: typeof ActionTypes = ActionTypes; deleteNotifications: (notifications: INotification[]) => Promise<void> ; fetchHistory: (options?: string | INotificationHistoryOptions, filter?: IFilter) => Promise<INotification[]> ; getLastIssuedAt: (source?: string) => Promise<string> ; getMuteFilters: () => Promise<IMuteFilter[]> ; getPreferences: () => Promise<Object> ; getSources: () => Promise<string[]> ; initialize: () => void ; markRead: (notifications: INotification[]) => Promise<void> ; markUnread: (notifications: INotification[]) => Promise<void> ; mute: (filter: IMuteFilter | IMuteFilter[]) => Promise<void> ; notify: (notifications: Partial<INotification> | Partial<INotification>[]) => Promise<void> ; onClose: (cb?: () => void) => void ; onReady: (cb?: any) => void ; performAction: (notifications: Partial<INotification>[], action: IAction) => Promise<void> ; subscribe: (subscription: Partial<ISubscription>, onNotification: OnNotificationCallback) => Promise<{ channel: string ; id: string }> ; unmute: (filter: IMuteFilter | IMuteFilter[]) => Promise<void> ; unsubscribe: (subscriptionId: string) => Promise<void> ; unsubscribeAll: () => void }
NotificationClient.Actiontypeof Action
NotificationClient.ActionTypestypeof ActionTypes
NotificationClient.Filtertypeof Filter
NotificationClient.Notificationtypeof Notification
NotificationClient.Subscriptiontypeof Subscription
NotificationClient.actionTypestypeof ActionTypes
NotificationClient.deleteNotifications(notifications: INotification[]) => Promise<void>
NotificationClient.fetchHistory(options?: string | INotificationHistoryOptions, filter?: IFilter) => Promise<INotification[]>
NotificationClient.getLastIssuedAt(source?: string) => Promise<string>
NotificationClient.getMuteFilters() => Promise<IMuteFilter[]>
NotificationClient.getPreferences() => Promise<Object>
NotificationClient.getSources() => Promise<string[]>
NotificationClient.initialize() => void
NotificationClient.markRead(notifications: INotification[]) => Promise<void>
NotificationClient.markUnread(notifications: INotification[]) => Promise<void>
NotificationClient.mute(filter: IMuteFilter | IMuteFilter[]) => Promise<void>
NotificationClient.notify(notifications: Partial<INotification> | Partial<INotification>[]) => Promise<void>
NotificationClient.onClose(cb?: () => void) => void
NotificationClient.onReady(cb?: any) => void
NotificationClient.performAction(notifications: Partial<INotification>[], action: IAction) => Promise<void>
NotificationClient.subscribe(subscription: Partial<ISubscription>, onNotification: OnNotificationCallback) => Promise<{ channel: string ; id: string }>
NotificationClient.unmute(filter: IMuteFilter | IMuteFilter[]) => Promise<void>
NotificationClient.unsubscribe(subscriptionId: string) => Promise<void>
NotificationClient.unsubscribeAll() => void
RouterClient{ addListener: <T>(channel: string, eventHandler: ListenerCallback<T>) => RouterListenerUnsubscribe ; addPubSubResponder: <T>(topic: string | RegExp, initialState?: object, params?: { publishCallback?: PublishCallback<T> ; subscribeCallback?: SubscribeCallback<T> ; unsubscribeCallback?: UnsubscribeCallback }, callback?: (err?: string | Error, result?: "success") => void) => void ; addResponder: <Q, R>(channel: string, queryEventHandler: StandardErrorCallback<ResponderMessage<Q, R>>) => void ; calibrateTimeWithRouterService: ; disconnectAll: () => void ; onReady: (cb?: () => void) => Promise<void> ; publish: <T>(topic: string, event: T) => void ; query: <Q, R>(responderChannel: string, queryEvent: Q, queryParams?: { logWhenNoResponder?: boolean ; timeout?: number } | QueryResponseCallback<R>, responseEventHandler?: QueryResponseCallback<R>) => Promise<StandardQueryResponse<R>> ; removeListener: (channel: string, eventHandler: Function) => void ; removePubSubResponder: (topic: string | RegExp) => void ; removeResponder: (responderChannel: string) => void ; subscribe: <T>(topic: string, notifyCallback: (err: StandardError, response: SubscriberResponse<T>) => void) => { subscribeID: string ; topic: string } ; transmit: <T>(toChannel: string, data: T, options?: { suppressWarnings: boolean }) => void ; trustedMessage: (incomingMessage: RouterMessage<any>) => boolean ; unsubscribe: (subscribeIDStruct: { subscribeID: string ; topic: string }) => void }
RouterClient.addListener<T>(channel: string, eventHandler: ListenerCallback<T>) => RouterListenerUnsubscribe
RouterClient.addPubSubResponder<T>(topic: string | RegExp, initialState?: object, params?: { publishCallback?: PublishCallback<T> ; subscribeCallback?: SubscribeCallback<T> ; unsubscribeCallback?: UnsubscribeCallback }, callback?: (err?: string | Error, result?: "success") => void) => void
RouterClient.addResponder<Q, R>(channel: string, queryEventHandler: StandardErrorCallback<ResponderMessage<Q, R>>) => void
RouterClient.calibrateTimeWithRouterService
RouterClient.disconnectAll() => void
RouterClient.onReady(cb?: () => void) => Promise<void>
RouterClient.publish<T>(topic: string, event: T) => void
RouterClient.query<Q, R>(responderChannel: string, queryEvent: Q, queryParams?: { logWhenNoResponder?: boolean ; timeout?: number } | QueryResponseCallback<R>, responseEventHandler?: QueryResponseCallback<R>) => Promise<StandardQueryResponse<R>>
RouterClient.removeListener(channel: string, eventHandler: Function) => void
RouterClient.removePubSubResponder(topic: string | RegExp) => void
RouterClient.removeResponder(responderChannel: string) => void
RouterClient.subscribe<T>(topic: string, notifyCallback: (err: StandardError, response: SubscriberResponse<T>) => void) => { subscribeID: string ; topic: string }
RouterClient.transmit<T>(toChannel: string, data: T, options?: { suppressWarnings: boolean }) => void
RouterClient.trustedMessage(incomingMessage: RouterMessage<any>) => boolean
RouterClient.unsubscribe(subscribeIDStruct: { subscribeID: string ; topic: string }) => void
SearchClient{ initialize: () => void ; invokeItemAction: (item: any, action: { name: string }) => void ; invokeProviderAction: (provider: { channel: string }) => void ; onReady: (cb?: any) => void ; register: (params: { itemActionCallback?: Function ; name: string ; providerActionCallback?: Function ; providerActionTitle?: null | string ; searchCallback: Function }, cb?: StandardErrorCallback<{ status: string }>) => StandardPromise<{ status: string }> ; search: (params: { text: string ; windowName?: string }, cb: Function) => Promise<void> ; unregister: (params: { name: string }, cb?: Function) => Promise<void> }
SearchClient.initialize() => void
SearchClient.invokeItemAction(item: any, action: { name: string }) => void
SearchClient.invokeProviderAction(provider: { channel: string }) => void
SearchClient.onReady(cb?: any) => void
SearchClient.register(params: { itemActionCallback?: Function ; name: string ; providerActionCallback?: Function ; providerActionTitle?: null | string ; searchCallback: Function }, cb?: StandardErrorCallback<{ status: string }>) => StandardPromise<{ status: string }>
SearchClient.search(params: { text: string ; windowName?: string }, cb: Function) => Promise<void>
SearchClient.unregister(params: { name: string }, cb?: Function) => Promise<void>
StorageClient{ clearCache: (cb?: StandardErrorCallback<void>) => StandardPromise<void> ; delete: (...args: any[]) => void = deleteInner; get: <T>(params: { key: string ; topic: string }, cb?: StandardErrorCallback<T>) => Promise<T> ; get1: <T>(params: { key: string ; topic: string }, cb?: StandardErrorCallback<T>) => Promise<T> ; getMultiple: ; getStandardized: <T>(params: { key: string ; topic: string }, cb?: StandardErrorCallback<T>) => StandardPromise<T> ; initialize: () => void ; keys: (params: { keyPrefix?: string ; topic: string }, cb?: StandardErrorCallback<string[]>) => StandardPromise<string[]> ; keys1: (params: { keyPrefix?: string ; topic: string }) => Promise<string[]> ; onReady: (cb?: any) => void ; remove: (params: { key: string ; topic: string }, cb?: StandardErrorCallback<void>) => StandardPromise<void> ; remove1: (params: { key: string ; topic: string }) => void ; save: (params: ComponentMutateParams, cb?: StandardErrorCallback<void>) => StandardPromise<void> ; save1: (params: { key: string ; topic: string ; value: any }) => void ; setStore: ; setUser: (params: { user: string }, cb?: StandardErrorCallback<void>) => StandardPromise<void> }
StorageClient.clearCache(cb?: StandardErrorCallback<void>) => StandardPromise<void>
StorageClient.delete(...args: any[]) => void
StorageClient.get<T>(params: { key: string ; topic: string }, cb?: StandardErrorCallback<T>) => Promise<T>
StorageClient.get1<T>(params: { key: string ; topic: string }, cb?: StandardErrorCallback<T>) => Promise<T>
StorageClient.getMultiple
StorageClient.getStandardized<T>(params: { key: string ; topic: string }, cb?: StandardErrorCallback<T>) => StandardPromise<T>
StorageClient.initialize() => void
StorageClient.keys(params: { keyPrefix?: string ; topic: string }, cb?: StandardErrorCallback<string[]>) => StandardPromise<string[]>
StorageClient.keys1(params: { keyPrefix?: string ; topic: string }) => Promise<string[]>
StorageClient.onReady(cb?: any) => void
StorageClient.remove(params: { key: string ; topic: string }, cb?: StandardErrorCallback<void>) => StandardPromise<void>
StorageClient.remove1(params: { key: string ; topic: string }) => void
StorageClient.save(params: ComponentMutateParams, cb?: StandardErrorCallback<void>) => StandardPromise<void>
StorageClient.save1(params: { key: string ; topic: string ; value: any }) => void
StorageClient.setStore
StorageClient.setUser(params: { user: string }, cb?: StandardErrorCallback<void>) => StandardPromise<void>
WindowClient{ addListeners: () => void ; bringToFront: (cb?: StandardErrorCallback<void>) => StandardPromise<void> ; bringWindowToFront: (cb?: StandardErrorCallback<void>) => void ; cacheInitialBounds: () => Promise<void> ; cancelTilingOrTabbing: (params: { windowIdentifier?: WindowIdentifier }, cb?: () => void) => void ; close: (params: { closeWindow: boolean ; ignoreParent?: boolean ; removeFromWorkspace: boolean ; userInitiated?: boolean }, cb?: StandardErrorCallback<void>) => StandardPromise<void> ; commandChannel: undefined | (arg0: any, arg1: any) => void ; ejectFromGroup: () => void ; fitToDOM: (params?: null | { maxHeight?: number ; maxWidth?: number ; padding?: { height: number ; width: number } }, cb?: () => void) => Promise<void> ; formGroup: () => void ; getBounds: (cb: StandardErrorCallback<Bounds>) => StandardPromise<Bounds> ; getComponentState: <T>(params: { field?: string ; fields?: string[] ; windowName?: string }, cb?: StandardErrorCallback<T>) => StandardPromise<T> ; getCurrentWindow: () => FEAWindow ; getDesktopBoundingBox: (element: string | Element) => Promise<{ bottom: number = 0; height: number = box.height; left: number ; right: number = 0; top: number ; width: number = box.width }> ; getMonitorInfo: (params: { monitor?: MonitorCommand ; windowIdentifier?: WindowIdentifier }, cb?: StandardErrorCallback<MonitorInfoDetail>) => StandardPromise<MonitorInfoDetail> ; getSpawnData: () => any ; getStackedWindow: (params?: StandardCallback<StandardError, any> | getStackedWindowParams, cb?: StandardCallback<StandardError, any>) => void ; getWindowBounds: () => Bounds ; getWindowGroups: () => GroupData[] ; getWindowIdentifier: () => WindowIdentifier ; getWindowNameForDocking: () => any ; getWindowTitle: () => null | string ; headerCommandChannel: (commandChannel: (arg0: any, arg1: any) => void) => void ; initialize: Function ; injectDOM: (headerHeight: number) => void ; isMouseOverDOMElement: (element: Element, cb?: (result: boolean) => void) => Promise<boolean> ; isPointInBox: (point: { x: number ; y: number }, box: { bottom?: number ; height: number ; left: number ; right?: number ; top: number ; width: number }) => boolean ; maximize: (cb?: StandardErrorCallback<void>) => StandardPromise<void> ; minimize: (cb?: StandardErrorCallback<void>) => StandardPromise<void> ; onReady: Function ; options: WindowOptions ; removeComponentState: (params: { field?: string ; fields?: { field: string }[] ; windowName?: string }, cb?: StandardErrorCallback<void>) => StandardPromise<void> ; restore: (cb?: StandardErrorCallback<void>) => StandardPromise<void> ; retrieveMonitorDimensions: (cb: (monitorInfo: MonitorCoordinates) => void) => Promise<void> ; saveWindowBounds: (bounds: WindowBounds, setActiveWorkspaceDirty: boolean) => void ; sendIdentifierForTilingOrTabbing: (params: { windowIdentifier: WindowIdentifier }, cb?: () => void) => void ; setActive: (active: boolean) => void ; setAlwaysOnTop: (alwaysOnTop: boolean, cb?: StandardErrorCallback<void>) => StandardPromise<void> ; setComponentState: <T>(params: { field?: string ; fields?: { field: string ; value: T }[] ; value?: T ; windowName?: string }, cb?: StandardErrorCallback<void>) => StandardPromise<void> ; setShape: (params?: (null | { height: Number ; width: Number ; x: Number ; y: Number })[], callback: Function) => void ; setTaskbarIconOverlay: (url: null | string) => void ; setWindowTitle: (title: string) => void ; setWindowTitlePrivate: (title: string) => void ; showAtMousePosition: () => void ; startMovingWindow: (event: MouseEvent) => void ; startTilingOrTabbing: (params: { windowIdentifier: WindowIdentifier }, cb?: () => void) => void ; stopMovingWindow: () => void ; stopTilingOrTabbing: (params: { action?: string ; allowDropOnSelf?: boolean ; mousePosition?: { x: number ; y: number } }, cb?: () => void) => void ; title: null | string ; windowGroups: GroupData[] }
WindowClient.addListeners() => void
WindowClient.bringToFront(cb?: StandardErrorCallback<void>) => StandardPromise<void>
WindowClient.bringWindowToFront(cb?: StandardErrorCallback<void>) => void
WindowClient.cacheInitialBounds() => Promise<void>
WindowClient.cancelTilingOrTabbing(params: { windowIdentifier?: WindowIdentifier }, cb?: () => void) => void
WindowClient.close(params: { closeWindow: boolean ; ignoreParent?: boolean ; removeFromWorkspace: boolean ; userInitiated?: boolean }, cb?: StandardErrorCallback<void>) => StandardPromise<void>
WindowClient.commandChannelundefined | (arg0: any, arg1: any) => void
WindowClient.ejectFromGroup() => void
WindowClient.fitToDOM(params?: null | { maxHeight?: number ; maxWidth?: number ; padding?: { height: number ; width: number } }, cb?: () => void) => Promise<void>
WindowClient.formGroup() => void
WindowClient.getBounds(cb: StandardErrorCallback<Bounds>) => StandardPromise<Bounds>
WindowClient.getComponentState<T>(params: { field?: string ; fields?: string[] ; windowName?: string }, cb?: StandardErrorCallback<T>) => StandardPromise<T>
WindowClient.getCurrentWindow() => FEAWindow
WindowClient.getDesktopBoundingBox(element: string | Element) => Promise<{ bottom: number = 0; height: number = box.height; left: number ; right: number = 0; top: number ; width: number = box.width }>
WindowClient.getMonitorInfo(params: { monitor?: MonitorCommand ; windowIdentifier?: WindowIdentifier }, cb?: StandardErrorCallback<MonitorInfoDetail>) => StandardPromise<MonitorInfoDetail>
WindowClient.getSpawnData() => any
WindowClient.getStackedWindow(params?: StandardCallback<StandardError, any> | getStackedWindowParams, cb?: StandardCallback<StandardError, any>) => void
WindowClient.getWindowBounds() => Bounds
WindowClient.getWindowGroups() => GroupData[]
WindowClient.getWindowIdentifier() => WindowIdentifier
WindowClient.getWindowNameForDocking() => any
WindowClient.getWindowTitle() => null | string
WindowClient.headerCommandChannel(commandChannel: (arg0: any, arg1: any) => void) => void
WindowClient.initializeFunction
WindowClient.injectDOM(headerHeight: number) => void
WindowClient.isMouseOverDOMElement(element: Element, cb?: (result: boolean) => void) => Promise<boolean>
WindowClient.isPointInBox(point: { x: number ; y: number }, box: { bottom?: number ; height: number ; left: number ; right?: number ; top: number ; width: number }) => boolean
WindowClient.maximize(cb?: StandardErrorCallback<void>) => StandardPromise<void>
WindowClient.minimize(cb?: StandardErrorCallback<void>) => StandardPromise<void>
WindowClient.onReadyFunction
WindowClient.optionsWindowOptions
WindowClient.removeComponentState(params: { field?: string ; fields?: { field: string }[] ; windowName?: string }, cb?: StandardErrorCallback<void>) => StandardPromise<void>
WindowClient.restore(cb?: StandardErrorCallback<void>) => StandardPromise<void>
WindowClient.retrieveMonitorDimensions(cb: (monitorInfo: MonitorCoordinates) => void) => Promise<void>
WindowClient.saveWindowBounds(bounds: WindowBounds, setActiveWorkspaceDirty: boolean) => void
WindowClient.sendIdentifierForTilingOrTabbing(params: { windowIdentifier: WindowIdentifier }, cb?: () => void) => void
WindowClient.setActive(active: boolean) => void
WindowClient.setAlwaysOnTop(alwaysOnTop: boolean, cb?: StandardErrorCallback<void>) => StandardPromise<void>
WindowClient.setComponentState<T>(params: { field?: string ; fields?: { field: string ; value: T }[] ; value?: T ; windowName?: string }, cb?: StandardErrorCallback<void>) => StandardPromise<void>
WindowClient.setShape(params?: (null | { height: Number ; width: Number ; x: Number ; y: Number })[], callback: Function) => void
WindowClient.setTaskbarIconOverlay(url: null | string) => void
WindowClient.setWindowTitle(title: string) => void
WindowClient.setWindowTitlePrivate(title: string) => void
WindowClient.showAtMousePosition() => void
WindowClient.startMovingWindow(event: MouseEvent) => void
WindowClient.startTilingOrTabbing(params: { windowIdentifier: WindowIdentifier }, cb?: () => void) => void
WindowClient.stopMovingWindow() => void
WindowClient.stopTilingOrTabbing(params: { action?: string ; allowDropOnSelf?: boolean ; mousePosition?: { x: number ; y: number } }, cb?: () => void) => void
WindowClient.titlenull | string
WindowClient.windowGroupsGroupData[]
WorkspaceClient{ _getWindowState: ; _setWindowState: (params: any) => Promise<RouterResponse<boolean>> ; addEventListener: (event: WorkspaceEventName, handler: FinsembleEventHandler) => void ; addWindow: (params: any, cb: any) => void ; addWorkspaceDefinition: (params: any, cb: any) => Promise<Record<string, string>> ; autoArrange: (params: any, cb?: StandardErrorCallback<void>) => StandardPromise<void> ; bringWindowsToFront: (params?: { monitor: string ; windowIdentifier?: any }, cb?: StandardErrorCallback<void>) => StandardPromise<void> ; createNewWorkspace: (workspaceName: any, params: any, cb: any) => Promise<{ workspaceName: string }> ; createWorkspace: (workspaceName: string, params?: { switchAfterCreation?: boolean }, cb: (err: any, result: { workspaceName: string }) => void) => Promise<{ workspaceName: string }> ; export: (params: { workspaceName: string }, cb: Function) => Promise<unknown> = exportWorkspace; exportToFile: ; getActiveWorkspace: (cb?: StandardErrorCallback<{ data: Workspace }>) => Promise<{ data: Workspace }> ; getWorkspaceActions: (cb?: StandardErrorCallback<Record<string, string>>) => Record<string, string> ; getWorkspaceDefinition: (params: any, cb: any) => Promise<unknown> ; getWorkspaceNames: (cb?: StandardErrorCallback<string[]>) => Promise<unknown> ; getWorkspaces: (cb?: Function) => Promise<unknown> ; import: (params: { force: boolean ; workspaceJSONDefinition: Record<string, string | Workspace> }, cb?: Function) => Promise<Record<string, string>> = importWorkspace; initialize: () => void ; isWorkspaceDirty: (cb?: Function) => Promise<boolean> ; minimizeAll: (params?: { monitor: string ; windowIdentifier?: any }, cb?: StandardErrorCallback<void>) => StandardPromise<void> ; onReady: (cb?: any) => void ; remove: (params: { name?: string ; workspace?: { name: string } }, cb?: Function) => Promise<unknown> ; removeEventListener: (event: WorkspaceEventName, handler: FinsembleEventHandler) => void ; removeWindow: (params: any, cb: any) => void ; rename: (params: { newName: string ; oldName: string ; overwriteExisting?: boolean ; removeOldWorkspace?: boolean }, cb?: Function) => Promise<unknown> ; save: (cb?: Function) => Promise<unknown> ; saveAs: (params: { force?: boolean ; name: string }, cb?: Function) => Promise<unknown> ; saveWorkspaceTemplateToConfigFile: (params: any) => void ; setWorkspaceOrder: ; setWorkspaces: (params: any, cb: any) => Promise<unknown> ; switchTo: (params: { name: string }, cb?: StandardErrorCallback<{ data: Workspace }>) => Promise<{ data: Workspace }> ; workspaceExists: (workspaceName: any) => void ; activeWorkspace: ; workspaces: }
WorkspaceClient._getWindowState
WorkspaceClient._setWindowState(params: any) => Promise<RouterResponse<boolean>>
WorkspaceClient.addEventListener(event: WorkspaceEventName, handler: FinsembleEventHandler) => void
WorkspaceClient.addWindow(params: any, cb: any) => void
WorkspaceClient.addWorkspaceDefinition(params: any, cb: any) => Promise<Record<string, string>>
WorkspaceClient.autoArrange(params: any, cb?: StandardErrorCallback<void>) => StandardPromise<void>
WorkspaceClient.bringWindowsToFront(params?: { monitor: string ; windowIdentifier?: any }, cb?: StandardErrorCallback<void>) => StandardPromise<void>
WorkspaceClient.createNewWorkspace(workspaceName: any, params: any, cb: any) => Promise<{ workspaceName: string }>
WorkspaceClient.createWorkspace(workspaceName: string, params?: { switchAfterCreation?: boolean }, cb: (err: any, result: { workspaceName: string }) => void) => Promise<{ workspaceName: string }>
WorkspaceClient.export(params: { workspaceName: string }, cb: Function) => Promise<unknown>
WorkspaceClient.exportToFile
WorkspaceClient.getActiveWorkspace(cb?: StandardErrorCallback<{ data: Workspace }>) => Promise<{ data: Workspace }>
WorkspaceClient.getWorkspaceActions(cb?: StandardErrorCallback<Record<string, string>>) => Record<string, string>
WorkspaceClient.getWorkspaceDefinition(params: any, cb: any) => Promise<unknown>
WorkspaceClient.getWorkspaceNames(cb?: StandardErrorCallback<string[]>) => Promise<unknown>
WorkspaceClient.getWorkspaces(cb?: Function) => Promise<unknown>
WorkspaceClient.import(params: { force: boolean ; workspaceJSONDefinition: Record<string, string | Workspace> }, cb?: Function) => Promise<Record<string, string>>
WorkspaceClient.initialize() => void
WorkspaceClient.isWorkspaceDirty(cb?: Function) => Promise<boolean>
WorkspaceClient.minimizeAll(params?: { monitor: string ; windowIdentifier?: any }, cb?: StandardErrorCallback<void>) => StandardPromise<void>
WorkspaceClient.onReady(cb?: any) => void
WorkspaceClient.remove(params: { name?: string ; workspace?: { name: string } }, cb?: Function) => Promise<unknown>
WorkspaceClient.removeEventListener(event: WorkspaceEventName, handler: FinsembleEventHandler) => void
WorkspaceClient.removeWindow(params: any, cb: any) => void
WorkspaceClient.rename(params: { newName: string ; oldName: string ; overwriteExisting?: boolean ; removeOldWorkspace?: boolean }, cb?: Function) => Promise<unknown>
WorkspaceClient.save(cb?: Function) => Promise<unknown>
WorkspaceClient.saveAs(params: { force?: boolean ; name: string }, cb?: Function) => Promise<unknown>
WorkspaceClient.saveWorkspaceTemplateToConfigFile(params: any) => void
WorkspaceClient.setWorkspaceOrder
WorkspaceClient.setWorkspaces(params: any, cb: any) => Promise<unknown>
WorkspaceClient.switchTo(params: { name: string }, cb?: StandardErrorCallback<{ data: Workspace }>) => Promise<{ data: Workspace }>
WorkspaceClient.workspaceExists(workspaceName: any) => void
`get activeWorkspace(): undefined | Workspace`[object Object]
`get workspaces(): string[]`[object Object]
baseClienttypeof _BaseClient

FEAGlobals​

• FEAGlobals: IFEAGlobals & Partial<Window & typeof globalThis>

Use this Globals object only when you are certain to be running inside FEA. This object has guaranteed fin and finsembleWindow members.

FreestandingGlobals​

• FreestandingGlobals: IFreestandingGlobals & Partial<Window & typeof globalThis>

Use this Globals object only when you are certain to be running as a Freestanding app. This object has guaranteed fin and finsembleWindow members.

Globals​

• Globals: IGlobals & Partial<Window & typeof globalThis>

Use this Globals object in lieu of window (browser) or global (node). This provides typesafety!

Fields from window are provided via typescript Partial<>. This means that code using Globals must dynamically check for the existence of the window (because it's possible we could be running outside of a browser, such as in node or a unit test).

If you are certain to be running in FEA then use FEAGlobals.

models​

• Const models: Object

Used for build storage adapters

Type declaration​

NameType
baseStorage(this: IBaseStorage, args: string) => void