@openfin/fdc3-api 43.101.4 → 44.100.2
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.
- package/out/fdc3-api-alpha.d.ts +21 -708
- package/out/fdc3-api-beta.d.ts +21 -708
- package/out/fdc3-api-public.d.ts +21 -708
- package/out/fdc3-api.d.ts +22 -709
- package/out/fdc3-api.js +53 -8
- package/package.json +1 -1
package/out/fdc3-api-alpha.d.ts
CHANGED
|
@@ -91,34 +91,6 @@ declare type AnalyticsProtocolMap = {
|
|
|
91
91
|
[k in AnalyticsOnlyCalls]: VoidCall;
|
|
92
92
|
};
|
|
93
93
|
|
|
94
|
-
/**
|
|
95
|
-
* Represents an anchor configuration consisting of a bounding rectangle
|
|
96
|
-
* and an anchor point describing which part of that rectangle should be
|
|
97
|
-
* used as the reference for positioning the download bubble.
|
|
98
|
-
* @interface
|
|
99
|
-
*/
|
|
100
|
-
declare type Anchor = {
|
|
101
|
-
/**
|
|
102
|
-
* The DOM or screen-space rectangle that defines the anchor area.
|
|
103
|
-
*/
|
|
104
|
-
bounds: Rectangle;
|
|
105
|
-
/**
|
|
106
|
-
* The location within the rectangle that should act as the anchor
|
|
107
|
-
* (e.g., `topRight`, `bottomLeft`, `center`, etc.).
|
|
108
|
-
* For example, `topRight` means the rectangle's top-right corner is used
|
|
109
|
-
* as the anchoring reference point.
|
|
110
|
-
*/
|
|
111
|
-
location: AnchorLocation;
|
|
112
|
-
};
|
|
113
|
-
|
|
114
|
-
/**
|
|
115
|
-
* Defines the point within the rectangle that should be used as the anchor
|
|
116
|
-
* when positioning UI elements relative to another surface.
|
|
117
|
-
*
|
|
118
|
-
* @interface
|
|
119
|
-
*/
|
|
120
|
-
declare type AnchorLocation = 'topLeft' | 'topRight' | 'bottomLeft' | 'bottomRight' | 'leftTop' | 'rightTop' | 'leftBottom' | 'rightBottom' | 'topCenter' | 'bottomCenter' | 'leftCenter' | 'rightCenter' | 'none' | 'float';
|
|
121
|
-
|
|
122
94
|
declare type AnchorType = 'top-left' | 'top-right' | 'bottom-left' | 'bottom-right';
|
|
123
95
|
|
|
124
96
|
declare type AnyStrategy = ChannelStrategy<any>;
|
|
@@ -1417,53 +1389,6 @@ declare type ApplicationWindowInfo = {
|
|
|
1417
1389
|
uuid: string;
|
|
1418
1390
|
};
|
|
1419
1391
|
|
|
1420
|
-
/**
|
|
1421
|
-
* The `appLogLevel` option allows the verbosity of app logs that are collected for a Window or View to be controlled for its application.
|
|
1422
|
-
*
|
|
1423
|
-
* This setting can also be specified in a Domain Setting Rule, allowing per url overrides to be defined. Please note, when a domain setting is actively
|
|
1424
|
-
* controlling a url's appLogLevel, its view/window options will be ignored.
|
|
1425
|
-
*
|
|
1426
|
-
* @default 'debug'
|
|
1427
|
-
*
|
|
1428
|
-
* Please note, if the manifest setting `platform.enableAppLogging` or `startup_app.enableAppLogging` is set to `false`, this feature will be disabled.
|
|
1429
|
-
*
|
|
1430
|
-
* @example Controlling App Logs With DefaultViewOptions + Domain Settings
|
|
1431
|
-
*
|
|
1432
|
-
* In this example manifest, we use `defaultViewOptions to set the default verbosity to 'warn'.
|
|
1433
|
-
*
|
|
1434
|
-
* We also use domain settings to suppress logs for an example URL, and to lower verbosity to 'debug' for another.
|
|
1435
|
-
*
|
|
1436
|
-
* ```ts
|
|
1437
|
-
* {
|
|
1438
|
-
* <rest of settings>
|
|
1439
|
-
* "platform": {
|
|
1440
|
-
* <rest of settings>
|
|
1441
|
-
* "defaultViewOptions": {
|
|
1442
|
-
* "appLogLevel": "warn"
|
|
1443
|
-
* },
|
|
1444
|
-
* "domainSettings": {
|
|
1445
|
-
* "default": { <rest of settings> }
|
|
1446
|
-
* "rules": [
|
|
1447
|
-
* <rest of rules>
|
|
1448
|
-
* {
|
|
1449
|
-
* "match": ["*://*?app-logging-level=silent"],
|
|
1450
|
-
* "options": {
|
|
1451
|
-
* "appLogLevel": "silent"
|
|
1452
|
-
* }
|
|
1453
|
-
* },
|
|
1454
|
-
* {
|
|
1455
|
-
* "match": ["*://*?app-logging-level=debug"],
|
|
1456
|
-
* "options": {
|
|
1457
|
-
* "appLogLevel": "debug"
|
|
1458
|
-
* }
|
|
1459
|
-
* },
|
|
1460
|
-
* ]
|
|
1461
|
-
* }
|
|
1462
|
-
* }
|
|
1463
|
-
* }
|
|
1464
|
-
*/
|
|
1465
|
-
declare type AppLogLevel = 'silent' | 'debug' | 'info' | 'warn' | 'error';
|
|
1466
|
-
|
|
1467
1392
|
/**
|
|
1468
1393
|
* @interface
|
|
1469
1394
|
*/
|
|
@@ -3672,12 +3597,6 @@ declare type ConstViewOptions = {
|
|
|
3672
3597
|
* Control which options to ignore when creating a Platform View.
|
|
3673
3598
|
*/
|
|
3674
3599
|
excludeOptions: ExcludeOptions;
|
|
3675
|
-
/**
|
|
3676
|
-
* Determines whether window.open calls from web contents should use the specified target name as provided, or automatically generate a unique name.
|
|
3677
|
-
* When true, each call generates a new unique target name, ensuring a new window is always created.
|
|
3678
|
-
* When false, the target name passed to window.open is respected.
|
|
3679
|
-
*/
|
|
3680
|
-
ignoreChildFrameName?: boolean;
|
|
3681
3600
|
};
|
|
3682
3601
|
|
|
3683
3602
|
/**
|
|
@@ -3945,16 +3864,6 @@ declare type ConstWindowOptions = {
|
|
|
3945
3864
|
* Controls whether frameless window should have rounded corners. Default is false for Windows and true for MacOS. Setting this property to false will prevent the window from being fullscreenable on macOS. On Windows versions older than Windows 11 Build 22000 this property has no effect, and frameless windows will not have rounded corners.
|
|
3946
3865
|
*/
|
|
3947
3866
|
roundedCorners: boolean;
|
|
3948
|
-
/**
|
|
3949
|
-
* Determines whether window.open calls from web contents should use the specified target name as provided, or automatically generate a unique name.
|
|
3950
|
-
* When true, each call generates a new unique target name, ensuring a new window is always created.
|
|
3951
|
-
* When false, the target name passed to window.open is respected.
|
|
3952
|
-
*/
|
|
3953
|
-
ignoreChildFrameName?: boolean;
|
|
3954
|
-
/**
|
|
3955
|
-
* Configuration for download bubble UI.
|
|
3956
|
-
*/
|
|
3957
|
-
downloadBubble?: DownloadBubbleOptions;
|
|
3958
3867
|
};
|
|
3959
3868
|
|
|
3960
3869
|
/**
|
|
@@ -4285,7 +4194,7 @@ declare type CpuInfo = {
|
|
|
4285
4194
|
declare type CrashedEvent = BaseEvents.IdentityEvent & {
|
|
4286
4195
|
topic: 'application';
|
|
4287
4196
|
type: 'crashed';
|
|
4288
|
-
reason: 'normal-termination' | 'abnormal-termination' | 'killed' | 'crashed' | 'still-running' | 'launch-failed' | 'out-of-memory' | 'integrity-failure'
|
|
4197
|
+
reason: 'normal-termination' | 'abnormal-termination' | 'killed' | 'crashed' | 'still-running' | 'launch-failed' | 'out-of-memory' | 'integrity-failure';
|
|
4289
4198
|
exitCode: number;
|
|
4290
4199
|
details: {
|
|
4291
4200
|
reason: string;
|
|
@@ -4299,7 +4208,7 @@ declare type CrashedEvent = BaseEvents.IdentityEvent & {
|
|
|
4299
4208
|
*/
|
|
4300
4209
|
declare type CrashedEvent_2 = NamedEvent & {
|
|
4301
4210
|
type: 'crashed';
|
|
4302
|
-
reason: 'normal-termination' | 'abnormal-termination' | 'killed' | 'crashed' | 'still-running' | 'launch-failed' | 'out-of-memory' | 'integrity-failure'
|
|
4211
|
+
reason: 'normal-termination' | 'abnormal-termination' | 'killed' | 'crashed' | 'still-running' | 'launch-failed' | 'out-of-memory' | 'integrity-failure';
|
|
4303
4212
|
exitCode: number;
|
|
4304
4213
|
details: {
|
|
4305
4214
|
reason: string;
|
|
@@ -4707,50 +4616,6 @@ declare type DomainSettingsRule = {
|
|
|
4707
4616
|
matchOptions?: RuleMatchOptions;
|
|
4708
4617
|
};
|
|
4709
4618
|
|
|
4710
|
-
/**
|
|
4711
|
-
* Configuration options for enabling and positioning the download bubble UI.
|
|
4712
|
-
* @interface
|
|
4713
|
-
*/
|
|
4714
|
-
declare type DownloadBubbleOptions = {
|
|
4715
|
-
/**
|
|
4716
|
-
* Whether the download bubble feature is enabled.
|
|
4717
|
-
*/
|
|
4718
|
-
enabled: boolean;
|
|
4719
|
-
/**
|
|
4720
|
-
* Anchor configuration describing where the download bubble should attach.
|
|
4721
|
-
*/
|
|
4722
|
-
anchor: Anchor;
|
|
4723
|
-
};
|
|
4724
|
-
|
|
4725
|
-
/**
|
|
4726
|
-
* Generated when the download button icon needs to be updated. Only raised if the download bubble feature is enabled.
|
|
4727
|
-
*
|
|
4728
|
-
* @interface
|
|
4729
|
-
*/
|
|
4730
|
-
declare type DownloadButtonIconUpdatedEvent = BaseEvent_5 & {
|
|
4731
|
-
type: 'download-button-icon-updated';
|
|
4732
|
-
disabled: boolean;
|
|
4733
|
-
active: boolean;
|
|
4734
|
-
touchMode: boolean;
|
|
4735
|
-
progressIndicatorState: 'idle' | 'scanning' | 'downloading' | 'dormant';
|
|
4736
|
-
progressDownloadCount: number;
|
|
4737
|
-
progressPercentage: number;
|
|
4738
|
-
buttonTooltip: string;
|
|
4739
|
-
};
|
|
4740
|
-
|
|
4741
|
-
/**
|
|
4742
|
-
* Generated when the visibility of the window's download button changes. Only raised if the download bubble feature is enabled.
|
|
4743
|
-
*
|
|
4744
|
-
* @interface
|
|
4745
|
-
*/
|
|
4746
|
-
declare type DownloadButtonVisibilityChangedEvent = BaseEvent_5 & {
|
|
4747
|
-
type: 'download-button-visibility-changed';
|
|
4748
|
-
/**
|
|
4749
|
-
* True if the download button should be displayed, false if it should be hidden.
|
|
4750
|
-
*/
|
|
4751
|
-
visible: boolean;
|
|
4752
|
-
};
|
|
4753
|
-
|
|
4754
4619
|
/**
|
|
4755
4620
|
* Metadata returned from a preload script download request.
|
|
4756
4621
|
*
|
|
@@ -4810,7 +4675,6 @@ declare type DownloadRule = {
|
|
|
4810
4675
|
*
|
|
4811
4676
|
* @remarks This will control the styling for the download shelf regardless of whether its display was
|
|
4812
4677
|
* triggered by the window itself, or a view targeting the window.
|
|
4813
|
-
* @deprecated Use the DownloadBubble API instead.
|
|
4814
4678
|
*/
|
|
4815
4679
|
declare type DownloadShelfOptions = {
|
|
4816
4680
|
/**
|
|
@@ -4846,7 +4710,6 @@ declare type DownloadShelfOptions = {
|
|
|
4846
4710
|
* Generated when the visibility of the window's download shelf changes.
|
|
4847
4711
|
*
|
|
4848
4712
|
* @interface
|
|
4849
|
-
* @deprecated use DownloadBubble API instead
|
|
4850
4713
|
*/
|
|
4851
4714
|
declare type DownloadShelfVisibilityChangedEvent = BaseEvent_5 & {
|
|
4852
4715
|
type: 'download-shelf-visibility-changed';
|
|
@@ -4913,11 +4776,20 @@ declare class EmitterBase<EmitterEvent extends BaseEvent, EmitterEventType exten
|
|
|
4913
4776
|
eventNames: () => (string | symbol)[];
|
|
4914
4777
|
/* Excluded from this release type: emit */
|
|
4915
4778
|
private hasEmitter;
|
|
4779
|
+
/**
|
|
4780
|
+
* Cleans up after removal of a listener, e.g. deleting any lingering deregistration handlers for a
|
|
4781
|
+
* `once` subscription.
|
|
4782
|
+
*
|
|
4783
|
+
* @remarks Implementing this as a `removeListener` handler ensures that direct removal of a listener
|
|
4784
|
+
* on the base emitter will not leak additional core handlers. We could do this in the forwarding method,
|
|
4785
|
+
* which would involve less "magic," but would be more-vulnerable to accidental re-introduction of a leak.
|
|
4786
|
+
*/
|
|
4787
|
+
private cleanUpRemovedListener;
|
|
4916
4788
|
private getOrCreateEmitter;
|
|
4917
4789
|
listeners: (type: string | symbol) => Function[];
|
|
4918
4790
|
listenerCount: (type: string | symbol) => number;
|
|
4919
4791
|
protected registerEventListener: (eventType: EmitterEventType, options: OpenFin.SubscriptionOptions | undefined, applySubscription: (emitter: EventEmitter) => void, undoSubscription: (emitter: EventEmitter) => void) => Promise<void>;
|
|
4920
|
-
|
|
4792
|
+
protected deregisterEventListener: (eventType: EmitterEventType, options?: OpenFin.SubscriptionOptions) => Promise<void | EventEmitter>;
|
|
4921
4793
|
/**
|
|
4922
4794
|
* Adds a listener to the end of the listeners array for the specified event.
|
|
4923
4795
|
*
|
|
@@ -4953,7 +4825,7 @@ declare class EmitterBase<EmitterEvent extends BaseEvent, EmitterEventType exten
|
|
|
4953
4825
|
* @remarks Caution: Calling this method changes the array indices in the listener array behind the listener.
|
|
4954
4826
|
*/
|
|
4955
4827
|
removeListener<EventType extends EmitterEventType>(eventType: EventType, listener: EventHandler<EmitterEvent, EventType>, options?: OpenFin.SubscriptionOptions): Promise<this>;
|
|
4956
|
-
|
|
4828
|
+
protected deregisterAllListeners(eventType: EmitterEventType): Promise<EventEmitter | void>;
|
|
4957
4829
|
/**
|
|
4958
4830
|
* Removes all listeners, or those of the specified event.
|
|
4959
4831
|
*
|
|
@@ -5113,7 +4985,7 @@ declare type Event_10 = ApplicationEvents.Event | ApiReadyEvent | SnapshotApplie
|
|
|
5113
4985
|
* under the {@link OpenFin.SystemEvents} namespace (payloads inherited from propagated events are defined in the namespace
|
|
5114
4986
|
* from which they propagate).
|
|
5115
4987
|
*/
|
|
5116
|
-
declare type Event_11 = ExcludeRequested<WindowEvents.PropagatedEvent<'system'>> | ExcludeRequested<ViewEvents.PropagatedEvent<'system'>> | ExcludeRequested<ApplicationEvents.PropagatedEvent<'system'>> | ApplicationCreatedEvent | DesktopIconClickedEvent | IdleStateChangedEvent | MonitorInfoChangedEvent | SessionChangedEvent | AppVersionEventWithId | SystemShutdownEvent | ExtensionsEnabledEvent | ExtensionsDisabledEvent | ExtensionsExcludedEvent | ExtensionsInstalledEvent | ExtensionInstalledEvent | ExtensionsInstallFailedEvent | ExtensionInstallFailedEvent | ExtensionsInitializationFailedEvent
|
|
4988
|
+
declare type Event_11 = ExcludeRequested<WindowEvents.PropagatedEvent<'system'>> | ExcludeRequested<ViewEvents.PropagatedEvent<'system'>> | ExcludeRequested<ApplicationEvents.PropagatedEvent<'system'>> | ApplicationCreatedEvent | DesktopIconClickedEvent | IdleStateChangedEvent | MonitorInfoChangedEvent | SessionChangedEvent | AppVersionEventWithId | SystemShutdownEvent | ExtensionsEnabledEvent | ExtensionsDisabledEvent | ExtensionsExcludedEvent | ExtensionsInstalledEvent | ExtensionInstalledEvent | ExtensionsInstallFailedEvent | ExtensionInstallFailedEvent | ExtensionsInitializationFailedEvent;
|
|
5117
4989
|
|
|
5118
4990
|
/**
|
|
5119
4991
|
* [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by the HTMLElement Layout container.
|
|
@@ -6633,28 +6505,7 @@ declare type Hotkey = {
|
|
|
6633
6505
|
*/
|
|
6634
6506
|
keys: string;
|
|
6635
6507
|
/**
|
|
6636
|
-
*
|
|
6637
|
-
*
|
|
6638
|
-
* - `'capture'`: The hotkey fires **before** the event is sent to the renderer/page.
|
|
6639
|
-
* This is the only phase where the `preventDefault` property is effective.
|
|
6640
|
-
*
|
|
6641
|
-
* - `'bubble'`: The hotkey fires **after** the page has processed the key event.
|
|
6642
|
-
* This behaves exactly like a standard JavaScript event listener attached to the window:
|
|
6643
|
-
* 1. If the page calls `event.preventDefault()` (on either **keydown** or **keyup**), this hotkey will **not** fire.
|
|
6644
|
-
* 2. If the hotkey is browser-reserved (e.g. `Ctrl+Tab` to switch tabs for which keyup/keydown do not fire in a web browser), that action takes precedence and this hotkey will **not** fire.
|
|
6645
|
-
*
|
|
6646
|
-
* @default 'capture'
|
|
6647
|
-
*/
|
|
6648
|
-
phase?: 'capture' | 'bubble';
|
|
6649
|
-
/**
|
|
6650
|
-
* Determines if the event should continue to the renderer.
|
|
6651
|
-
*
|
|
6652
|
-
* - `true`: The event is consumed immediately. It will **never** reach the renderer/page.
|
|
6653
|
-
* - `false`: The event is sent to the renderer after this hotkey executes.
|
|
6654
|
-
*
|
|
6655
|
-
* @remarks
|
|
6656
|
-
* This property is **only valid** when `phase` is set to `'capture'`.
|
|
6657
|
-
* If `phase` is `'bubble'`, this property is ignored (as the renderer has already received and processed the event).
|
|
6508
|
+
* Prevent default key handling before emitting the event.
|
|
6658
6509
|
*
|
|
6659
6510
|
* @default false
|
|
6660
6511
|
*/
|
|
@@ -9090,42 +8941,6 @@ declare type LayoutOptions = {
|
|
|
9090
8941
|
*/
|
|
9091
8942
|
preventDragIn?: boolean;
|
|
9092
8943
|
/* Excluded from this release type: disableTabOverflowDropdown */
|
|
9093
|
-
/**
|
|
9094
|
-
* When set to 'scroll', enables horizontal scrolling of tabs when they overflow the stack width.
|
|
9095
|
-
* When set to 'dropdown', the default behavior occurs, in which excess tabs appear in a menu.
|
|
9096
|
-
*
|
|
9097
|
-
* Setting this to `scroll` might break styles written for the default dropdown behavior, as it significantly changes the DOM structure and CSS of tabs.
|
|
9098
|
-
*
|
|
9099
|
-
* The DOM structure is modified in this way:
|
|
9100
|
-
* - `lm_tabs` is wrapped in a div with class `lm_scroll_shadow`. This div is revealed by a mask on the tabs when they are overflowing.
|
|
9101
|
-
* - the `.newTabButton` (if enabled) is a direct child of `.lm_header`
|
|
9102
|
-
*
|
|
9103
|
-
* **The following CSS variables are available to customize tab appearance:**
|
|
9104
|
-
*
|
|
9105
|
-
* - `--layout-tab-width`: The default (max) width of the tabs. Using this enables using `lm_tab` as a queryable CSS container (must be an absolute value to use container queries). Default: `fit-content`
|
|
9106
|
-
* - `--layout-tab-min-width`: The minimum width of the tabs before they start overflowing. Set this to enable tab shrinking. Defaults to the same value as `--layout-tab-width` (no shrinking).
|
|
9107
|
-
* - `--layout-tab-overflow-fade-size`: The width of the scroll shadows when tabs are overflowing. Default: `20px`
|
|
9108
|
-
* - `--layout-tab-overflow-shadow-color`: The color of the scroll shadows when tabs are overflowing. Enabling a contrasting shadow color may require setting the background color on `.lm_tabs` if it was not previously set via `--tabs-background-color`. Default is transparent so overlowing tabs fade into the background.
|
|
9109
|
-
*
|
|
9110
|
-
* **CSS Variables for advanced customization (dynamically updated and set on `lm_tabs`):**
|
|
9111
|
-
*
|
|
9112
|
-
* - `--layout-tab-overflow-fade-left`: The strength of the left fade when tabs are overflowing. This is a number between 0 and 1 where 0 means no fade and 1 means a full fade.
|
|
9113
|
-
* - `--layout-tab-overflow-fade-right`: The strength of the right fade when tabs are overflowing. This is a number between 0 and 1 where 0 means no fade and 1 means a full fade.
|
|
9114
|
-
* - `--layout-tabs-overflowing`: A [CSS space toggle](https://css-tricks.com/the-css-custom-property-toggle-trick/) that is empty when tabs are overflowing and `initial` otherwise. If you are targeting only Chrome 137 or greater, you might want to use the `if()` function with left/right fade instead of this toggle.
|
|
9115
|
-
*
|
|
9116
|
-
* @example
|
|
9117
|
-
* ```css
|
|
9118
|
-
* .lm_tabs {
|
|
9119
|
-
* --layout-tab-width: 200px;
|
|
9120
|
-
* --layout-tab-min-width: 100px;
|
|
9121
|
-
* --layout-tab-overflow-fade-size: 20px;
|
|
9122
|
-
* --layout-tab-overflow-shadow-color: rgba(0, 0, 0, 0.3);
|
|
9123
|
-
* }
|
|
9124
|
-
* ```
|
|
9125
|
-
*
|
|
9126
|
-
* @defaultValue 'dropdown'
|
|
9127
|
-
*/
|
|
9128
|
-
tabOverflowBehavior?: 'dropdown' | 'scroll';
|
|
9129
8944
|
};
|
|
9130
8945
|
/**
|
|
9131
8946
|
* Content of the layout. There can only be one top-level LayoutItem in the content array.
|
|
@@ -9233,43 +9048,6 @@ declare type LogInfo = {
|
|
|
9233
9048
|
*/
|
|
9234
9049
|
declare type LogLevel = 'verbose' | 'info' | 'warning' | 'error' | 'fatal';
|
|
9235
9050
|
|
|
9236
|
-
declare type LogPath = 'debug.log' | 'app.log';
|
|
9237
|
-
|
|
9238
|
-
declare type LogTarget = {
|
|
9239
|
-
type: LogPath;
|
|
9240
|
-
};
|
|
9241
|
-
|
|
9242
|
-
/**
|
|
9243
|
-
* Log types
|
|
9244
|
-
*
|
|
9245
|
-
* Note: For the debug log options, the one with the most specific matching pattern will be used.
|
|
9246
|
-
*/
|
|
9247
|
-
declare type LogTypes =
|
|
9248
|
-
/**
|
|
9249
|
-
* Uploads app logs
|
|
9250
|
-
*/
|
|
9251
|
-
'app'
|
|
9252
|
-
/**
|
|
9253
|
-
* Uploads rvm logs
|
|
9254
|
-
*/
|
|
9255
|
-
| 'rvm'
|
|
9256
|
-
/**
|
|
9257
|
-
* Uploads all debug logs
|
|
9258
|
-
*/
|
|
9259
|
-
| 'debug'
|
|
9260
|
-
/**
|
|
9261
|
-
* Uploads the most current debug log the current application
|
|
9262
|
-
*/
|
|
9263
|
-
| 'debug:self'
|
|
9264
|
-
/**
|
|
9265
|
-
* Uploads all debug logs for the current application
|
|
9266
|
-
*/
|
|
9267
|
-
| 'debug:self:archive'
|
|
9268
|
-
/**
|
|
9269
|
-
* Uploads the last two debug logs for the current application
|
|
9270
|
-
*/
|
|
9271
|
-
| 'debug:self:archive:last';
|
|
9272
|
-
|
|
9273
9051
|
/**
|
|
9274
9052
|
* Options for the Log Uploader.
|
|
9275
9053
|
*/
|
|
@@ -9338,12 +9116,8 @@ declare type LogUploadOptions = {
|
|
|
9338
9116
|
* An array of strings that specifies which logs should be uploaded.
|
|
9339
9117
|
* @defaultValue ['app', 'rvm', 'debug']
|
|
9340
9118
|
*/
|
|
9341
|
-
logs?:
|
|
9119
|
+
logs?: string[];
|
|
9342
9120
|
ui?: LogUploaderUIOptions;
|
|
9343
|
-
/**
|
|
9344
|
-
* Max file size limit in Megabytes for the logs archive.
|
|
9345
|
-
*/
|
|
9346
|
-
sizeLimit?: number;
|
|
9347
9121
|
};
|
|
9348
9122
|
|
|
9349
9123
|
/**
|
|
@@ -9381,10 +9155,6 @@ declare type Manifest = {
|
|
|
9381
9155
|
forceLatest?: boolean;
|
|
9382
9156
|
futureVersion?: string;
|
|
9383
9157
|
version: string;
|
|
9384
|
-
policies?: {
|
|
9385
|
-
CloudAPAuthEnabled?: 'enabled' | 'disabled';
|
|
9386
|
-
};
|
|
9387
|
-
themePalette?: Array<ThemePalette>;
|
|
9388
9158
|
};
|
|
9389
9159
|
services?: string[];
|
|
9390
9160
|
shortcut?: {
|
|
@@ -9758,10 +9528,6 @@ declare type MutableViewOptions = {
|
|
|
9758
9528
|
* {@inheritDoc ChromiumPolicies}
|
|
9759
9529
|
*/
|
|
9760
9530
|
chromiumPolicies: ChromiumPolicies;
|
|
9761
|
-
/**
|
|
9762
|
-
* Specifies the AppLogLevel for the specified View. See {@link AppLogLevel} for more information.
|
|
9763
|
-
*/
|
|
9764
|
-
appLogLevel?: AppLogLevel;
|
|
9765
9531
|
};
|
|
9766
9532
|
|
|
9767
9533
|
/**
|
|
@@ -9868,12 +9634,10 @@ declare type MutableWindowOptions = {
|
|
|
9868
9634
|
*/
|
|
9869
9635
|
customData: any;
|
|
9870
9636
|
/**
|
|
9637
|
+
* @deprecated Will be removed in runtime version 45
|
|
9871
9638
|
*
|
|
9872
9639
|
* Show the window's frame.
|
|
9873
9640
|
*
|
|
9874
|
-
* @remarks
|
|
9875
|
-
* This property will not be updatable starting runtime version 45.
|
|
9876
|
-
*
|
|
9877
9641
|
* @default true
|
|
9878
9642
|
*/
|
|
9879
9643
|
frame: boolean;
|
|
@@ -10038,10 +9802,6 @@ declare type MutableWindowOptions = {
|
|
|
10038
9802
|
* {@inheritDoc ChromiumPolicies}
|
|
10039
9803
|
*/
|
|
10040
9804
|
chromiumPolicies: ChromiumPolicies;
|
|
10041
|
-
/**
|
|
10042
|
-
* Specifies the AppLogLevel for the Window. See {@link AppLogLevel} for more information.
|
|
10043
|
-
*/
|
|
10044
|
-
appLogLevel?: AppLogLevel;
|
|
10045
9805
|
};
|
|
10046
9806
|
|
|
10047
9807
|
declare type NackHandler = (payloadOrMessage: RuntimeErrorPayload | string) => void;
|
|
@@ -10054,78 +9814,6 @@ declare type NamedEvent = IdentityEvent & {
|
|
|
10054
9814
|
name: string;
|
|
10055
9815
|
};
|
|
10056
9816
|
|
|
10057
|
-
/**
|
|
10058
|
-
* @interface
|
|
10059
|
-
*
|
|
10060
|
-
* Represents the native theme of the operating system.
|
|
10061
|
-
* This is used to determine how the application should render its UI based on the system's theme settings.
|
|
10062
|
-
* Defer to CSS properties whenever possible.
|
|
10063
|
-
*
|
|
10064
|
-
* Re-exported from Electron's `NativeTheme` type.
|
|
10065
|
-
*/
|
|
10066
|
-
declare type NativeTheme = {
|
|
10067
|
-
/**
|
|
10068
|
-
* A `boolean` indicating whether Chromium is in forced colors mode, controlled by
|
|
10069
|
-
* system accessibility settings. Currently, Windows high contrast is the only
|
|
10070
|
-
* system setting that triggers forced colors mode.
|
|
10071
|
-
*
|
|
10072
|
-
* @platform win32
|
|
10073
|
-
*/
|
|
10074
|
-
inForcedColorsMode: boolean;
|
|
10075
|
-
/**
|
|
10076
|
-
* A `boolean` that indicates the whether the user has chosen via system
|
|
10077
|
-
* accessibility settings to reduce transparency at the OS level.
|
|
10078
|
-
*
|
|
10079
|
-
*/
|
|
10080
|
-
prefersReducedTransparency: boolean;
|
|
10081
|
-
/**
|
|
10082
|
-
* A `boolean` for if the OS / Chromium currently has a dark mode enabled or is
|
|
10083
|
-
* being instructed to show a dark-style UI. If you want to modify this value you
|
|
10084
|
-
* should use `themeSource` below.
|
|
10085
|
-
*
|
|
10086
|
-
*/
|
|
10087
|
-
shouldUseDarkColors: boolean;
|
|
10088
|
-
/**
|
|
10089
|
-
* A `boolean` property indicating whether or not the system theme has been set to
|
|
10090
|
-
* dark or light.
|
|
10091
|
-
*
|
|
10092
|
-
* On Windows this property distinguishes between system and app light/dark theme,
|
|
10093
|
-
* returning `true` if the system theme is set to dark theme and `false` otherwise.
|
|
10094
|
-
* On macOS the return value will be the same as `nativeTheme.shouldUseDarkColors`.
|
|
10095
|
-
*
|
|
10096
|
-
* @platform darwin,win32
|
|
10097
|
-
*/
|
|
10098
|
-
shouldUseDarkColorsForSystemIntegratedUI: boolean;
|
|
10099
|
-
/**
|
|
10100
|
-
* A `boolean` for if the OS / Chromium currently has high-contrast mode enabled or
|
|
10101
|
-
* is being instructed to show a high-contrast UI.
|
|
10102
|
-
*
|
|
10103
|
-
* @platform darwin,win32
|
|
10104
|
-
*/
|
|
10105
|
-
shouldUseHighContrastColors: boolean;
|
|
10106
|
-
/**
|
|
10107
|
-
* A `boolean` for if the OS / Chromium currently has an inverted color scheme or
|
|
10108
|
-
* is being instructed to use an inverted color scheme.
|
|
10109
|
-
*
|
|
10110
|
-
* @platform darwin,win32
|
|
10111
|
-
*/
|
|
10112
|
-
shouldUseInvertedColorScheme: boolean;
|
|
10113
|
-
/**
|
|
10114
|
-
* A `string` property that can be `system`, `light` or `dark`. It is used (via `setTheme) to
|
|
10115
|
-
* override and supersede the value that Chromium has chosen to use internally.
|
|
10116
|
-
*/
|
|
10117
|
-
themeSource: 'system' | 'light' | 'dark';
|
|
10118
|
-
};
|
|
10119
|
-
|
|
10120
|
-
/**
|
|
10121
|
-
* Generated when the operating system's theme preferences change.
|
|
10122
|
-
* Occurs when dark mode, high contrast mode, or inverted color scheme settings are modified.
|
|
10123
|
-
*/
|
|
10124
|
-
declare type NativeThemeUpdatedEvent = BaseEvent_9 & {
|
|
10125
|
-
type: 'native-theme-updated';
|
|
10126
|
-
theme: OpenFin.NativeTheme;
|
|
10127
|
-
};
|
|
10128
|
-
|
|
10129
9817
|
/**
|
|
10130
9818
|
* @interface
|
|
10131
9819
|
*/
|
|
@@ -10411,9 +10099,6 @@ declare namespace OpenFin {
|
|
|
10411
10099
|
CustomProtocolOptions,
|
|
10412
10100
|
InteropBrokerOptions,
|
|
10413
10101
|
ContextGroupInfo,
|
|
10414
|
-
AnchorLocation,
|
|
10415
|
-
Anchor,
|
|
10416
|
-
DownloadBubbleOptions,
|
|
10417
10102
|
DisplayMetadata,
|
|
10418
10103
|
LegacyWinOptionsInAppOptions,
|
|
10419
10104
|
Snapshot,
|
|
@@ -10440,9 +10125,6 @@ declare namespace OpenFin {
|
|
|
10440
10125
|
InheritableOptions,
|
|
10441
10126
|
PolicyOptions,
|
|
10442
10127
|
ChromiumPolicies,
|
|
10443
|
-
AppLogLevel,
|
|
10444
|
-
LogPath,
|
|
10445
|
-
LogTarget,
|
|
10446
10128
|
MutableWindowOptions,
|
|
10447
10129
|
WorkspacePlatformOptions,
|
|
10448
10130
|
WebRequestHeader,
|
|
@@ -10518,16 +10200,10 @@ declare namespace OpenFin {
|
|
|
10518
10200
|
PlatformOptions,
|
|
10519
10201
|
LogUploaderOptions,
|
|
10520
10202
|
LogUploaderUIOptions,
|
|
10521
|
-
LogTypes,
|
|
10522
10203
|
LogUploadOptions,
|
|
10523
|
-
ThemeColorsMap,
|
|
10524
|
-
ThemeColorId,
|
|
10525
|
-
ThemePalette,
|
|
10526
10204
|
Manifest,
|
|
10527
10205
|
LayoutContent,
|
|
10528
10206
|
LayoutItemConfig,
|
|
10529
|
-
ThemePreferences,
|
|
10530
|
-
NativeTheme,
|
|
10531
10207
|
LayoutRow,
|
|
10532
10208
|
LayoutColumn,
|
|
10533
10209
|
LayoutComponent,
|
|
@@ -10747,7 +10423,6 @@ declare namespace OpenFin {
|
|
|
10747
10423
|
ChannelProviderDisconnectionListener,
|
|
10748
10424
|
RoutingInfo,
|
|
10749
10425
|
DownloadShelfOptions,
|
|
10750
|
-
SnapZoneOptions,
|
|
10751
10426
|
ViewShowAtOptions,
|
|
10752
10427
|
WebNotificationProperties,
|
|
10753
10428
|
WebNotificationInfo,
|
|
@@ -11022,11 +10697,6 @@ declare type PerDomainSettings = {
|
|
|
11022
10697
|
*/
|
|
11023
10698
|
drag?: 'allow' | 'block';
|
|
11024
10699
|
};
|
|
11025
|
-
/**
|
|
11026
|
-
* Allows the app log level of any matching content to be overriden.
|
|
11027
|
-
* See also {@link AppLogLevel} for more information.
|
|
11028
|
-
*/
|
|
11029
|
-
appLogLevel?: AppLogLevel;
|
|
11030
10700
|
};
|
|
11031
10701
|
|
|
11032
10702
|
/**
|
|
@@ -12664,7 +12334,7 @@ declare type PositioningOptions = {
|
|
|
12664
12334
|
/**
|
|
12665
12335
|
* Context menu item with an implementation provided by OpenFin.
|
|
12666
12336
|
*/
|
|
12667
|
-
declare type PrebuiltContextMenuItem = 'separator' | 'undo' | 'redo' | 'cut' | 'copy' | 'copyImage' | 'paste' | 'selectAll' | 'spellCheck' | 'inspect' | 'reload' | 'navigateForward' | 'navigateBack' | 'print'
|
|
12337
|
+
declare type PrebuiltContextMenuItem = 'separator' | 'undo' | 'redo' | 'cut' | 'copy' | 'copyImage' | 'paste' | 'selectAll' | 'spellCheck' | 'inspect' | 'reload' | 'navigateForward' | 'navigateBack' | 'print';
|
|
12668
12338
|
|
|
12669
12339
|
/**
|
|
12670
12340
|
* A script that is run before page load.
|
|
@@ -13362,12 +13032,6 @@ declare type ProtocolMap = ExternalAdapterOnlyCallsMap & AnalyticsProtocolMap &
|
|
|
13362
13032
|
'create-window': VoidCall;
|
|
13363
13033
|
'get-current-window': VoidCall;
|
|
13364
13034
|
'get-current-window-sync': VoidCall;
|
|
13365
|
-
'show-download-bubble': IdentityCall<{
|
|
13366
|
-
anchor?: OpenFin.Anchor;
|
|
13367
|
-
}, void>;
|
|
13368
|
-
'update-download-bubble-anchor': IdentityCall<{
|
|
13369
|
-
anchor: OpenFin.Anchor;
|
|
13370
|
-
}, void>;
|
|
13371
13035
|
'get-external-application-info': ApiCall<OpenFin.ApplicationIdentity, OpenFin.ExternalApplicationInfo>;
|
|
13372
13036
|
'external-application-wrap': VoidCall;
|
|
13373
13037
|
'external-application-wrap-sync': VoidCall;
|
|
@@ -13464,10 +13128,6 @@ declare type ProtocolMap = ExternalAdapterOnlyCallsMap & AnalyticsProtocolMap &
|
|
|
13464
13128
|
request: any;
|
|
13465
13129
|
response: any;
|
|
13466
13130
|
};
|
|
13467
|
-
'set-theme-preferences': ApiCall<{
|
|
13468
|
-
preferences: OpenFin.ThemePreferences;
|
|
13469
|
-
}, OpenFin.NativeTheme>;
|
|
13470
|
-
'get-theme-preferences': GetterCall<OpenFin.NativeTheme>;
|
|
13471
13131
|
'get-version': GetterCall<string>;
|
|
13472
13132
|
'clear-cache': ApiCall<OpenFin.ClearCacheOption, void>;
|
|
13473
13133
|
'delete-cache-request': VoidCall;
|
|
@@ -13555,9 +13215,6 @@ declare type ProtocolMap = ExternalAdapterOnlyCallsMap & AnalyticsProtocolMap &
|
|
|
13555
13215
|
'write-to-log': ApiCall<{
|
|
13556
13216
|
level: string;
|
|
13557
13217
|
message: string;
|
|
13558
|
-
target?: {
|
|
13559
|
-
type?: 'app.log' | 'debug.log';
|
|
13560
|
-
};
|
|
13561
13218
|
}, void>;
|
|
13562
13219
|
'open-url-with-browser': ApiCall<{
|
|
13563
13220
|
url: string;
|
|
@@ -13721,15 +13378,6 @@ declare type ProtocolMap = ExternalAdapterOnlyCallsMap & AnalyticsProtocolMap &
|
|
|
13721
13378
|
request: void;
|
|
13722
13379
|
response: OpenFin.ExtensionInfo[];
|
|
13723
13380
|
};
|
|
13724
|
-
'set-theme-palette': ApiCall<{
|
|
13725
|
-
themePalette: Array<OpenFin.ThemePalette>;
|
|
13726
|
-
}, void> & {
|
|
13727
|
-
themePalette: Array<OpenFin.ThemePalette>;
|
|
13728
|
-
};
|
|
13729
|
-
'get-theme-palette': ApiCall<void, Array<OpenFin.ThemePalette>> & {
|
|
13730
|
-
request: void;
|
|
13731
|
-
response: Array<OpenFin.ThemePalette>;
|
|
13732
|
-
};
|
|
13733
13381
|
'fdc3-add-context-listener': VoidCall;
|
|
13734
13382
|
'fdc3-add-intent-listener': VoidCall;
|
|
13735
13383
|
'fdc3-raise-intent': VoidCall;
|
|
@@ -14805,15 +14453,6 @@ declare type Size = TransitionBase & {
|
|
|
14805
14453
|
height: number;
|
|
14806
14454
|
};
|
|
14807
14455
|
|
|
14808
|
-
/**
|
|
14809
|
-
* Generated when a window is snapped to a screen edge.
|
|
14810
|
-
* @interface
|
|
14811
|
-
*/
|
|
14812
|
-
declare type SnappedEvent = BoundsEvent & {
|
|
14813
|
-
type: 'snapped';
|
|
14814
|
-
snapLocation: 'top' | 'bottom';
|
|
14815
|
-
};
|
|
14816
|
-
|
|
14817
14456
|
/**
|
|
14818
14457
|
* @interface
|
|
14819
14458
|
*/
|
|
@@ -14958,52 +14597,6 @@ declare class SnapshotSourceModule extends Base {
|
|
|
14958
14597
|
wrap(identity: OpenFin.ApplicationIdentity): Promise<SnapshotSource>;
|
|
14959
14598
|
}
|
|
14960
14599
|
|
|
14961
|
-
/**
|
|
14962
|
-
* Generated when a window enters or exits a snap zone during drag.
|
|
14963
|
-
* This event fires whenever the snap zone state changes (entry or exit).
|
|
14964
|
-
* @interface
|
|
14965
|
-
*/
|
|
14966
|
-
declare type SnapZoneChangedEvent = BaseEvent_5 & {
|
|
14967
|
-
type: 'snap-zone-changed';
|
|
14968
|
-
/**
|
|
14969
|
-
* Array of locations that the window is currently in snap zones for.
|
|
14970
|
-
* Empty array indicates the window is not in any snap zone.
|
|
14971
|
-
* Can contain multiple locations if the window is in multiple zones simultaneously.
|
|
14972
|
-
*/
|
|
14973
|
-
locations: Array<'top' | 'bottom'>;
|
|
14974
|
-
};
|
|
14975
|
-
|
|
14976
|
-
/**
|
|
14977
|
-
* @interface
|
|
14978
|
-
*
|
|
14979
|
-
* Configures snap zone behavior for a window. When enabled, the window will automatically snap to screen edges
|
|
14980
|
-
* when dragged near them during user drag interactions.
|
|
14981
|
-
*/
|
|
14982
|
-
declare type SnapZoneOptions = {
|
|
14983
|
-
/**
|
|
14984
|
-
* Whether snap zone functionality is enabled for this window.
|
|
14985
|
-
*
|
|
14986
|
-
* @default false
|
|
14987
|
-
*/
|
|
14988
|
-
enabled: boolean;
|
|
14989
|
-
/**
|
|
14990
|
-
* The distance in pixels from the screen edge that triggers the snap zone.
|
|
14991
|
-
* When the window is dragged within this threshold of the top or bottom edge,
|
|
14992
|
-
* it will be considered in a snap zone.
|
|
14993
|
-
*
|
|
14994
|
-
* @default 50
|
|
14995
|
-
*/
|
|
14996
|
-
threshold?: number;
|
|
14997
|
-
/**
|
|
14998
|
-
* Ordered array of edge preferences when the window is in multiple snap zones simultaneously.
|
|
14999
|
-
* The first edge in the array that the window is in will be used for snapping.
|
|
15000
|
-
* If not provided, defaults to ['top', 'bottom'] (preferring top over bottom).
|
|
15001
|
-
*
|
|
15002
|
-
* @default ['top', 'bottom']
|
|
15003
|
-
*/
|
|
15004
|
-
locationPreference?: Array<'top' | 'bottom'>;
|
|
15005
|
-
};
|
|
15006
|
-
|
|
15007
14600
|
/**
|
|
15008
14601
|
* Generated when an application has started.
|
|
15009
14602
|
* @interface
|
|
@@ -15781,14 +15374,13 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
|
|
|
15781
15374
|
* Writes the passed message into both the log file and the console.
|
|
15782
15375
|
* @param level The log level for the entry. Can be either "info", "warning" or "error"
|
|
15783
15376
|
* @param message The log message text
|
|
15784
|
-
* @param target The log stream this message will be sent to, defaults to 'debug.log'. Specify 'app.log' to log to the app log of the sending View / Window. Note, when using `app.log`, it will always log to app.log irrespective of the `enableAppLogging` setting for the sender. This is particularly useful if you wish to log certain things from a View / Window but ignore generic console logs.
|
|
15785
15377
|
*
|
|
15786
15378
|
* @example
|
|
15787
15379
|
* ```js
|
|
15788
|
-
* fin.System.log("info", "An example log message"
|
|
15380
|
+
* fin.System.log("info", "An example log message").then(() => console.log('Log info message')).catch(err => console.log(err));
|
|
15789
15381
|
* ```
|
|
15790
15382
|
*/
|
|
15791
|
-
log(level: string, message: string
|
|
15383
|
+
log(level: string, message: string): Promise<void>;
|
|
15792
15384
|
/**
|
|
15793
15385
|
* Opens the passed URL in the default web browser.
|
|
15794
15386
|
*
|
|
@@ -16527,123 +16119,11 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
|
|
|
16527
16119
|
* Not indended for general use, will be used by the `@openfin/workspace-platform` package.
|
|
16528
16120
|
*/
|
|
16529
16121
|
serveAsset(options: OpenFin.ServeAssetOptions): Promise<OpenFin.ServedAssetInfo>;
|
|
16530
|
-
/**
|
|
16531
|
-
* Get's the native theme preferences for the current runtime.
|
|
16532
|
-
* Prefer css media-queries wherever possible, but this can be useful to see if the system setting has been overridden.
|
|
16533
|
-
* See @link OpenFin.NativeTheme for more information.
|
|
16534
|
-
* @example Theme selector menu
|
|
16535
|
-
* ```ts
|
|
16536
|
-
async function handleThemeMenu(e: React.MouseEvent<HTMLDivElement>) {
|
|
16537
|
-
const currentTheme = await fin.System.getThemePreferences();
|
|
16538
|
-
const result = await (fin.me as OpenFin.Window).showPopupMenu({
|
|
16539
|
-
x: e.clientX,
|
|
16540
|
-
y: e.clientY,
|
|
16541
|
-
template: [
|
|
16542
|
-
{
|
|
16543
|
-
label: 'Light',
|
|
16544
|
-
type: 'checkbox',
|
|
16545
|
-
checked: currentTheme.themeSource === 'light',
|
|
16546
|
-
data: { themeSource: 'light' } as const
|
|
16547
|
-
},
|
|
16548
|
-
{
|
|
16549
|
-
label: 'Dark',
|
|
16550
|
-
type: 'checkbox',
|
|
16551
|
-
checked: currentTheme.themeSource === 'dark',
|
|
16552
|
-
data: { themeSource: 'dark' } as const
|
|
16553
|
-
},
|
|
16554
|
-
{
|
|
16555
|
-
label: 'System',
|
|
16556
|
-
type: 'checkbox',
|
|
16557
|
-
checked: currentTheme.themeSource === 'system',
|
|
16558
|
-
data: { themeSource: 'system' } as const
|
|
16559
|
-
}
|
|
16560
|
-
]
|
|
16561
|
-
});
|
|
16562
|
-
if (result.result === 'clicked') {
|
|
16563
|
-
await fin.System.setThemePreferences(result.data);
|
|
16564
|
-
}
|
|
16565
|
-
}
|
|
16566
|
-
```
|
|
16567
|
-
*/
|
|
16568
|
-
getThemePreferences(): Promise<OpenFin.NativeTheme>;
|
|
16569
|
-
/**
|
|
16570
|
-
* Sets the native theme preferences for the current runtime.
|
|
16571
|
-
* Can be used to force runtime-wide light or dark mode.
|
|
16572
|
-
* @important Due to this impacting all applications on a runtime, this method is only usable if a security realm has been set.
|
|
16573
|
-
* @example Theme selector menu
|
|
16574
|
-
* ```ts
|
|
16575
|
-
async function handleThemeMenu(e: React.MouseEvent<HTMLDivElement>) {
|
|
16576
|
-
const currentTheme = await fin.System.getThemePreferences();
|
|
16577
|
-
const result = await (fin.me as OpenFin.Window).showPopupMenu({
|
|
16578
|
-
x: e.clientX,
|
|
16579
|
-
y: e.clientY,
|
|
16580
|
-
template: [
|
|
16581
|
-
{
|
|
16582
|
-
label: 'Light',
|
|
16583
|
-
type: 'checkbox',
|
|
16584
|
-
checked: currentTheme.themeSource === 'light',
|
|
16585
|
-
data: { themeSource: 'light' } as const
|
|
16586
|
-
},
|
|
16587
|
-
{
|
|
16588
|
-
label: 'Dark',
|
|
16589
|
-
type: 'checkbox',
|
|
16590
|
-
checked: currentTheme.themeSource === 'dark',
|
|
16591
|
-
data: { themeSource: 'dark' } as const
|
|
16592
|
-
},
|
|
16593
|
-
{
|
|
16594
|
-
label: 'System',
|
|
16595
|
-
type: 'checkbox',
|
|
16596
|
-
checked: currentTheme.themeSource === 'system',
|
|
16597
|
-
data: { themeSource: 'system' } as const
|
|
16598
|
-
}
|
|
16599
|
-
]
|
|
16600
|
-
});
|
|
16601
|
-
if (result.result === 'clicked') {
|
|
16602
|
-
await fin.System.setThemePreferences(result.data);
|
|
16603
|
-
}
|
|
16604
|
-
}
|
|
16605
|
-
```
|
|
16606
|
-
*/
|
|
16607
|
-
setThemePreferences(preferences: OpenFin.ThemePreferences): Promise<OpenFin.ThemePreferences>;
|
|
16608
16122
|
/**
|
|
16609
16123
|
* Launches the Log Uploader. Full documentation can be found [here](https://resources.here.io/docs/core/develop/debug/log-uploader/).
|
|
16610
16124
|
* @experimental
|
|
16611
16125
|
*/
|
|
16612
16126
|
launchLogUploader(options: OpenFin.LogUploaderOptions): Promise<void>;
|
|
16613
|
-
/**
|
|
16614
|
-
* Overrides original Chromium theme color providers matching key (currently except high contrast ones). Only colors passed in the map will be overridden.
|
|
16615
|
-
* @param overrides - Array of ColorProviderOverrides objects
|
|
16616
|
-
* @example
|
|
16617
|
-
* ```ts
|
|
16618
|
-
* await fin.System.setThemePalette([
|
|
16619
|
-
* {
|
|
16620
|
-
* colorProviderKey: { colorMode: 'light' },
|
|
16621
|
-
* colorsMap: {
|
|
16622
|
-
* kColorLabelForeground: 4278190080,
|
|
16623
|
-
* kColorBubbleBackground: 4293980400
|
|
16624
|
-
* }
|
|
16625
|
-
* },
|
|
16626
|
-
* {
|
|
16627
|
-
* colorProviderKey: { colorMode: 'dark' },
|
|
16628
|
-
* colorsMap: {
|
|
16629
|
-
* kColorLabelForeground: 4293980400,
|
|
16630
|
-
* kColorBubbleBackground: 4293980400
|
|
16631
|
-
* }
|
|
16632
|
-
* }
|
|
16633
|
-
* ]);
|
|
16634
|
-
* ```
|
|
16635
|
-
*/
|
|
16636
|
-
setThemePalette(themePalette: Array<OpenFin.ThemePalette>): Promise<void>;
|
|
16637
|
-
/**
|
|
16638
|
-
* Retrieves currently used color overrides
|
|
16639
|
-
* @returns Array of ColorProviderOverrides objects
|
|
16640
|
-
* @example
|
|
16641
|
-
* ```ts
|
|
16642
|
-
* const themePalette = await fin.System.getThemePalette();
|
|
16643
|
-
* console.log(themePalette);
|
|
16644
|
-
* ```
|
|
16645
|
-
*/
|
|
16646
|
-
getThemePalette(): Promise<Array<OpenFin.ThemePalette>>;
|
|
16647
16127
|
}
|
|
16648
16128
|
|
|
16649
16129
|
/**
|
|
@@ -16682,8 +16162,6 @@ declare namespace SystemEvents {
|
|
|
16682
16162
|
ExtensionsInstallFailedEvent,
|
|
16683
16163
|
ExtensionInstallFailedEvent,
|
|
16684
16164
|
ExtensionsInitializationFailedEvent,
|
|
16685
|
-
ThemePaletteChangedEvent,
|
|
16686
|
-
NativeThemeUpdatedEvent,
|
|
16687
16165
|
Event_11 as Event,
|
|
16688
16166
|
SystemEvent,
|
|
16689
16167
|
EventType_8 as EventType,
|
|
@@ -16807,7 +16285,6 @@ declare class TabStack extends LayoutNode {
|
|
|
16807
16285
|
* and rendered at the front of the tab-stack, while the underlying order of tabs will remain unchanged.
|
|
16808
16286
|
* If that happens and then getViews() is called, it will return the identities in a different order than
|
|
16809
16287
|
* than the currently rendered tab order.
|
|
16810
|
-
* Note: This issue does not occur when using `tabOverflowBehavior: 'scroll'` in the layout configuration.
|
|
16811
16288
|
*
|
|
16812
16289
|
*
|
|
16813
16290
|
* @throws If the {@link TabStack} has been destroyed.
|
|
@@ -16832,7 +16309,6 @@ declare class TabStack extends LayoutNode {
|
|
|
16832
16309
|
*
|
|
16833
16310
|
* @remarks Known Issue: If adding a view overflows the tab-container, the added view will be set as active
|
|
16834
16311
|
* and rendered at the front of the tab-stack, while the underlying order of tabs will remain unchanged.
|
|
16835
|
-
* Note: This issue does not occur when using `tabOverflowBehavior: 'scroll'` in the layout configuration.
|
|
16836
16312
|
*
|
|
16837
16313
|
* @param view The identity of an existing view to add, or options to create a view.
|
|
16838
16314
|
* @param options Optional view options: index number used to insert the view into the stack at that index. Defaults to 0 (front of the stack)
|
|
@@ -16954,109 +16430,6 @@ declare type TerminateExternalRequestType = {
|
|
|
16954
16430
|
killTree: boolean;
|
|
16955
16431
|
};
|
|
16956
16432
|
|
|
16957
|
-
/**
|
|
16958
|
-
* String literal type of all supported theme color IDs.
|
|
16959
|
-
* Useful wherever you need to refer to a color slot by name.
|
|
16960
|
-
* @interface
|
|
16961
|
-
*/
|
|
16962
|
-
declare type ThemeColorId = keyof ThemeColorsMap;
|
|
16963
|
-
|
|
16964
|
-
/**
|
|
16965
|
-
* All supported color slots for the Download Bubble and related UI.
|
|
16966
|
-
* @interface
|
|
16967
|
-
*/
|
|
16968
|
-
declare interface ThemeColorsMap {
|
|
16969
|
-
/**
|
|
16970
|
-
* Enterprise/Window/Background – bubble header and footer background.
|
|
16971
|
-
*/
|
|
16972
|
-
kColorBubbleBackground?: number;
|
|
16973
|
-
/**
|
|
16974
|
-
* Windows only – Enterprise/Window/Border.
|
|
16975
|
-
*/
|
|
16976
|
-
kColorBubbleBorder?: number;
|
|
16977
|
-
/**
|
|
16978
|
-
* Windows only – Enterprise/Window/Border (large shadow).
|
|
16979
|
-
*/
|
|
16980
|
-
kColorBubbleBorderShadowLarge?: number;
|
|
16981
|
-
/**
|
|
16982
|
-
* Windows only – Enterprise/Window/Border (small shadow).
|
|
16983
|
-
*/
|
|
16984
|
-
kColorBubbleBorderShadowSmall?: number;
|
|
16985
|
-
/**
|
|
16986
|
-
* Enterprise/Window/Background – downloaded item row background.
|
|
16987
|
-
*/
|
|
16988
|
-
kColorDialogBackground?: number;
|
|
16989
|
-
/**
|
|
16990
|
-
* Enterprise/Search Result/Background/Hover – download item row hover.
|
|
16991
|
-
*/
|
|
16992
|
-
kColorDownloadBubbleRowHover?: number;
|
|
16993
|
-
/**
|
|
16994
|
-
* Enterprise/Window/Icon – “Show all downloads” icon color.
|
|
16995
|
-
*/
|
|
16996
|
-
kColorDownloadBubbleShowAllDownloadsIcon?: number;
|
|
16997
|
-
/**
|
|
16998
|
-
* Enterprise/Search Result/Background/Hover – full download history
|
|
16999
|
-
* button (full row) hover background.
|
|
17000
|
-
*/
|
|
17001
|
-
kColorHoverButtonBackgroundHovered?: number;
|
|
17002
|
-
/**
|
|
17003
|
-
* Shared/Icon Button/Subtle/Icon/Default – SVG icon color
|
|
17004
|
-
* (except full download history button).
|
|
17005
|
-
*/
|
|
17006
|
-
kColorIcon?: number;
|
|
17007
|
-
/**
|
|
17008
|
-
* Enterprise/Window/Text/Base – main label text color.
|
|
17009
|
-
* May be post-processed to increase readability on kColorDialogBackground
|
|
17010
|
-
* (can be disabled via transparent kColorLabelBackground).
|
|
17011
|
-
*/
|
|
17012
|
-
kColorLabelForeground?: number;
|
|
17013
|
-
/**
|
|
17014
|
-
* Label background used for readability adjustment.
|
|
17015
|
-
* Set to transparent (0) to disable Chromium’s readability alignment logic.
|
|
17016
|
-
*/
|
|
17017
|
-
kColorLabelBackground?: number;
|
|
17018
|
-
/**
|
|
17019
|
-
* Enterprise/Window/Text/Soft – secondary text color.
|
|
17020
|
-
* May be post-processed to increase readability on kColorDialogBackground
|
|
17021
|
-
* (can be disabled via transparent kColorLabelBackground).
|
|
17022
|
-
*/
|
|
17023
|
-
kColorSecondaryForeground?: number;
|
|
17024
|
-
}
|
|
17025
|
-
|
|
17026
|
-
/**
|
|
17027
|
-
* Defines a set of color overrides for Chromium UI surfaces based on a theme
|
|
17028
|
-
* provider (e.g., light or dark mode).
|
|
17029
|
-
* @interface
|
|
17030
|
-
*/
|
|
17031
|
-
declare type ThemePalette = {
|
|
17032
|
-
/**
|
|
17033
|
-
* Identifies the color provider mode that the palette applies to.
|
|
17034
|
-
*/
|
|
17035
|
-
colorProviderKey: {
|
|
17036
|
-
/**
|
|
17037
|
-
* The UI color mode that this palette is intended to style.
|
|
17038
|
-
*/
|
|
17039
|
-
colorMode: 'light' | 'dark';
|
|
17040
|
-
};
|
|
17041
|
-
/**
|
|
17042
|
-
* A mapping of known Chromium color IDs to ARGB values (0xAARRGGBB).
|
|
17043
|
-
*/
|
|
17044
|
-
colorsMap: ThemeColorsMap;
|
|
17045
|
-
};
|
|
17046
|
-
|
|
17047
|
-
/**
|
|
17048
|
-
* An event that fires when the system theme palette is changed.
|
|
17049
|
-
*/
|
|
17050
|
-
declare type ThemePaletteChangedEvent = BaseEvent_9 & {
|
|
17051
|
-
type: 'theme-palette-changed';
|
|
17052
|
-
themePalette: OpenFin.ThemePalette;
|
|
17053
|
-
};
|
|
17054
|
-
|
|
17055
|
-
/**
|
|
17056
|
-
* Settable options for the native theme of the operating system.
|
|
17057
|
-
*/
|
|
17058
|
-
declare type ThemePreferences = Pick<NativeTheme, 'themeSource'>;
|
|
17059
|
-
|
|
17060
16433
|
/**
|
|
17061
16434
|
* @interface
|
|
17062
16435
|
*/
|
|
@@ -20350,62 +19723,6 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
|
|
|
20350
19723
|
* To print the views embedded in their page context, set `content` to `screenshot`.
|
|
20351
19724
|
*/
|
|
20352
19725
|
print(options?: OpenFin.WindowPrintOptions): Promise<void>;
|
|
20353
|
-
/**
|
|
20354
|
-
* Displays the download bubble UI. If an anchor is provided, the bubble
|
|
20355
|
-
* will be positioned according to the specified rectangle and anchor point.
|
|
20356
|
-
*
|
|
20357
|
-
* @param {OpenFin.Anchor} options
|
|
20358
|
-
* Anchor configuration used to position the download bubble. This includes
|
|
20359
|
-
* the bounding rectangle and the anchor location within that rectangle.
|
|
20360
|
-
*
|
|
20361
|
-
* @returns {Promise<void>}
|
|
20362
|
-
* A promise that resolves once the request to show the download bubble
|
|
20363
|
-
* has been processed.
|
|
20364
|
-
* @example
|
|
20365
|
-
* ```js
|
|
20366
|
-
* const w = fin.Window.getCurrentSync();
|
|
20367
|
-
* const el = document.getElementById("download-bubble-button");
|
|
20368
|
-
* const rect = el.getBoundingClientRect();
|
|
20369
|
-
* const anchor = {
|
|
20370
|
-
* bounds: rect,
|
|
20371
|
-
* location: "topRight"
|
|
20372
|
-
* };
|
|
20373
|
-
* w.showDownloadBubble(anchor);
|
|
20374
|
-
* ```
|
|
20375
|
-
*/
|
|
20376
|
-
showDownloadBubble(anchor?: OpenFin.Anchor): Promise<void>;
|
|
20377
|
-
/**
|
|
20378
|
-
* Updates the anchor used for positioning the download bubble. This allows
|
|
20379
|
-
* moving the bubble reactively—for example, in response to window resizes,
|
|
20380
|
-
* layout changes, or DOM element repositioning.
|
|
20381
|
-
*
|
|
20382
|
-
* @param {OpenFin.Anchor} options
|
|
20383
|
-
* New anchor configuration describing the updated position and anchor
|
|
20384
|
-
* location for the download bubble.
|
|
20385
|
-
*
|
|
20386
|
-
* @returns {Promise<void>}
|
|
20387
|
-
* A promise that resolves once the anchor update has been applied.
|
|
20388
|
-
* @example
|
|
20389
|
-
* ```js
|
|
20390
|
-
* var w = fin.Window.getCurrentSync();
|
|
20391
|
-
* w.on('download-button-visibility-changed', (evt) => {
|
|
20392
|
-
* if (evt.visible) {
|
|
20393
|
-
* const el = document.getElementById("download-bubble-button");
|
|
20394
|
-
* //We show our button and get it's bounding rect
|
|
20395
|
-
* el.classList.remove("hidden");
|
|
20396
|
-
* const rect = el.getBoundingClientRect();
|
|
20397
|
-
* const anchor = {
|
|
20398
|
-
* bounds: rect,
|
|
20399
|
-
* location: "topRight"
|
|
20400
|
-
* }
|
|
20401
|
-
* w.updateDownloadBubbleAnchor(anchor);
|
|
20402
|
-
* } else {
|
|
20403
|
-
* //We hide our button
|
|
20404
|
-
* document.getElementById("download-bubble-button")?.classList.add("hidden");
|
|
20405
|
-
* }
|
|
20406
|
-
});
|
|
20407
|
-
*/
|
|
20408
|
-
updateDownloadBubbleAnchor(anchor: OpenFin.Anchor): Promise<void>;
|
|
20409
19726
|
}
|
|
20410
19727
|
|
|
20411
19728
|
/**
|
|
@@ -20560,8 +19877,6 @@ declare namespace WindowEvents {
|
|
|
20560
19877
|
BoundsChangingEvent,
|
|
20561
19878
|
DisabledMovementBoundsChangedEvent,
|
|
20562
19879
|
DisabledMovementBoundsChangingEvent,
|
|
20563
|
-
SnappedEvent,
|
|
20564
|
-
SnapZoneChangedEvent,
|
|
20565
19880
|
UserBoundsChangeEvent,
|
|
20566
19881
|
BeginUserBoundsChangingEvent,
|
|
20567
19882
|
EndUserBoundsChangingEvent,
|
|
@@ -20601,8 +19916,6 @@ declare namespace WindowEvents {
|
|
|
20601
19916
|
NonPropagatedWindowEvent,
|
|
20602
19917
|
ShowAllDownloadsEvent,
|
|
20603
19918
|
DownloadShelfVisibilityChangedEvent,
|
|
20604
|
-
DownloadButtonVisibilityChangedEvent,
|
|
20605
|
-
DownloadButtonIconUpdatedEvent,
|
|
20606
19919
|
WindowSourcedEvent,
|
|
20607
19920
|
WillPropagateWindowEvent,
|
|
20608
19921
|
Event_6 as Event,
|
|
@@ -20806,7 +20119,7 @@ declare type WindowShowRequestedEvent = ShowRequestedEvent;
|
|
|
20806
20119
|
* A union of all events that emit natively on the `Window` topic, i.e. excluding those that propagate
|
|
20807
20120
|
* from {@link OpenFin.ViewEvents}.
|
|
20808
20121
|
*/
|
|
20809
|
-
declare type WindowSourcedEvent = WebContentsEvents.Event<'window'> | WindowViewEvent | AuthRequestedEvent | BeginUserBoundsChangingEvent | BoundsChangedEvent | BoundsChangingEvent | ContextChangedEvent | CloseRequestedEvent | ClosedEvent_2 | ClosingEvent | DisabledMovementBoundsChangedEvent | DisabledMovementBoundsChangingEvent | EmbeddedEvent | EndUserBoundsChangingEvent | ExternalProcessExitedEvent | ExternalProcessStartedEvent | HiddenEvent_2 | HotkeyEvent_2 | InitializedEvent_2 | LayoutInitializedEvent | LayoutReadyEvent | LayoutCreatedEvent | LayoutDestroyedEvent | LayoutSnapshotAppliedEvent | MaximizedEvent | MinimizedEvent | OptionsChangedEvent | PerformanceReportEvent | PreloadScriptsStateChangedEvent | PreloadScriptsStateChangingEvent | ReloadedEvent | RestoredEvent | ShowRequestedEvent | ShownEvent_2 | UserMovementDisabledEvent | UserMovementEnabledEvent | WillMoveEvent | WillResizeEvent | ShowAllDownloadsEvent | DownloadShelfVisibilityChangedEvent
|
|
20122
|
+
declare type WindowSourcedEvent = WebContentsEvents.Event<'window'> | WindowViewEvent | AuthRequestedEvent | BeginUserBoundsChangingEvent | BoundsChangedEvent | BoundsChangingEvent | ContextChangedEvent | CloseRequestedEvent | ClosedEvent_2 | ClosingEvent | DisabledMovementBoundsChangedEvent | DisabledMovementBoundsChangingEvent | EmbeddedEvent | EndUserBoundsChangingEvent | ExternalProcessExitedEvent | ExternalProcessStartedEvent | HiddenEvent_2 | HotkeyEvent_2 | InitializedEvent_2 | LayoutInitializedEvent | LayoutReadyEvent | LayoutCreatedEvent | LayoutDestroyedEvent | LayoutSnapshotAppliedEvent | MaximizedEvent | MinimizedEvent | OptionsChangedEvent | PerformanceReportEvent | PreloadScriptsStateChangedEvent | PreloadScriptsStateChangingEvent | ReloadedEvent | RestoredEvent | ShowRequestedEvent | ShownEvent_2 | UserMovementDisabledEvent | UserMovementEnabledEvent | WillMoveEvent | WillResizeEvent | ShowAllDownloadsEvent | DownloadShelfVisibilityChangedEvent;
|
|
20810
20123
|
|
|
20811
20124
|
/**
|
|
20812
20125
|
* Generated when a child window starts loading.
|