@openfin/fdc3-api 40.100.3 → 40.100.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -590,6 +590,23 @@ declare class Application extends EmitterBase<OpenFin.ApplicationEvent> {
590
590
  * ```
591
591
  */
592
592
  setTrayIcon(icon: string): Promise<void>;
593
+ /**
594
+ * Set hover text for this application's system tray icon.
595
+ * Note: Application must first set a tray icon with {@link Application.setTrayIcon}.
596
+ * @param toolTip
597
+ *
598
+ * @example
599
+ *
600
+ * ```js
601
+ * const app = fin.Application.getCurrentSync();
602
+ * const iconUrl = "http://cdn.openfin.co/assets/testing/icons/circled-digit-one.png";
603
+ *
604
+ * await app.setTrayIcon(iconUrl);
605
+ *
606
+ * await app.setTrayIconToolTip('My Application');
607
+ * ```
608
+ */
609
+ setTrayIconToolTip(toolTip: string): Promise<void>;
593
610
  /**
594
611
  * Sets new application's shortcut configuration. Windows only.
595
612
  * @param config New application's shortcut configuration.
@@ -12140,6 +12157,9 @@ declare interface ProtocolMap extends ProtocolMapBase {
12140
12157
  'set-tray-icon': ApplicationIdentityCall<{
12141
12158
  enabledIcon: string;
12142
12159
  }, void>;
12160
+ 'set-tray-icon-tooltip': ApplicationIdentityCall<{
12161
+ toolTip: string;
12162
+ }>;
12143
12163
  'set-shortcuts': ApplicationIdentityCall<{
12144
12164
  data: OpenFin.ShortCutConfig;
12145
12165
  }, void>;
@@ -590,6 +590,23 @@ declare class Application extends EmitterBase<OpenFin.ApplicationEvent> {
590
590
  * ```
591
591
  */
592
592
  setTrayIcon(icon: string): Promise<void>;
593
+ /**
594
+ * Set hover text for this application's system tray icon.
595
+ * Note: Application must first set a tray icon with {@link Application.setTrayIcon}.
596
+ * @param toolTip
597
+ *
598
+ * @example
599
+ *
600
+ * ```js
601
+ * const app = fin.Application.getCurrentSync();
602
+ * const iconUrl = "http://cdn.openfin.co/assets/testing/icons/circled-digit-one.png";
603
+ *
604
+ * await app.setTrayIcon(iconUrl);
605
+ *
606
+ * await app.setTrayIconToolTip('My Application');
607
+ * ```
608
+ */
609
+ setTrayIconToolTip(toolTip: string): Promise<void>;
593
610
  /**
594
611
  * Sets new application's shortcut configuration. Windows only.
595
612
  * @param config New application's shortcut configuration.
@@ -12140,6 +12157,9 @@ declare interface ProtocolMap extends ProtocolMapBase {
12140
12157
  'set-tray-icon': ApplicationIdentityCall<{
12141
12158
  enabledIcon: string;
12142
12159
  }, void>;
12160
+ 'set-tray-icon-tooltip': ApplicationIdentityCall<{
12161
+ toolTip: string;
12162
+ }>;
12143
12163
  'set-shortcuts': ApplicationIdentityCall<{
12144
12164
  data: OpenFin.ShortCutConfig;
12145
12165
  }, void>;
@@ -590,6 +590,23 @@ declare class Application extends EmitterBase<OpenFin.ApplicationEvent> {
590
590
  * ```
591
591
  */
592
592
  setTrayIcon(icon: string): Promise<void>;
593
+ /**
594
+ * Set hover text for this application's system tray icon.
595
+ * Note: Application must first set a tray icon with {@link Application.setTrayIcon}.
596
+ * @param toolTip
597
+ *
598
+ * @example
599
+ *
600
+ * ```js
601
+ * const app = fin.Application.getCurrentSync();
602
+ * const iconUrl = "http://cdn.openfin.co/assets/testing/icons/circled-digit-one.png";
603
+ *
604
+ * await app.setTrayIcon(iconUrl);
605
+ *
606
+ * await app.setTrayIconToolTip('My Application');
607
+ * ```
608
+ */
609
+ setTrayIconToolTip(toolTip: string): Promise<void>;
593
610
  /**
594
611
  * Sets new application's shortcut configuration. Windows only.
595
612
  * @param config New application's shortcut configuration.
@@ -12140,6 +12157,9 @@ declare interface ProtocolMap extends ProtocolMapBase {
12140
12157
  'set-tray-icon': ApplicationIdentityCall<{
12141
12158
  enabledIcon: string;
12142
12159
  }, void>;
12160
+ 'set-tray-icon-tooltip': ApplicationIdentityCall<{
12161
+ toolTip: string;
12162
+ }>;
12143
12163
  'set-shortcuts': ApplicationIdentityCall<{
12144
12164
  data: OpenFin.ShortCutConfig;
12145
12165
  }, void>;
package/out/fdc3-api.d.ts CHANGED
@@ -596,6 +596,23 @@ declare class Application extends EmitterBase<OpenFin.ApplicationEvent> {
596
596
  * ```
597
597
  */
598
598
  setTrayIcon(icon: string): Promise<void>;
599
+ /**
600
+ * Set hover text for this application's system tray icon.
601
+ * Note: Application must first set a tray icon with {@link Application.setTrayIcon}.
602
+ * @param toolTip
603
+ *
604
+ * @example
605
+ *
606
+ * ```js
607
+ * const app = fin.Application.getCurrentSync();
608
+ * const iconUrl = "http://cdn.openfin.co/assets/testing/icons/circled-digit-one.png";
609
+ *
610
+ * await app.setTrayIcon(iconUrl);
611
+ *
612
+ * await app.setTrayIconToolTip('My Application');
613
+ * ```
614
+ */
615
+ setTrayIconToolTip(toolTip: string): Promise<void>;
599
616
  /**
600
617
  * Sets new application's shortcut configuration. Windows only.
601
618
  * @param config New application's shortcut configuration.
@@ -12541,6 +12558,9 @@ declare interface ProtocolMap extends ProtocolMapBase {
12541
12558
  'set-tray-icon': ApplicationIdentityCall<{
12542
12559
  enabledIcon: string;
12543
12560
  }, void>;
12561
+ 'set-tray-icon-tooltip': ApplicationIdentityCall<{
12562
+ toolTip: string;
12563
+ }>;
12544
12564
  'set-shortcuts': ApplicationIdentityCall<{
12545
12565
  data: OpenFin.ShortCutConfig;
12546
12566
  }, void>;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@openfin/fdc3-api",
3
- "version": "40.100.3",
3
+ "version": "40.100.5",
4
4
  "description": "OpenFin fdc3 module utilities and types.",
5
5
  "license": "SEE LICENSE IN LICENSE.md",
6
6
  "private": false,