@openfin/core 41.100.17 → 41.100.19

Sign up to get free protection for your applications and to get access to all the features.
@@ -593,6 +593,23 @@ declare class Application extends EmitterBase<OpenFin_2.ApplicationEvent> {
593
593
  * ```
594
594
  */
595
595
  setTrayIcon(icon: string): Promise<void>;
596
+ /**
597
+ * Set hover text for this application's system tray icon.
598
+ * Note: Application must first set a tray icon with {@link Application.setTrayIcon}.
599
+ * @param toolTip
600
+ *
601
+ * @example
602
+ *
603
+ * ```js
604
+ * const app = fin.Application.getCurrentSync();
605
+ * const iconUrl = "http://cdn.openfin.co/assets/testing/icons/circled-digit-one.png";
606
+ *
607
+ * await app.setTrayIcon(iconUrl);
608
+ *
609
+ * await app.setTrayIconToolTip('My Application');
610
+ * ```
611
+ */
612
+ setTrayIconToolTip(toolTip: string): Promise<void>;
596
613
  /**
597
614
  * Sets new application's shortcut configuration. Windows only.
598
615
  * @param config New application's shortcut configuration.
@@ -11811,6 +11828,9 @@ declare interface ProtocolMap extends ProtocolMapBase {
11811
11828
  'set-tray-icon': ApplicationIdentityCall<{
11812
11829
  enabledIcon: string;
11813
11830
  }, void>;
11831
+ 'set-tray-icon-tooltip': ApplicationIdentityCall<{
11832
+ toolTip: string;
11833
+ }>;
11814
11834
  'set-shortcuts': ApplicationIdentityCall<{
11815
11835
  data: OpenFin_2.ShortCutConfig;
11816
11836
  }, void>;
@@ -593,6 +593,23 @@ declare class Application extends EmitterBase<OpenFin_2.ApplicationEvent> {
593
593
  * ```
594
594
  */
595
595
  setTrayIcon(icon: string): Promise<void>;
596
+ /**
597
+ * Set hover text for this application's system tray icon.
598
+ * Note: Application must first set a tray icon with {@link Application.setTrayIcon}.
599
+ * @param toolTip
600
+ *
601
+ * @example
602
+ *
603
+ * ```js
604
+ * const app = fin.Application.getCurrentSync();
605
+ * const iconUrl = "http://cdn.openfin.co/assets/testing/icons/circled-digit-one.png";
606
+ *
607
+ * await app.setTrayIcon(iconUrl);
608
+ *
609
+ * await app.setTrayIconToolTip('My Application');
610
+ * ```
611
+ */
612
+ setTrayIconToolTip(toolTip: string): Promise<void>;
596
613
  /**
597
614
  * Sets new application's shortcut configuration. Windows only.
598
615
  * @param config New application's shortcut configuration.
@@ -11811,6 +11828,9 @@ declare interface ProtocolMap extends ProtocolMapBase {
11811
11828
  'set-tray-icon': ApplicationIdentityCall<{
11812
11829
  enabledIcon: string;
11813
11830
  }, void>;
11831
+ 'set-tray-icon-tooltip': ApplicationIdentityCall<{
11832
+ toolTip: string;
11833
+ }>;
11814
11834
  'set-shortcuts': ApplicationIdentityCall<{
11815
11835
  data: OpenFin_2.ShortCutConfig;
11816
11836
  }, void>;
@@ -593,6 +593,23 @@ declare class Application extends EmitterBase<OpenFin_2.ApplicationEvent> {
593
593
  * ```
594
594
  */
595
595
  setTrayIcon(icon: string): Promise<void>;
596
+ /**
597
+ * Set hover text for this application's system tray icon.
598
+ * Note: Application must first set a tray icon with {@link Application.setTrayIcon}.
599
+ * @param toolTip
600
+ *
601
+ * @example
602
+ *
603
+ * ```js
604
+ * const app = fin.Application.getCurrentSync();
605
+ * const iconUrl = "http://cdn.openfin.co/assets/testing/icons/circled-digit-one.png";
606
+ *
607
+ * await app.setTrayIcon(iconUrl);
608
+ *
609
+ * await app.setTrayIconToolTip('My Application');
610
+ * ```
611
+ */
612
+ setTrayIconToolTip(toolTip: string): Promise<void>;
596
613
  /**
597
614
  * Sets new application's shortcut configuration. Windows only.
598
615
  * @param config New application's shortcut configuration.
@@ -11811,6 +11828,9 @@ declare interface ProtocolMap extends ProtocolMapBase {
11811
11828
  'set-tray-icon': ApplicationIdentityCall<{
11812
11829
  enabledIcon: string;
11813
11830
  }, void>;
11831
+ 'set-tray-icon-tooltip': ApplicationIdentityCall<{
11832
+ toolTip: string;
11833
+ }>;
11814
11834
  'set-shortcuts': ApplicationIdentityCall<{
11815
11835
  data: OpenFin_2.ShortCutConfig;
11816
11836
  }, void>;
package/out/mock.d.ts CHANGED
@@ -599,6 +599,23 @@ declare class Application extends EmitterBase<OpenFin_2.ApplicationEvent> {
599
599
  * ```
600
600
  */
601
601
  setTrayIcon(icon: string): Promise<void>;
602
+ /**
603
+ * Set hover text for this application's system tray icon.
604
+ * Note: Application must first set a tray icon with {@link Application.setTrayIcon}.
605
+ * @param toolTip
606
+ *
607
+ * @example
608
+ *
609
+ * ```js
610
+ * const app = fin.Application.getCurrentSync();
611
+ * const iconUrl = "http://cdn.openfin.co/assets/testing/icons/circled-digit-one.png";
612
+ *
613
+ * await app.setTrayIcon(iconUrl);
614
+ *
615
+ * await app.setTrayIconToolTip('My Application');
616
+ * ```
617
+ */
618
+ setTrayIconToolTip(toolTip: string): Promise<void>;
602
619
  /**
603
620
  * Sets new application's shortcut configuration. Windows only.
604
621
  * @param config New application's shortcut configuration.
@@ -12212,6 +12229,9 @@ declare interface ProtocolMap extends ProtocolMapBase {
12212
12229
  'set-tray-icon': ApplicationIdentityCall<{
12213
12230
  enabledIcon: string;
12214
12231
  }, void>;
12232
+ 'set-tray-icon-tooltip': ApplicationIdentityCall<{
12233
+ toolTip: string;
12234
+ }>;
12215
12235
  'set-shortcuts': ApplicationIdentityCall<{
12216
12236
  data: OpenFin_2.ShortCutConfig;
12217
12237
  }, void>;
package/out/mock.js CHANGED
@@ -3230,6 +3230,25 @@ function requireInstance$1 () {
3230
3230
  })
3231
3231
  .then(() => undefined);
3232
3232
  }
3233
+ /**
3234
+ * Set hover text for this application's system tray icon.
3235
+ * Note: Application must first set a tray icon with {@link Application.setTrayIcon}.
3236
+ * @param toolTip
3237
+ *
3238
+ * @example
3239
+ *
3240
+ * ```js
3241
+ * const app = fin.Application.getCurrentSync();
3242
+ * const iconUrl = "http://cdn.openfin.co/assets/testing/icons/circled-digit-one.png";
3243
+ *
3244
+ * await app.setTrayIcon(iconUrl);
3245
+ *
3246
+ * await app.setTrayIconToolTip('My Application');
3247
+ * ```
3248
+ */
3249
+ async setTrayIconToolTip(toolTip) {
3250
+ await this.wire.sendAction('set-tray-icon-tooltip', { ...this.identity, toolTip });
3251
+ }
3233
3252
  /**
3234
3253
  * Sets new application's shortcut configuration. Windows only.
3235
3254
  * @param config New application's shortcut configuration.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@openfin/core",
3
- "version": "41.100.17",
3
+ "version": "41.100.19",
4
4
  "description": "The core renderer entry point of OpenFin",
5
5
  "license": "SEE LICENSE IN LICENSE.md",
6
6
  "main": "out/mock.js",