@finsemble/finsemble-ui 10.0.0-iocd.8 → 10.0.3-beta.2

package/deprecated/linkerClient.d.ts

@@ -1,423 +1,423 @@
-/*!
- * Copyright 2017 - 2020 by ChartIQ, Inc.
- * All rights reserved.
- */
-import { StoreModel } from "../clients/distributedStoreClient";
-import { StandardCallback } from "../types";
-import { WindowIdentifier } from "../platform/services/window/types";
-export declare type linkerGroup = {
-    /**
-     * name of the channel
-     */
-    name: string;
-    /**
-     * color. Required to use Finsemble's built-in Linker component.
-     */
-    color?: string;
-    /**
-     * border color. Required to use Finsemble's built-in Linker component.
-     */
-    border?: string;
-};
-/**
- * @phantom Don't display in Typedoc
- */
-export declare class LinkerClient {
-    linkerStore?: StoreModel;
-    dontPersistYet: boolean | undefined;
-    constructor();
-    stateChangeListeners: any[];
-    allChannels: any[];
-    channels: {};
-    clients: {};
-    channelListenerList: any[];
-    dataListenerList: {};
-    /**
-     * 1/24/19 this is Brad guessing. This function has never existed. This is the first commit where 'getChannel' is referenced...but not defined.
-     *
-     * https://github.com/ChartIQ/finsemble/blob/ad25aa219c5fac60c277bccf35dea43568da2a07/src/clients/linkerClient.js
-     *
-     * No idea how it ever worked.
-     * @private
-     *
-     */
-    getChannel(name: string): boolean;
-    /**
-     * @deprecated The LinkerClient has been deprecated.
-     *
-     * Create a new Linker channel. This channel will be available *globally*.
-     *
-     * ```javascript
-     * LinkerClient.createChannel({name: "red", color: "#ff0000", border: "#ffffff"}, callback)
-     * ```
-     * @param {object} params
-     * @param cb - Optional. Callback to retrieve returned results asynchronously.
-     * @return {Array.<string>} Returns an array of all available channels
-     * @private
-     * @memberof LinkerClient
-     */
-    createChannel(params: linkerGroup, cb: Function): any;
-    /**
-     * Remove a Linker channel. It will be removed globally. Any component that is currently assigned to this channel will be unassigned.
-     *
-     * ```javascript
-     * FSBL.Clients.LinkerClient.removeChannel("group1")
-     * ```
-     * @param {string} name - The name of the channel to remove
-     * @param cb - Optional. Callback to retrieve returned results asynchronously
-     * @returns {Array.<string>} Returns an array of available channels
-     * @private
-     * @memberof LinkerClient
-     */
-    removeChannel(name: string, cb: Function): any;
-    /**
-     * Convenience function to update the client information in the store.
-     * @private
-     */
-    updateClientInStore(key: any): void;
-    /**
-     * @deprecated The LinkerClient has been deprecated.
-     *
-     * Add a component to a Linker channel programmatically. Components will begin receiving any new contexts published to this channel but will <b>not</b> receive the currently established context.
-     *
-     * ```javascript
-     * FSBL.Clients.LinkerClient.linkToChannel("group3", null); // Link current window to channel.
-     * FSBL.Clients.LinkerClient.linkToChannel("group3", windowIdentifier); // Link the requested window to channel.
-     * ```
-     * @param {string} channel - The name of the channel to link our component to, or an array of names.
-     * @param windowIdentifier -  Optional. windowIdentifier for the component. If null, it defaults to the current window.
-     * @param cb - Optional. Callback to retrieve returned results asynchronously.
-     * @return {LinkerState} The new state: linked channels, all channels
-     * @memberof LinkerClient
-     */
-    linkToChannel(channel: string | string[], windowIdentifier?: WindowIdentifier, cb?: Function): any;
-    /**
-     * @deprecated The LinkerClient has been deprecated.
-     *
-     * Unlinks a component from a Linker channel.
-     *
-     * ```javascript
-     * FSBL.Clients.LinkerClient.unlinkFromChannel("group1", null); // Unlink the current window from channel "group1"
-     * FSBL.Clients.LinkerClient.unlinkFromChannel("group1", windowIdentifier) // Unlink the requested window from channel "group1"
-     * ```
-     * @param {string} channel - Channel to remove, or an array of channels. If null, then all channels will be removed.
-     * @param windowIdentifier -  windowIdentifier for the window. Defaults to current window if left null.
-     * @param cb - Optional. Callback to retrieve returned results asynchronously.
-     * @return {LinkerState} Returns the new state: linked channels, all channels
-     * @memberof LinkerClient
-     */
-    unlinkFromChannel(channel: string | string[], windowIdentifier?: WindowIdentifier, cb?: Function): any;
-    /**
-     * @deprecated The LinkerClient has been deprecated.
-     *
-     * Returns all available Linker channels.
-     * ```javascript
-     * let groups = FSBL.Clients.LinkerClient.getAllChannels();
-     * ```
-     *
-     * ```javascript
-     * FSBL.Clients.LinkerClient.getAllChannels((err, channels) => { ... });
-     * ```
-     * @param cb Optional. Callback to retrieve returned results asynchronously.
-     * @return {array} An array of all channels. Each array item is {name:channelName} plus any other optional fields such as color.
-     * @memberof LinkerClient
-     */
-    getAllChannels(cb?: Function): any;
-    /**
-     * Retrieve all channels linked to the requested component. Also returns all available channels.
-     *
-     * ```javascript
-     * var state=LinkerClient.getState(windowIdentifier)
-     * ```
-     * @param windowIdentifier Retrieve all channels for identified window. If null, will retrieve for the current window.
-     * @param cb Optional. Callback to retrieve returned results asynchronously
-     * @return {LinkerState} The current state: linked channels, all channels
-     * @private
-     */
-    getState(windowIdentifier?: WindowIdentifier, cb?: StandardCallback): any;
-    /**
-     * @deprecated The LinkerClient has been deprecated.
-     *
-     * Remove all listeners for the specified dataType.
-     *
-     * ```javascript
-     * FSBL.Clients.LinkerClient.unsubscribe("symbol");
-     * ```
-     * @param {String}  dataType - The data type to which the component is subscribed.
-     * @param {function} listener - Optional. The function that was passed to subscribe. If not specified, all listeners will be deleted.
-     * @memberof LinkerClient
-     */
-    unsubscribe(dataType: string, listener?: Function): void;
-    /**
-     * @deprecated The LinkerClient has been deprecated.
-     *
-     * Publish a piece of data. The data will be published to <b>all channels</b> that the component is linked to. Foreign components that are linked to those channels will receive the data if they have subscribed to this dataType. They can then use that data to synchronize their internal state. See <a href="#subscribe">LinkerClient.subscribe()</a>.
-     *
-     * ```javascript
-     * FSBL.Clients.LinkerClient.publish({ dataType:"symbol", data:"AAPL" })
-     * ```
-     * @param {String}  params.dataType - A string representing the data type being sent.
-     * @param {any}  params.data - The data ("context") being transmitted.
-     * @param {array<string>} params.channels - Optional. Specifies which channels publish this piece of data. This overrides the default which is to publish to all linked channels.
-     * @param cb - Optional. Callback to retrieve returned results asynchronously.
-     * @memberof LinkerClient
-     */
-    publish(params: {
-        dataType: string;
-        data: any;
-        channels?: string[];
-    }, cb: StandardCallback): any;
-    /**
-     * @deprecated The LinkerClient has been deprecated.
-     *
-     * Registers a client for a specific data type that is sent to a channel. Calling `subscribe` multiple times adds additional handlers. A component may be subscribed to a maximum of six channels at the same time.
-     * Please note that the signature of the .Net version of this function differs slightly.
-     *
-     * ```javascript
-     * FSBL.Clients.LinkerClient.subscribe("symbol", (data, response) => {
-     * 	if (!response.originatedHere()) {
-     * 		const data = response.data;
-     * 		// Logic to perform with data
-     * 	}
-     * });
-     * ```
-     * @param {String} dataType A string representing the data type to subscribe to.
-     * @param {Function} listener A function `(data, response)` to be called once the Linker receives the specific data. Use <b>response.originatedHere()</b> to determine if the calling window is also the publisher
-     * @memberof LinkerClient
-     */
-    subscribe(dataType: string, listener: Function): void;
-    /**
-     * @deprecated The LinkerClient has been deprecated.
-     *
-     * Retrieves an array of all components with links that match the given parameters. If no parameters are specified, all windows with established links will be returned.
-     *
-     * Get all components linked to a given component:
-     * ```javascript
-     * FSBL.Clients.LinkerClient.getLinkedComponents({ windowIdentifier: wi });
-     * ```
-     *
-     * Get all components linked to channel "group 1":
-     * ```javascript
-     * FSBL.Clients.LinkerClient.getLinkedComponents({ channels: ['group1'] });
-     * // Response format: [{windowName: 'Window Name', componentType: 'Component Type', uuid: 'uuid', channels: ['group1'] }]
-     * ```
-     * @param {object} params Optional
-     * @param {Array.<string>} params.channels Restrict to these channels.
-     * @param {Array.<string>} params.componentTypes Restrict to these componentTypes. The componentType is a key in the finsemble.components configuration object.
-     * @param {windowIdentifier} params.windowIdentifier Restrict to this component.
-     * @param cb Optional. Callback to retrieve returned results asynchronously.
-     * @returns {array} An array of linked components, their windows, and their linked channels.
-     * @memberof LinkerClient
-     */
-    getLinkedComponents(params: {
-        channels?: string[];
-        componentTypes?: string[];
-        windowIdentifier?: WindowIdentifier;
-    }, cb?: StandardCallback): any;
-    /**
-     * Handles listeners (looks to see if there is a listener for a specific data type)
-     * @private
-     */
-    handleListeners: (err: any, data: any) => void;
-    /**
-     * Adds new listeners for channels when channels are updated
-     * @private
-     */
-    updateListeners(): void;
-    /**
-     * @deprecated The LinkerClient has been deprecated.
-     *
-     * Use this method to register a callback which will be called whenever the state of the Linker changes. This will be called whenever a user links or unlinks your component to a channel.
-     *
-     * ```javascript
-     * FSBL.Clients.LinkerClient.onStateChange(function(err, response){
-     *    if(response.channels){
-     * 		console.log("Printout of channel status ", response.channels);
-     * 	}
-     * });
-     * ```
-     * @param {function} cb  returns { null, LinkerClient~state }
-     * @memberof LinkerClient
-     */
-    onStateChange(cb: StandardCallback): void;
-    /**
-     * Persists the current linker state. When the window is restored, that state will be available and restored (in initialize).
-     * @private
-     * @param {object} state The state enabled for this Linker instance
-     */
-    persistState(state: any): void;
-    /**
-     * Callback function for linkerStore.addListener({ field: "clients." + key }). Updates channels and persistState.
-     *
-     * @param {object} response contains changed listener data
-     * @private
-     */
-    private clientsKeyValueChangeStoreListener;
-    /**
-     * Callback function for linkerStore.addListener({}).  Updates allChannels, allGroups, and clients.
-     *
-     * @param {object} response contains changed listener data
-     * @private
-     */
-    private anyFieldChangeStoreListener;
-    /**
-     * @private
-     */
-    start(cb?: Function): Promise<void>;
-    initialize(): void;
-    /**
-     * @private
-     */
-    onClose: (cb: any) => void;
-    /**
-     * Minimize all windows except those on specified channel
-     * @param {string} channel
-     * @private
-     */
-    hyperFocus(channel: any): void;
-    /**
-     * Bring all windows in specified channel to the front
-     * @param {params} object
-     * @param {params.channel} channel to btf.
-     * @param {params.restoreWindows} whether to restore windows that are minimized prior to calling bring to front.
-     * @private
-     */
-    bringAllToFront(params: any): void;
-    groups: {};
-    allGroups: any[];
-    /**
-     * Creates a linker channel
-     * @param {linkerGroup} group The linker channel to create
-     * @param {Function} cb The callback
-     * @private
-     */
-    createGroup(group: linkerGroup, cb: any): any;
-    /**
-     * Removes a linker channel from the list of available channels
-     * @param {string} groupName The name of the channel to delete
-     * @param {Function} cb The callback
-     * @private
-     */
-    deleteGroup(groupName: string, cb: any): any;
-    /**
-     * Adds a given window to given channel
-     * @param {string} groupName The channel name
-     * @param {WindowIdentifier} client The window to add to the given channel
-     * @param {Function} cb The callback (optional)
-     * @private
-     */
-    addToGroup(groupName: string, client: WindowIdentifier, cb?: StandardCallback): any;
-    /**
-     * Remove a given window from a linker channel
-     * @param {string} groupName The name of the linker channel to disconnect from
-     * @param {WindowIdentifier} client The window to remove from the given channel
-     * @param {Function} cb The callback (optional)
-     * @returns The response from removing the window from the given channel
-     * @private
-     */
-    removeFromGroup(groupName: string, client: WindowIdentifier, cb?: StandardCallback): any;
-    /**
-     * Gets a list of all linker channels
-     * @param {Function} cb The callback
-     * @returns An array of linker channel names
-     * @private
-     */
-    getAllGroups(cb: Function): any;
-    /**
-     * Asynchronously returns the list of all linked channels of a given window
-     * @param {WindowIdentifier} [client] The window to find linked groups of
-     * @param {Function} cb The callback (optional)
-     * @returns Asynchronously returns list of channels
-     * @private
-     */
-    getGroups(client?: WindowIdentifier, cb?: Function): any;
-    /**
-     * @deprecated The LinkerClient has been deprecated.
-     *
-     * Remove all listeners for the specified dataType.
-     *
-     * ```javascript
-     * FSBL.Clients.LinkerClient.unsubscribe("symbol");
-     * ```
-     * @param {String}  dataType - The data type to which the component is subscribed.
-     * @memberof LinkerClient
-     */
-    unSubscribe(dataType: string, cb: Function): void;
-    /**
-     * @deprecated The LinkerClient has been deprecated.
-     *
-     * Retrieves an array of all components with links that match the given parameters. If no parameters are specified, all windows with established links will be returned.
-     *
-     * Get all components linked to a given component:
-     * ```javascript
-     * FSBL.Clients.LinkerClient.getLinkedWindows({windowIdentifier: wi});
-     * ```
-     *
-     * Get all Windows linked to channel "group1":
-     * ```javascript
-     * FSBL.Clients.LinkerClient.getLinkedComponents({ channels: ['group1'] });
-     * // Response format: [{ windowName: 'Window Name', componentType: 'Component Type', uuid: 'uuid', channels: ['group1'] }]
-     * ```
-     * @param {object} params Optional
-     * @param {Array.<string>} params.channels Restrict to these channels.
-     * @param {Array.<string>} params.componentTypes Restrict to these componentTypes. The componentType is a key in the finsemble.components configuration object.
-     * @param {windowIdentifier} params.windowIdentifier Restrict to this component.
-     * @param {windowIdentifier} params.client Alias for windowIdentifier.
-     * @param {Array.<string>} params.groups Alias for channels.
-     * @param cb - Optional. Callback to retrieve returned results asynchronously.
-     * @returns {array} An array of linked components, their windows, and their linked channels.
-     * @memberof LinkerClient
-     */
-    getLinkedWindows(params?: {
-        channels?: string[];
-        componentTypes?: string[];
-        windowIdentifier?: WindowIdentifier;
-        groups?: string[];
-        client?: any;
-    }, cb?: StandardCallback): any;
-    /**
-     * Asynchronously retrieves a window's windowIdentifier
-     * @param {any} [params] Parameters
-     * @param {Function} cb The callback
-     * @private
-     */
-    windowIdentifier(params?: any, cb?: Function): any;
-    onLinksUpdate: {
-        push: (cb: any) => void;
-    };
-    linkerWindow: any;
-    loading: boolean;
-    /**
-     * @deprecated The LinkerClient has been deprecated.
-     *
-     * Opens the Linker window.
-     * @param {Function} cb The callback to be invoked after the method completes successfully.
-     * @memberof LinkerClient
-     */
-    openLinkerWindow(cb: any): void;
-}
-declare const linkerClient: LinkerClient;
-/**
- * @ignore
- */
-export default linkerClient;
-/**
- * Callback that returns a list of channels in the responseMessage
- * @callback LinkerChannelsCB
- * @param {Object} err Error message, or null if no error
- * @param {Array.<string>} channels List of channels
- */
-/**
- * Callback that returns a new LinkerState
- * @callback LinkerStateCB
- * @param {Object} err Error message, or null if no error
- * @param {Array.<string>} channels List of all channels linked to the requested component
- * @param {Array.<string>} allChannels List of all available channels
- */
-/**
- * A list of enabled channels and a list of all channels
- * @callback LinkerState
- * @param {Array.<string>} channels List of all channels linked to the requested component
- * @param {Array.<string>} allChannels List of all available channels
- */
+/*!
+ * Copyright 2017 - 2020 by ChartIQ, Inc.
+ * All rights reserved.
+ */
+import { StoreModel } from "../clients/distributedStoreClient";
+import { StandardCallback } from "../types";
+import { WindowIdentifier } from "../platform/services/window/types";
+export type linkerGroup = {
+    /**
+     * name of the channel
+     */
+    name: string;
+    /**
+     * color. Required to use Finsemble's built-in Linker component.
+     */
+    color?: string;
+    /**
+     * border color. Required to use Finsemble's built-in Linker component.
+     */
+    border?: string;
+};
+/**
+ * @phantom Don't display in Typedoc
+ */
+export declare class LinkerClient {
+    linkerStore?: StoreModel;
+    dontPersistYet: boolean | undefined;
+    constructor();
+    stateChangeListeners: any[];
+    allChannels: any[];
+    channels: {};
+    clients: {};
+    channelListenerList: any[];
+    dataListenerList: {};
+    /**
+     * 1/24/19 this is Brad guessing. This function has never existed. This is the first commit where 'getChannel' is referenced...but not defined.
+     *
+     * https://github.com/ChartIQ/finsemble/blob/ad25aa219c5fac60c277bccf35dea43568da2a07/src/clients/linkerClient.js
+     *
+     * No idea how it ever worked.
+     * @private
+     *
+     */
+    getChannel(name: string): boolean;
+    /**
+     * @deprecated The LinkerClient has been deprecated.
+     *
+     * Create a new Linker channel. This channel will be available *globally*.
+     *
+     * ```javascript
+     * LinkerClient.createChannel({name: "red", color: "#ff0000", border: "#ffffff"}, callback)
+     * ```
+     * @param {object} params
+     * @param cb - Optional. Callback to retrieve returned results asynchronously.
+     * @return {Array.<string>} Returns an array of all available channels
+     * @private
+     * @memberof LinkerClient
+     */
+    createChannel(params: linkerGroup, cb: Function): any;
+    /**
+     * Remove a Linker channel. It will be removed globally. Any component that is currently assigned to this channel will be unassigned.
+     *
+     * ```javascript
+     * FSBL.Clients.LinkerClient.removeChannel("group1")
+     * ```
+     * @param {string} name - The name of the channel to remove
+     * @param cb - Optional. Callback to retrieve returned results asynchronously
+     * @returns {Array.<string>} Returns an array of available channels
+     * @private
+     * @memberof LinkerClient
+     */
+    removeChannel(name: string, cb: Function): any;
+    /**
+     * Convenience function to update the client information in the store.
+     * @private
+     */
+    updateClientInStore(key: any): void;
+    /**
+     * @deprecated The LinkerClient has been deprecated.
+     *
+     * Add a component to a Linker channel programmatically. Components will begin receiving any new contexts published to this channel but will <b>not</b> receive the currently established context.
+     *
+     * ```javascript
+     * FSBL.Clients.LinkerClient.linkToChannel("group3", null); // Link current window to channel.
+     * FSBL.Clients.LinkerClient.linkToChannel("group3", windowIdentifier); // Link the requested window to channel.
+     * ```
+     * @param {string} channel - The name of the channel to link our component to, or an array of names.
+     * @param windowIdentifier -  Optional. windowIdentifier for the component. If null, it defaults to the current window.
+     * @param cb - Optional. Callback to retrieve returned results asynchronously.
+     * @return {LinkerState} The new state: linked channels, all channels
+     * @memberof LinkerClient
+     */
+    linkToChannel(channel: string | string[], windowIdentifier?: WindowIdentifier, cb?: Function): any;
+    /**
+     * @deprecated The LinkerClient has been deprecated.
+     *
+     * Unlinks a component from a Linker channel.
+     *
+     * ```javascript
+     * FSBL.Clients.LinkerClient.unlinkFromChannel("group1", null); // Unlink the current window from channel "group1"
+     * FSBL.Clients.LinkerClient.unlinkFromChannel("group1", windowIdentifier) // Unlink the requested window from channel "group1"
+     * ```
+     * @param {string} channel - Channel to remove, or an array of channels. If null, then all channels will be removed.
+     * @param windowIdentifier -  windowIdentifier for the window. Defaults to current window if left null.
+     * @param cb - Optional. Callback to retrieve returned results asynchronously.
+     * @return {LinkerState} Returns the new state: linked channels, all channels
+     * @memberof LinkerClient
+     */
+    unlinkFromChannel(channel: string | string[], windowIdentifier?: WindowIdentifier, cb?: Function): any;
+    /**
+     * @deprecated The LinkerClient has been deprecated.
+     *
+     * Returns all available Linker channels.
+     * ```javascript
+     * let groups = FSBL.Clients.LinkerClient.getAllChannels();
+     * ```
+     *
+     * ```javascript
+     * FSBL.Clients.LinkerClient.getAllChannels((err, channels) => { ... });
+     * ```
+     * @param cb Optional. Callback to retrieve returned results asynchronously.
+     * @return {array} An array of all channels. Each array item is {name:channelName} plus any other optional fields such as color.
+     * @memberof LinkerClient
+     */
+    getAllChannels(cb?: Function): any;
+    /**
+     * Retrieve all channels linked to the requested component. Also returns all available channels.
+     *
+     * ```javascript
+     * var state=LinkerClient.getState(windowIdentifier)
+     * ```
+     * @param windowIdentifier Retrieve all channels for identified window. If null, will retrieve for the current window.
+     * @param cb Optional. Callback to retrieve returned results asynchronously
+     * @return {LinkerState} The current state: linked channels, all channels
+     * @private
+     */
+    getState(windowIdentifier?: WindowIdentifier, cb?: StandardCallback): any;
+    /**
+     * @deprecated The LinkerClient has been deprecated.
+     *
+     * Remove all listeners for the specified dataType.
+     *
+     * ```javascript
+     * FSBL.Clients.LinkerClient.unsubscribe("symbol");
+     * ```
+     * @param {String}  dataType - The data type to which the component is subscribed.
+     * @param {function} listener - Optional. The function that was passed to subscribe. If not specified, all listeners will be deleted.
+     * @memberof LinkerClient
+     */
+    unsubscribe(dataType: string, listener?: Function): void;
+    /**
+     * @deprecated The LinkerClient has been deprecated.
+     *
+     * Publish a piece of data. The data will be published to <b>all channels</b> that the component is linked to. Foreign components that are linked to those channels will receive the data if they have subscribed to this dataType. They can then use that data to synchronize their internal state. See <a href="#subscribe">LinkerClient.subscribe()</a>.
+     *
+     * ```javascript
+     * FSBL.Clients.LinkerClient.publish({ dataType:"symbol", data:"AAPL" })
+     * ```
+     * @param {String}  params.dataType - A string representing the data type being sent.
+     * @param {any}  params.data - The data ("context") being transmitted.
+     * @param {array<string>} params.channels - Optional. Specifies which channels publish this piece of data. This overrides the default which is to publish to all linked channels.
+     * @param cb - Optional. Callback to retrieve returned results asynchronously.
+     * @memberof LinkerClient
+     */
+    publish(params: {
+        dataType: string;
+        data: any;
+        channels?: string[];
+    }, cb: StandardCallback): any;
+    /**
+     * @deprecated The LinkerClient has been deprecated.
+     *
+     * Registers a client for a specific data type that is sent to a channel. Calling `subscribe` multiple times adds additional handlers. A component may be subscribed to a maximum of six channels at the same time.
+     * Please note that the signature of the .Net version of this function differs slightly.
+     *
+     * ```javascript
+     * FSBL.Clients.LinkerClient.subscribe("symbol", (data, response) => {
+     * 	if (!response.originatedHere()) {
+     * 		const data = response.data;
+     * 		// Logic to perform with data
+     * 	}
+     * });
+     * ```
+     * @param {String} dataType A string representing the data type to subscribe to.
+     * @param {Function} listener A function `(data, response)` to be called once the Linker receives the specific data. Use <b>response.originatedHere()</b> to determine if the calling window is also the publisher
+     * @memberof LinkerClient
+     */
+    subscribe(dataType: string, listener: Function): void;
+    /**
+     * @deprecated The LinkerClient has been deprecated.
+     *
+     * Retrieves an array of all components with links that match the given parameters. If no parameters are specified, all windows with established links will be returned.
+     *
+     * Get all components linked to a given component:
+     * ```javascript
+     * FSBL.Clients.LinkerClient.getLinkedComponents({ windowIdentifier: wi });
+     * ```
+     *
+     * Get all components linked to channel "group 1":
+     * ```javascript
+     * FSBL.Clients.LinkerClient.getLinkedComponents({ channels: ['group1'] });
+     * // Response format: [{windowName: 'Window Name', componentType: 'Component Type', uuid: 'uuid', channels: ['group1'] }]
+     * ```
+     * @param {object} params Optional
+     * @param {Array.<string>} params.channels Restrict to these channels.
+     * @param {Array.<string>} params.componentTypes Restrict to these componentTypes. The componentType is a key in the finsemble.components configuration object.
+     * @param {windowIdentifier} params.windowIdentifier Restrict to this component.
+     * @param cb Optional. Callback to retrieve returned results asynchronously.
+     * @returns {array} An array of linked components, their windows, and their linked channels.
+     * @memberof LinkerClient
+     */
+    getLinkedComponents(params: {
+        channels?: string[];
+        componentTypes?: string[];
+        windowIdentifier?: WindowIdentifier;
+    }, cb?: StandardCallback): any;
+    /**
+     * Handles listeners (looks to see if there is a listener for a specific data type)
+     * @private
+     */
+    handleListeners: (err: any, data: any) => void;
+    /**
+     * Adds new listeners for channels when channels are updated
+     * @private
+     */
+    updateListeners(): void;
+    /**
+     * @deprecated The LinkerClient has been deprecated.
+     *
+     * Use this method to register a callback which will be called whenever the state of the Linker changes. This will be called whenever a user links or unlinks your component to a channel.
+     *
+     * ```javascript
+     * FSBL.Clients.LinkerClient.onStateChange(function(err, response){
+     *    if(response.channels){
+     * 		console.log("Printout of channel status ", response.channels);
+     * 	}
+     * });
+     * ```
+     * @param {function} cb  returns { null, LinkerClient~state }
+     * @memberof LinkerClient
+     */
+    onStateChange(cb: StandardCallback): void;
+    /**
+     * Persists the current linker state. When the window is restored, that state will be available and restored (in initialize).
+     * @private
+     * @param {object} state The state enabled for this Linker instance
+     */
+    persistState(state: any): void;
+    /**
+     * Callback function for linkerStore.addListener({ field: "clients." + key }). Updates channels and persistState.
+     *
+     * @param {object} response contains changed listener data
+     * @private
+     */
+    private clientsKeyValueChangeStoreListener;
+    /**
+     * Callback function for linkerStore.addListener({}).  Updates allChannels, allGroups, and clients.
+     *
+     * @param {object} response contains changed listener data
+     * @private
+     */
+    private anyFieldChangeStoreListener;
+    /**
+     * @private
+     */
+    start(cb?: Function): Promise<void>;
+    initialize(): void;
+    /**
+     * @private
+     */
+    onClose: (cb: any) => void;
+    /**
+     * Minimize all windows except those on specified channel
+     * @param {string} channel
+     * @private
+     */
+    hyperFocus(channel: any): void;
+    /**
+     * Bring all windows in specified channel to the front
+     * @param {params} object
+     * @param {params.channel} channel to btf.
+     * @param {params.restoreWindows} whether to restore windows that are minimized prior to calling bring to front.
+     * @private
+     */
+    bringAllToFront(params: any): void;
+    groups: {};
+    allGroups: any[];
+    /**
+     * Creates a linker channel
+     * @param {linkerGroup} group The linker channel to create
+     * @param {Function} cb The callback
+     * @private
+     */
+    createGroup(group: linkerGroup, cb: any): any;
+    /**
+     * Removes a linker channel from the list of available channels
+     * @param {string} groupName The name of the channel to delete
+     * @param {Function} cb The callback
+     * @private
+     */
+    deleteGroup(groupName: string, cb: any): any;
+    /**
+     * Adds a given window to given channel
+     * @param {string} groupName The channel name
+     * @param {WindowIdentifier} client The window to add to the given channel
+     * @param {Function} cb The callback (optional)
+     * @private
+     */
+    addToGroup(groupName: string, client: WindowIdentifier, cb?: StandardCallback): any;
+    /**
+     * Remove a given window from a linker channel
+     * @param {string} groupName The name of the linker channel to disconnect from
+     * @param {WindowIdentifier} client The window to remove from the given channel
+     * @param {Function} cb The callback (optional)
+     * @returns The response from removing the window from the given channel
+     * @private
+     */
+    removeFromGroup(groupName: string, client: WindowIdentifier, cb?: StandardCallback): any;
+    /**
+     * Gets a list of all linker channels
+     * @param {Function} cb The callback
+     * @returns An array of linker channel names
+     * @private
+     */
+    getAllGroups(cb: Function): any;
+    /**
+     * Asynchronously returns the list of all linked channels of a given window
+     * @param {WindowIdentifier} [client] The window to find linked groups of
+     * @param {Function} cb The callback (optional)
+     * @returns Asynchronously returns list of channels
+     * @private
+     */
+    getGroups(client?: WindowIdentifier, cb?: Function): any;
+    /**
+     * @deprecated The LinkerClient has been deprecated.
+     *
+     * Remove all listeners for the specified dataType.
+     *
+     * ```javascript
+     * FSBL.Clients.LinkerClient.unsubscribe("symbol");
+     * ```
+     * @param {String}  dataType - The data type to which the component is subscribed.
+     * @memberof LinkerClient
+     */
+    unSubscribe(dataType: string, cb: Function): void;
+    /**
+     * @deprecated The LinkerClient has been deprecated.
+     *
+     * Retrieves an array of all components with links that match the given parameters. If no parameters are specified, all windows with established links will be returned.
+     *
+     * Get all components linked to a given component:
+     * ```javascript
+     * FSBL.Clients.LinkerClient.getLinkedWindows({windowIdentifier: wi});
+     * ```
+     *
+     * Get all Windows linked to channel "group1":
+     * ```javascript
+     * FSBL.Clients.LinkerClient.getLinkedComponents({ channels: ['group1'] });
+     * // Response format: [{ windowName: 'Window Name', componentType: 'Component Type', uuid: 'uuid', channels: ['group1'] }]
+     * ```
+     * @param {object} params Optional
+     * @param {Array.<string>} params.channels Restrict to these channels.
+     * @param {Array.<string>} params.componentTypes Restrict to these componentTypes. The componentType is a key in the finsemble.components configuration object.
+     * @param {windowIdentifier} params.windowIdentifier Restrict to this component.
+     * @param {windowIdentifier} params.client Alias for windowIdentifier.
+     * @param {Array.<string>} params.groups Alias for channels.
+     * @param cb - Optional. Callback to retrieve returned results asynchronously.
+     * @returns {array} An array of linked components, their windows, and their linked channels.
+     * @memberof LinkerClient
+     */
+    getLinkedWindows(params?: {
+        channels?: string[];
+        componentTypes?: string[];
+        windowIdentifier?: WindowIdentifier;
+        groups?: string[];
+        client?: any;
+    }, cb?: StandardCallback): any;
+    /**
+     * Asynchronously retrieves a window's windowIdentifier
+     * @param {any} [params] Parameters
+     * @param {Function} cb The callback
+     * @private
+     */
+    windowIdentifier(params?: any, cb?: Function): any;
+    onLinksUpdate: {
+        push: (cb: any) => void;
+    };
+    linkerWindow: any;
+    loading: boolean;
+    /**
+     * @deprecated The LinkerClient has been deprecated.
+     *
+     * Opens the Linker window.
+     * @param {Function} cb The callback to be invoked after the method completes successfully.
+     * @memberof LinkerClient
+     */
+    openLinkerWindow(cb: any): void;
+}
+declare const linkerClient: LinkerClient;
+/**
+ * @ignore
+ */
+export default linkerClient;
+/**
+ * Callback that returns a list of channels in the responseMessage
+ * @callback LinkerChannelsCB
+ * @param {Object} err Error message, or null if no error
+ * @param {Array.<string>} channels List of channels
+ */
+/**
+ * Callback that returns a new LinkerState
+ * @callback LinkerStateCB
+ * @param {Object} err Error message, or null if no error
+ * @param {Array.<string>} channels List of all channels linked to the requested component
+ * @param {Array.<string>} allChannels List of all available channels
+ */
+/**
+ * A list of enabled channels and a list of all channels
+ * @callback LinkerState
+ * @param {Array.<string>} channels List of all channels linked to the requested component
+ * @param {Array.<string>} allChannels List of all available channels
+ */
 //# sourceMappingURL=linkerClient.d.ts.map