@openfin/fdc3-api 43.101.2 → 44.100.1
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.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>;
|
|
@@ -1423,53 +1395,6 @@ declare type ApplicationWindowInfo = {
|
|
|
1423
1395
|
uuid: string;
|
|
1424
1396
|
};
|
|
1425
1397
|
|
|
1426
|
-
/**
|
|
1427
|
-
* The `appLogLevel` option allows the verbosity of app logs that are collected for a Window or View to be controlled for its application.
|
|
1428
|
-
*
|
|
1429
|
-
* 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
|
|
1430
|
-
* controlling a url's appLogLevel, its view/window options will be ignored.
|
|
1431
|
-
*
|
|
1432
|
-
* @default 'debug'
|
|
1433
|
-
*
|
|
1434
|
-
* Please note, if the manifest setting `platform.enableAppLogging` or `startup_app.enableAppLogging` is set to `false`, this feature will be disabled.
|
|
1435
|
-
*
|
|
1436
|
-
* @example Controlling App Logs With DefaultViewOptions + Domain Settings
|
|
1437
|
-
*
|
|
1438
|
-
* In this example manifest, we use `defaultViewOptions to set the default verbosity to 'warn'.
|
|
1439
|
-
*
|
|
1440
|
-
* We also use domain settings to suppress logs for an example URL, and to lower verbosity to 'debug' for another.
|
|
1441
|
-
*
|
|
1442
|
-
* ```ts
|
|
1443
|
-
* {
|
|
1444
|
-
* <rest of settings>
|
|
1445
|
-
* "platform": {
|
|
1446
|
-
* <rest of settings>
|
|
1447
|
-
* "defaultViewOptions": {
|
|
1448
|
-
* "appLogLevel": "warn"
|
|
1449
|
-
* },
|
|
1450
|
-
* "domainSettings": {
|
|
1451
|
-
* "default": { <rest of settings> }
|
|
1452
|
-
* "rules": [
|
|
1453
|
-
* <rest of rules>
|
|
1454
|
-
* {
|
|
1455
|
-
* "match": ["*://*?app-logging-level=silent"],
|
|
1456
|
-
* "options": {
|
|
1457
|
-
* "appLogLevel": "silent"
|
|
1458
|
-
* }
|
|
1459
|
-
* },
|
|
1460
|
-
* {
|
|
1461
|
-
* "match": ["*://*?app-logging-level=debug"],
|
|
1462
|
-
* "options": {
|
|
1463
|
-
* "appLogLevel": "debug"
|
|
1464
|
-
* }
|
|
1465
|
-
* },
|
|
1466
|
-
* ]
|
|
1467
|
-
* }
|
|
1468
|
-
* }
|
|
1469
|
-
* }
|
|
1470
|
-
*/
|
|
1471
|
-
declare type AppLogLevel = 'silent' | 'debug' | 'info' | 'warn' | 'error';
|
|
1472
|
-
|
|
1473
1398
|
/**
|
|
1474
1399
|
* @interface
|
|
1475
1400
|
*/
|
|
@@ -3731,12 +3656,6 @@ declare type ConstViewOptions = {
|
|
|
3731
3656
|
* Control which options to ignore when creating a Platform View.
|
|
3732
3657
|
*/
|
|
3733
3658
|
excludeOptions: ExcludeOptions;
|
|
3734
|
-
/**
|
|
3735
|
-
* Determines whether window.open calls from web contents should use the specified target name as provided, or automatically generate a unique name.
|
|
3736
|
-
* When true, each call generates a new unique target name, ensuring a new window is always created.
|
|
3737
|
-
* When false, the target name passed to window.open is respected.
|
|
3738
|
-
*/
|
|
3739
|
-
ignoreChildFrameName?: boolean;
|
|
3740
3659
|
};
|
|
3741
3660
|
|
|
3742
3661
|
/**
|
|
@@ -4004,16 +3923,6 @@ declare type ConstWindowOptions = {
|
|
|
4004
3923
|
* 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.
|
|
4005
3924
|
*/
|
|
4006
3925
|
roundedCorners: boolean;
|
|
4007
|
-
/**
|
|
4008
|
-
* Determines whether window.open calls from web contents should use the specified target name as provided, or automatically generate a unique name.
|
|
4009
|
-
* When true, each call generates a new unique target name, ensuring a new window is always created.
|
|
4010
|
-
* When false, the target name passed to window.open is respected.
|
|
4011
|
-
*/
|
|
4012
|
-
ignoreChildFrameName?: boolean;
|
|
4013
|
-
/**
|
|
4014
|
-
* Configuration for download bubble UI.
|
|
4015
|
-
*/
|
|
4016
|
-
downloadBubble?: DownloadBubbleOptions;
|
|
4017
3926
|
};
|
|
4018
3927
|
|
|
4019
3928
|
/**
|
|
@@ -4344,7 +4253,7 @@ declare type CpuInfo = {
|
|
|
4344
4253
|
declare type CrashedEvent = BaseEvents.IdentityEvent & {
|
|
4345
4254
|
topic: 'application';
|
|
4346
4255
|
type: 'crashed';
|
|
4347
|
-
reason: 'normal-termination' | 'abnormal-termination' | 'killed' | 'crashed' | 'still-running' | 'launch-failed' | 'out-of-memory' | 'integrity-failure'
|
|
4256
|
+
reason: 'normal-termination' | 'abnormal-termination' | 'killed' | 'crashed' | 'still-running' | 'launch-failed' | 'out-of-memory' | 'integrity-failure';
|
|
4348
4257
|
exitCode: number;
|
|
4349
4258
|
details: {
|
|
4350
4259
|
reason: string;
|
|
@@ -4358,7 +4267,7 @@ declare type CrashedEvent = BaseEvents.IdentityEvent & {
|
|
|
4358
4267
|
*/
|
|
4359
4268
|
declare type CrashedEvent_2 = NamedEvent & {
|
|
4360
4269
|
type: 'crashed';
|
|
4361
|
-
reason: 'normal-termination' | 'abnormal-termination' | 'killed' | 'crashed' | 'still-running' | 'launch-failed' | 'out-of-memory' | 'integrity-failure'
|
|
4270
|
+
reason: 'normal-termination' | 'abnormal-termination' | 'killed' | 'crashed' | 'still-running' | 'launch-failed' | 'out-of-memory' | 'integrity-failure';
|
|
4362
4271
|
exitCode: number;
|
|
4363
4272
|
details: {
|
|
4364
4273
|
reason: string;
|
|
@@ -4766,50 +4675,6 @@ declare type DomainSettingsRule = {
|
|
|
4766
4675
|
matchOptions?: RuleMatchOptions;
|
|
4767
4676
|
};
|
|
4768
4677
|
|
|
4769
|
-
/**
|
|
4770
|
-
* Configuration options for enabling and positioning the download bubble UI.
|
|
4771
|
-
* @interface
|
|
4772
|
-
*/
|
|
4773
|
-
declare type DownloadBubbleOptions = {
|
|
4774
|
-
/**
|
|
4775
|
-
* Whether the download bubble feature is enabled.
|
|
4776
|
-
*/
|
|
4777
|
-
enabled: boolean;
|
|
4778
|
-
/**
|
|
4779
|
-
* Anchor configuration describing where the download bubble should attach.
|
|
4780
|
-
*/
|
|
4781
|
-
anchor: Anchor;
|
|
4782
|
-
};
|
|
4783
|
-
|
|
4784
|
-
/**
|
|
4785
|
-
* Generated when the download button icon needs to be updated. Only raised if the download bubble feature is enabled.
|
|
4786
|
-
*
|
|
4787
|
-
* @interface
|
|
4788
|
-
*/
|
|
4789
|
-
declare type DownloadButtonIconUpdatedEvent = BaseEvent_5 & {
|
|
4790
|
-
type: 'download-button-icon-updated';
|
|
4791
|
-
disabled: boolean;
|
|
4792
|
-
active: boolean;
|
|
4793
|
-
touchMode: boolean;
|
|
4794
|
-
progressIndicatorState: 'idle' | 'scanning' | 'downloading' | 'dormant';
|
|
4795
|
-
progressDownloadCount: number;
|
|
4796
|
-
progressPercentage: number;
|
|
4797
|
-
buttonTooltip: string;
|
|
4798
|
-
};
|
|
4799
|
-
|
|
4800
|
-
/**
|
|
4801
|
-
* Generated when the visibility of the window's download button changes. Only raised if the download bubble feature is enabled.
|
|
4802
|
-
*
|
|
4803
|
-
* @interface
|
|
4804
|
-
*/
|
|
4805
|
-
declare type DownloadButtonVisibilityChangedEvent = BaseEvent_5 & {
|
|
4806
|
-
type: 'download-button-visibility-changed';
|
|
4807
|
-
/**
|
|
4808
|
-
* True if the download button should be displayed, false if it should be hidden.
|
|
4809
|
-
*/
|
|
4810
|
-
visible: boolean;
|
|
4811
|
-
};
|
|
4812
|
-
|
|
4813
4678
|
/**
|
|
4814
4679
|
* Metadata returned from a preload script download request.
|
|
4815
4680
|
*
|
|
@@ -4869,7 +4734,6 @@ declare type DownloadRule = {
|
|
|
4869
4734
|
*
|
|
4870
4735
|
* @remarks This will control the styling for the download shelf regardless of whether its display was
|
|
4871
4736
|
* triggered by the window itself, or a view targeting the window.
|
|
4872
|
-
* @deprecated Use the DownloadBubble API instead.
|
|
4873
4737
|
*/
|
|
4874
4738
|
declare type DownloadShelfOptions = {
|
|
4875
4739
|
/**
|
|
@@ -4905,7 +4769,6 @@ declare type DownloadShelfOptions = {
|
|
|
4905
4769
|
* Generated when the visibility of the window's download shelf changes.
|
|
4906
4770
|
*
|
|
4907
4771
|
* @interface
|
|
4908
|
-
* @deprecated use DownloadBubble API instead
|
|
4909
4772
|
*/
|
|
4910
4773
|
declare type DownloadShelfVisibilityChangedEvent = BaseEvent_5 & {
|
|
4911
4774
|
type: 'download-shelf-visibility-changed';
|
|
@@ -4977,11 +4840,20 @@ declare class EmitterBase<EmitterEvent extends BaseEvent, EmitterEventType exten
|
|
|
4977
4840
|
type: EventType;
|
|
4978
4841
|
}>, ...args: any[]) => boolean;
|
|
4979
4842
|
private hasEmitter;
|
|
4843
|
+
/**
|
|
4844
|
+
* Cleans up after removal of a listener, e.g. deleting any lingering deregistration handlers for a
|
|
4845
|
+
* `once` subscription.
|
|
4846
|
+
*
|
|
4847
|
+
* @remarks Implementing this as a `removeListener` handler ensures that direct removal of a listener
|
|
4848
|
+
* on the base emitter will not leak additional core handlers. We could do this in the forwarding method,
|
|
4849
|
+
* which would involve less "magic," but would be more-vulnerable to accidental re-introduction of a leak.
|
|
4850
|
+
*/
|
|
4851
|
+
private cleanUpRemovedListener;
|
|
4980
4852
|
private getOrCreateEmitter;
|
|
4981
4853
|
listeners: (type: string | symbol) => Function[];
|
|
4982
4854
|
listenerCount: (type: string | symbol) => number;
|
|
4983
4855
|
protected registerEventListener: (eventType: EmitterEventType, options: OpenFin.SubscriptionOptions | undefined, applySubscription: (emitter: EventEmitter) => void, undoSubscription: (emitter: EventEmitter) => void) => Promise<void>;
|
|
4984
|
-
|
|
4856
|
+
protected deregisterEventListener: (eventType: EmitterEventType, options?: OpenFin.SubscriptionOptions) => Promise<void | EventEmitter>;
|
|
4985
4857
|
/**
|
|
4986
4858
|
* Adds a listener to the end of the listeners array for the specified event.
|
|
4987
4859
|
*
|
|
@@ -5017,7 +4889,7 @@ declare class EmitterBase<EmitterEvent extends BaseEvent, EmitterEventType exten
|
|
|
5017
4889
|
* @remarks Caution: Calling this method changes the array indices in the listener array behind the listener.
|
|
5018
4890
|
*/
|
|
5019
4891
|
removeListener<EventType extends EmitterEventType>(eventType: EventType, listener: EventHandler<EmitterEvent, EventType>, options?: OpenFin.SubscriptionOptions): Promise<this>;
|
|
5020
|
-
|
|
4892
|
+
protected deregisterAllListeners(eventType: EmitterEventType): Promise<EventEmitter | void>;
|
|
5021
4893
|
/**
|
|
5022
4894
|
* Removes all listeners, or those of the specified event.
|
|
5023
4895
|
*
|
|
@@ -5177,7 +5049,7 @@ declare type Event_10 = ApplicationEvents.Event | ApiReadyEvent | SnapshotApplie
|
|
|
5177
5049
|
* under the {@link OpenFin.SystemEvents} namespace (payloads inherited from propagated events are defined in the namespace
|
|
5178
5050
|
* from which they propagate).
|
|
5179
5051
|
*/
|
|
5180
|
-
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
|
|
5052
|
+
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;
|
|
5181
5053
|
|
|
5182
5054
|
/**
|
|
5183
5055
|
* [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.
|
|
@@ -6724,28 +6596,7 @@ declare type Hotkey = {
|
|
|
6724
6596
|
*/
|
|
6725
6597
|
keys: string;
|
|
6726
6598
|
/**
|
|
6727
|
-
*
|
|
6728
|
-
*
|
|
6729
|
-
* - `'capture'`: The hotkey fires **before** the event is sent to the renderer/page.
|
|
6730
|
-
* This is the only phase where the `preventDefault` property is effective.
|
|
6731
|
-
*
|
|
6732
|
-
* - `'bubble'`: The hotkey fires **after** the page has processed the key event.
|
|
6733
|
-
* This behaves exactly like a standard JavaScript event listener attached to the window:
|
|
6734
|
-
* 1. If the page calls `event.preventDefault()` (on either **keydown** or **keyup**), this hotkey will **not** fire.
|
|
6735
|
-
* 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.
|
|
6736
|
-
*
|
|
6737
|
-
* @default 'capture'
|
|
6738
|
-
*/
|
|
6739
|
-
phase?: 'capture' | 'bubble';
|
|
6740
|
-
/**
|
|
6741
|
-
* Determines if the event should continue to the renderer.
|
|
6742
|
-
*
|
|
6743
|
-
* - `true`: The event is consumed immediately. It will **never** reach the renderer/page.
|
|
6744
|
-
* - `false`: The event is sent to the renderer after this hotkey executes.
|
|
6745
|
-
*
|
|
6746
|
-
* @remarks
|
|
6747
|
-
* This property is **only valid** when `phase` is set to `'capture'`.
|
|
6748
|
-
* If `phase` is `'bubble'`, this property is ignored (as the renderer has already received and processed the event).
|
|
6599
|
+
* Prevent default key handling before emitting the event.
|
|
6749
6600
|
*
|
|
6750
6601
|
* @default false
|
|
6751
6602
|
*/
|
|
@@ -9224,7 +9075,7 @@ declare abstract class LayoutNode {
|
|
|
9224
9075
|
* Known Issue: If the number of views to add overflows the tab-container, the added views will be set as active
|
|
9225
9076
|
* during each render, and then placed at the front of the tab-stack, while the underlying order of tabs will remain unchanged.
|
|
9226
9077
|
* This means the views you pass to createAdjacentStack() may not render in the order given by the array.
|
|
9227
|
-
*
|
|
9078
|
+
* Until fixed, this problem can be avoided only if your window is wide enough to fit creating all the views in the tabstack.
|
|
9228
9079
|
*
|
|
9229
9080
|
* @param views The views that will populate the new TabStack.
|
|
9230
9081
|
* @param options Additional options that control new TabStack creation.
|
|
@@ -9399,42 +9250,6 @@ declare type LayoutOptions = {
|
|
|
9399
9250
|
* @defaultValue false
|
|
9400
9251
|
*/
|
|
9401
9252
|
disableTabOverflowDropdown?: boolean;
|
|
9402
|
-
/**
|
|
9403
|
-
* When set to 'scroll', enables horizontal scrolling of tabs when they overflow the stack width.
|
|
9404
|
-
* When set to 'dropdown', the default behavior occurs, in which excess tabs appear in a menu.
|
|
9405
|
-
*
|
|
9406
|
-
* Setting this to `scroll` might break styles written for the default dropdown behavior, as it significantly changes the DOM structure and CSS of tabs.
|
|
9407
|
-
*
|
|
9408
|
-
* The DOM structure is modified in this way:
|
|
9409
|
-
* - `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.
|
|
9410
|
-
* - the `.newTabButton` (if enabled) is a direct child of `.lm_header`
|
|
9411
|
-
*
|
|
9412
|
-
* **The following CSS variables are available to customize tab appearance:**
|
|
9413
|
-
*
|
|
9414
|
-
* - `--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`
|
|
9415
|
-
* - `--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).
|
|
9416
|
-
* - `--layout-tab-overflow-fade-size`: The width of the scroll shadows when tabs are overflowing. Default: `20px`
|
|
9417
|
-
* - `--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.
|
|
9418
|
-
*
|
|
9419
|
-
* **CSS Variables for advanced customization (dynamically updated and set on `lm_tabs`):**
|
|
9420
|
-
*
|
|
9421
|
-
* - `--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.
|
|
9422
|
-
* - `--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.
|
|
9423
|
-
* - `--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.
|
|
9424
|
-
*
|
|
9425
|
-
* @example
|
|
9426
|
-
* ```css
|
|
9427
|
-
* .lm_tabs {
|
|
9428
|
-
* --layout-tab-width: 200px;
|
|
9429
|
-
* --layout-tab-min-width: 100px;
|
|
9430
|
-
* --layout-tab-overflow-fade-size: 20px;
|
|
9431
|
-
* --layout-tab-overflow-shadow-color: rgba(0, 0, 0, 0.3);
|
|
9432
|
-
* }
|
|
9433
|
-
* ```
|
|
9434
|
-
*
|
|
9435
|
-
* @defaultValue 'dropdown'
|
|
9436
|
-
*/
|
|
9437
|
-
tabOverflowBehavior?: 'dropdown' | 'scroll';
|
|
9438
9253
|
};
|
|
9439
9254
|
/**
|
|
9440
9255
|
* Content of the layout. There can only be one top-level LayoutItem in the content array.
|
|
@@ -9542,43 +9357,6 @@ declare type LogInfo = {
|
|
|
9542
9357
|
*/
|
|
9543
9358
|
declare type LogLevel = 'verbose' | 'info' | 'warning' | 'error' | 'fatal';
|
|
9544
9359
|
|
|
9545
|
-
declare type LogPath = 'debug.log' | 'app.log';
|
|
9546
|
-
|
|
9547
|
-
declare type LogTarget = {
|
|
9548
|
-
type: LogPath;
|
|
9549
|
-
};
|
|
9550
|
-
|
|
9551
|
-
/**
|
|
9552
|
-
* Log types
|
|
9553
|
-
*
|
|
9554
|
-
* Note: For the debug log options, the one with the most specific matching pattern will be used.
|
|
9555
|
-
*/
|
|
9556
|
-
declare type LogTypes =
|
|
9557
|
-
/**
|
|
9558
|
-
* Uploads app logs
|
|
9559
|
-
*/
|
|
9560
|
-
'app'
|
|
9561
|
-
/**
|
|
9562
|
-
* Uploads rvm logs
|
|
9563
|
-
*/
|
|
9564
|
-
| 'rvm'
|
|
9565
|
-
/**
|
|
9566
|
-
* Uploads all debug logs
|
|
9567
|
-
*/
|
|
9568
|
-
| 'debug'
|
|
9569
|
-
/**
|
|
9570
|
-
* Uploads the most current debug log the current application
|
|
9571
|
-
*/
|
|
9572
|
-
| 'debug:self'
|
|
9573
|
-
/**
|
|
9574
|
-
* Uploads all debug logs for the current application
|
|
9575
|
-
*/
|
|
9576
|
-
| 'debug:self:archive'
|
|
9577
|
-
/**
|
|
9578
|
-
* Uploads the last two debug logs for the current application
|
|
9579
|
-
*/
|
|
9580
|
-
| 'debug:self:archive:last';
|
|
9581
|
-
|
|
9582
9360
|
/**
|
|
9583
9361
|
* Options for the Log Uploader.
|
|
9584
9362
|
*/
|
|
@@ -9647,12 +9425,8 @@ declare type LogUploadOptions = {
|
|
|
9647
9425
|
* An array of strings that specifies which logs should be uploaded.
|
|
9648
9426
|
* @defaultValue ['app', 'rvm', 'debug']
|
|
9649
9427
|
*/
|
|
9650
|
-
logs?:
|
|
9428
|
+
logs?: string[];
|
|
9651
9429
|
ui?: LogUploaderUIOptions;
|
|
9652
|
-
/**
|
|
9653
|
-
* Max file size limit in Megabytes for the logs archive.
|
|
9654
|
-
*/
|
|
9655
|
-
sizeLimit?: number;
|
|
9656
9430
|
};
|
|
9657
9431
|
|
|
9658
9432
|
/**
|
|
@@ -9690,10 +9464,6 @@ declare type Manifest = {
|
|
|
9690
9464
|
forceLatest?: boolean;
|
|
9691
9465
|
futureVersion?: string;
|
|
9692
9466
|
version: string;
|
|
9693
|
-
policies?: {
|
|
9694
|
-
CloudAPAuthEnabled?: 'enabled' | 'disabled';
|
|
9695
|
-
};
|
|
9696
|
-
themePalette?: Array<ThemePalette>;
|
|
9697
9467
|
};
|
|
9698
9468
|
services?: string[];
|
|
9699
9469
|
shortcut?: {
|
|
@@ -10071,10 +9841,6 @@ declare type MutableViewOptions = {
|
|
|
10071
9841
|
* {@inheritDoc ChromiumPolicies}
|
|
10072
9842
|
*/
|
|
10073
9843
|
chromiumPolicies: ChromiumPolicies;
|
|
10074
|
-
/**
|
|
10075
|
-
* Specifies the AppLogLevel for the specified View. See {@link AppLogLevel} for more information.
|
|
10076
|
-
*/
|
|
10077
|
-
appLogLevel?: AppLogLevel;
|
|
10078
9844
|
};
|
|
10079
9845
|
|
|
10080
9846
|
/**
|
|
@@ -10181,12 +9947,10 @@ declare type MutableWindowOptions = {
|
|
|
10181
9947
|
*/
|
|
10182
9948
|
customData: any;
|
|
10183
9949
|
/**
|
|
9950
|
+
* @deprecated Will be removed in runtime version 45
|
|
10184
9951
|
*
|
|
10185
9952
|
* Show the window's frame.
|
|
10186
9953
|
*
|
|
10187
|
-
* @remarks
|
|
10188
|
-
* This property will not be updatable starting runtime version 45.
|
|
10189
|
-
*
|
|
10190
9954
|
* @default true
|
|
10191
9955
|
*/
|
|
10192
9956
|
frame: boolean;
|
|
@@ -10359,10 +10123,6 @@ declare type MutableWindowOptions = {
|
|
|
10359
10123
|
* {@inheritDoc ChromiumPolicies}
|
|
10360
10124
|
*/
|
|
10361
10125
|
chromiumPolicies: ChromiumPolicies;
|
|
10362
|
-
/**
|
|
10363
|
-
* Specifies the AppLogLevel for the Window. See {@link AppLogLevel} for more information.
|
|
10364
|
-
*/
|
|
10365
|
-
appLogLevel?: AppLogLevel;
|
|
10366
10126
|
};
|
|
10367
10127
|
|
|
10368
10128
|
declare type NackHandler = (payloadOrMessage: RuntimeErrorPayload | string) => void;
|
|
@@ -10375,78 +10135,6 @@ declare type NamedEvent = IdentityEvent & {
|
|
|
10375
10135
|
name: string;
|
|
10376
10136
|
};
|
|
10377
10137
|
|
|
10378
|
-
/**
|
|
10379
|
-
* @interface
|
|
10380
|
-
*
|
|
10381
|
-
* Represents the native theme of the operating system.
|
|
10382
|
-
* This is used to determine how the application should render its UI based on the system's theme settings.
|
|
10383
|
-
* Defer to CSS properties whenever possible.
|
|
10384
|
-
*
|
|
10385
|
-
* Re-exported from Electron's `NativeTheme` type.
|
|
10386
|
-
*/
|
|
10387
|
-
declare type NativeTheme = {
|
|
10388
|
-
/**
|
|
10389
|
-
* A `boolean` indicating whether Chromium is in forced colors mode, controlled by
|
|
10390
|
-
* system accessibility settings. Currently, Windows high contrast is the only
|
|
10391
|
-
* system setting that triggers forced colors mode.
|
|
10392
|
-
*
|
|
10393
|
-
* @platform win32
|
|
10394
|
-
*/
|
|
10395
|
-
inForcedColorsMode: boolean;
|
|
10396
|
-
/**
|
|
10397
|
-
* A `boolean` that indicates the whether the user has chosen via system
|
|
10398
|
-
* accessibility settings to reduce transparency at the OS level.
|
|
10399
|
-
*
|
|
10400
|
-
*/
|
|
10401
|
-
prefersReducedTransparency: boolean;
|
|
10402
|
-
/**
|
|
10403
|
-
* A `boolean` for if the OS / Chromium currently has a dark mode enabled or is
|
|
10404
|
-
* being instructed to show a dark-style UI. If you want to modify this value you
|
|
10405
|
-
* should use `themeSource` below.
|
|
10406
|
-
*
|
|
10407
|
-
*/
|
|
10408
|
-
shouldUseDarkColors: boolean;
|
|
10409
|
-
/**
|
|
10410
|
-
* A `boolean` property indicating whether or not the system theme has been set to
|
|
10411
|
-
* dark or light.
|
|
10412
|
-
*
|
|
10413
|
-
* On Windows this property distinguishes between system and app light/dark theme,
|
|
10414
|
-
* returning `true` if the system theme is set to dark theme and `false` otherwise.
|
|
10415
|
-
* On macOS the return value will be the same as `nativeTheme.shouldUseDarkColors`.
|
|
10416
|
-
*
|
|
10417
|
-
* @platform darwin,win32
|
|
10418
|
-
*/
|
|
10419
|
-
shouldUseDarkColorsForSystemIntegratedUI: boolean;
|
|
10420
|
-
/**
|
|
10421
|
-
* A `boolean` for if the OS / Chromium currently has high-contrast mode enabled or
|
|
10422
|
-
* is being instructed to show a high-contrast UI.
|
|
10423
|
-
*
|
|
10424
|
-
* @platform darwin,win32
|
|
10425
|
-
*/
|
|
10426
|
-
shouldUseHighContrastColors: boolean;
|
|
10427
|
-
/**
|
|
10428
|
-
* A `boolean` for if the OS / Chromium currently has an inverted color scheme or
|
|
10429
|
-
* is being instructed to use an inverted color scheme.
|
|
10430
|
-
*
|
|
10431
|
-
* @platform darwin,win32
|
|
10432
|
-
*/
|
|
10433
|
-
shouldUseInvertedColorScheme: boolean;
|
|
10434
|
-
/**
|
|
10435
|
-
* A `string` property that can be `system`, `light` or `dark`. It is used (via `setTheme) to
|
|
10436
|
-
* override and supersede the value that Chromium has chosen to use internally.
|
|
10437
|
-
*/
|
|
10438
|
-
themeSource: 'system' | 'light' | 'dark';
|
|
10439
|
-
};
|
|
10440
|
-
|
|
10441
|
-
/**
|
|
10442
|
-
* Generated when the operating system's theme preferences change.
|
|
10443
|
-
* Occurs when dark mode, high contrast mode, or inverted color scheme settings are modified.
|
|
10444
|
-
*/
|
|
10445
|
-
declare type NativeThemeUpdatedEvent = BaseEvent_9 & {
|
|
10446
|
-
type: 'native-theme-updated';
|
|
10447
|
-
theme: OpenFin.NativeTheme;
|
|
10448
|
-
};
|
|
10449
|
-
|
|
10450
10138
|
/**
|
|
10451
10139
|
* @interface
|
|
10452
10140
|
*/
|
|
@@ -10745,9 +10433,6 @@ declare namespace OpenFin {
|
|
|
10745
10433
|
CustomProtocolOptions,
|
|
10746
10434
|
InteropBrokerOptions,
|
|
10747
10435
|
ContextGroupInfo,
|
|
10748
|
-
AnchorLocation,
|
|
10749
|
-
Anchor,
|
|
10750
|
-
DownloadBubbleOptions,
|
|
10751
10436
|
DisplayMetadata,
|
|
10752
10437
|
LegacyWinOptionsInAppOptions,
|
|
10753
10438
|
Snapshot,
|
|
@@ -10774,9 +10459,6 @@ declare namespace OpenFin {
|
|
|
10774
10459
|
InheritableOptions,
|
|
10775
10460
|
PolicyOptions,
|
|
10776
10461
|
ChromiumPolicies,
|
|
10777
|
-
AppLogLevel,
|
|
10778
|
-
LogPath,
|
|
10779
|
-
LogTarget,
|
|
10780
10462
|
MutableWindowOptions,
|
|
10781
10463
|
WorkspacePlatformOptions,
|
|
10782
10464
|
WebRequestHeader,
|
|
@@ -10852,16 +10534,10 @@ declare namespace OpenFin {
|
|
|
10852
10534
|
PlatformOptions,
|
|
10853
10535
|
LogUploaderOptions,
|
|
10854
10536
|
LogUploaderUIOptions,
|
|
10855
|
-
LogTypes,
|
|
10856
10537
|
LogUploadOptions,
|
|
10857
|
-
ThemeColorsMap,
|
|
10858
|
-
ThemeColorId,
|
|
10859
|
-
ThemePalette,
|
|
10860
10538
|
Manifest,
|
|
10861
10539
|
LayoutContent,
|
|
10862
10540
|
LayoutItemConfig,
|
|
10863
|
-
ThemePreferences,
|
|
10864
|
-
NativeTheme,
|
|
10865
10541
|
LayoutRow,
|
|
10866
10542
|
LayoutColumn,
|
|
10867
10543
|
LayoutComponent,
|
|
@@ -11081,7 +10757,6 @@ declare namespace OpenFin {
|
|
|
11081
10757
|
ChannelProviderDisconnectionListener,
|
|
11082
10758
|
RoutingInfo,
|
|
11083
10759
|
DownloadShelfOptions,
|
|
11084
|
-
SnapZoneOptions,
|
|
11085
10760
|
ViewShowAtOptions,
|
|
11086
10761
|
WebNotificationProperties,
|
|
11087
10762
|
WebNotificationInfo,
|
|
@@ -11356,11 +11031,6 @@ declare type PerDomainSettings = {
|
|
|
11356
11031
|
*/
|
|
11357
11032
|
drag?: 'allow' | 'block';
|
|
11358
11033
|
};
|
|
11359
|
-
/**
|
|
11360
|
-
* Allows the app log level of any matching content to be overriden.
|
|
11361
|
-
* See also {@link AppLogLevel} for more information.
|
|
11362
|
-
*/
|
|
11363
|
-
appLogLevel?: AppLogLevel;
|
|
11364
11034
|
};
|
|
11365
11035
|
|
|
11366
11036
|
/**
|
|
@@ -13081,7 +12751,7 @@ declare type PositioningOptions = {
|
|
|
13081
12751
|
/**
|
|
13082
12752
|
* Context menu item with an implementation provided by OpenFin.
|
|
13083
12753
|
*/
|
|
13084
|
-
declare type PrebuiltContextMenuItem = 'separator' | 'undo' | 'redo' | 'cut' | 'copy' | 'copyImage' | 'paste' | 'selectAll' | 'spellCheck' | 'inspect' | 'reload' | 'navigateForward' | 'navigateBack' | 'print'
|
|
12754
|
+
declare type PrebuiltContextMenuItem = 'separator' | 'undo' | 'redo' | 'cut' | 'copy' | 'copyImage' | 'paste' | 'selectAll' | 'spellCheck' | 'inspect' | 'reload' | 'navigateForward' | 'navigateBack' | 'print';
|
|
13085
12755
|
|
|
13086
12756
|
/**
|
|
13087
12757
|
* A script that is run before page load.
|
|
@@ -13779,12 +13449,6 @@ declare type ProtocolMap = ExternalAdapterOnlyCallsMap & AnalyticsProtocolMap &
|
|
|
13779
13449
|
'create-window': VoidCall;
|
|
13780
13450
|
'get-current-window': VoidCall;
|
|
13781
13451
|
'get-current-window-sync': VoidCall;
|
|
13782
|
-
'show-download-bubble': IdentityCall<{
|
|
13783
|
-
anchor?: OpenFin.Anchor;
|
|
13784
|
-
}, void>;
|
|
13785
|
-
'update-download-bubble-anchor': IdentityCall<{
|
|
13786
|
-
anchor: OpenFin.Anchor;
|
|
13787
|
-
}, void>;
|
|
13788
13452
|
'get-external-application-info': ApiCall<OpenFin.ApplicationIdentity, OpenFin.ExternalApplicationInfo>;
|
|
13789
13453
|
'external-application-wrap': VoidCall;
|
|
13790
13454
|
'external-application-wrap-sync': VoidCall;
|
|
@@ -13881,10 +13545,6 @@ declare type ProtocolMap = ExternalAdapterOnlyCallsMap & AnalyticsProtocolMap &
|
|
|
13881
13545
|
request: any;
|
|
13882
13546
|
response: any;
|
|
13883
13547
|
};
|
|
13884
|
-
'set-theme-preferences': ApiCall<{
|
|
13885
|
-
preferences: OpenFin.ThemePreferences;
|
|
13886
|
-
}, OpenFin.NativeTheme>;
|
|
13887
|
-
'get-theme-preferences': GetterCall<OpenFin.NativeTheme>;
|
|
13888
13548
|
'get-version': GetterCall<string>;
|
|
13889
13549
|
'clear-cache': ApiCall<OpenFin.ClearCacheOption, void>;
|
|
13890
13550
|
'delete-cache-request': VoidCall;
|
|
@@ -13972,9 +13632,6 @@ declare type ProtocolMap = ExternalAdapterOnlyCallsMap & AnalyticsProtocolMap &
|
|
|
13972
13632
|
'write-to-log': ApiCall<{
|
|
13973
13633
|
level: string;
|
|
13974
13634
|
message: string;
|
|
13975
|
-
target?: {
|
|
13976
|
-
type?: 'app.log' | 'debug.log';
|
|
13977
|
-
};
|
|
13978
13635
|
}, void>;
|
|
13979
13636
|
'open-url-with-browser': ApiCall<{
|
|
13980
13637
|
url: string;
|
|
@@ -14138,15 +13795,6 @@ declare type ProtocolMap = ExternalAdapterOnlyCallsMap & AnalyticsProtocolMap &
|
|
|
14138
13795
|
request: void;
|
|
14139
13796
|
response: OpenFin.ExtensionInfo[];
|
|
14140
13797
|
};
|
|
14141
|
-
'set-theme-palette': ApiCall<{
|
|
14142
|
-
themePalette: Array<OpenFin.ThemePalette>;
|
|
14143
|
-
}, void> & {
|
|
14144
|
-
themePalette: Array<OpenFin.ThemePalette>;
|
|
14145
|
-
};
|
|
14146
|
-
'get-theme-palette': ApiCall<void, Array<OpenFin.ThemePalette>> & {
|
|
14147
|
-
request: void;
|
|
14148
|
-
response: Array<OpenFin.ThemePalette>;
|
|
14149
|
-
};
|
|
14150
13798
|
'fdc3-add-context-listener': VoidCall;
|
|
14151
13799
|
'fdc3-add-intent-listener': VoidCall;
|
|
14152
13800
|
'fdc3-raise-intent': VoidCall;
|
|
@@ -15222,15 +14870,6 @@ declare type Size = TransitionBase & {
|
|
|
15222
14870
|
height: number;
|
|
15223
14871
|
};
|
|
15224
14872
|
|
|
15225
|
-
/**
|
|
15226
|
-
* Generated when a window is snapped to a screen edge.
|
|
15227
|
-
* @interface
|
|
15228
|
-
*/
|
|
15229
|
-
declare type SnappedEvent = BoundsEvent & {
|
|
15230
|
-
type: 'snapped';
|
|
15231
|
-
snapLocation: 'top' | 'bottom';
|
|
15232
|
-
};
|
|
15233
|
-
|
|
15234
14873
|
/**
|
|
15235
14874
|
* @interface
|
|
15236
14875
|
*/
|
|
@@ -15378,52 +15017,6 @@ declare class SnapshotSourceModule extends Base {
|
|
|
15378
15017
|
wrap(identity: OpenFin.ApplicationIdentity): Promise<SnapshotSource>;
|
|
15379
15018
|
}
|
|
15380
15019
|
|
|
15381
|
-
/**
|
|
15382
|
-
* Generated when a window enters or exits a snap zone during drag.
|
|
15383
|
-
* This event fires whenever the snap zone state changes (entry or exit).
|
|
15384
|
-
* @interface
|
|
15385
|
-
*/
|
|
15386
|
-
declare type SnapZoneChangedEvent = BaseEvent_5 & {
|
|
15387
|
-
type: 'snap-zone-changed';
|
|
15388
|
-
/**
|
|
15389
|
-
* Array of locations that the window is currently in snap zones for.
|
|
15390
|
-
* Empty array indicates the window is not in any snap zone.
|
|
15391
|
-
* Can contain multiple locations if the window is in multiple zones simultaneously.
|
|
15392
|
-
*/
|
|
15393
|
-
locations: Array<'top' | 'bottom'>;
|
|
15394
|
-
};
|
|
15395
|
-
|
|
15396
|
-
/**
|
|
15397
|
-
* @interface
|
|
15398
|
-
*
|
|
15399
|
-
* Configures snap zone behavior for a window. When enabled, the window will automatically snap to screen edges
|
|
15400
|
-
* when dragged near them during user drag interactions.
|
|
15401
|
-
*/
|
|
15402
|
-
declare type SnapZoneOptions = {
|
|
15403
|
-
/**
|
|
15404
|
-
* Whether snap zone functionality is enabled for this window.
|
|
15405
|
-
*
|
|
15406
|
-
* @default false
|
|
15407
|
-
*/
|
|
15408
|
-
enabled: boolean;
|
|
15409
|
-
/**
|
|
15410
|
-
* The distance in pixels from the screen edge that triggers the snap zone.
|
|
15411
|
-
* When the window is dragged within this threshold of the top or bottom edge,
|
|
15412
|
-
* it will be considered in a snap zone.
|
|
15413
|
-
*
|
|
15414
|
-
* @default 50
|
|
15415
|
-
*/
|
|
15416
|
-
threshold?: number;
|
|
15417
|
-
/**
|
|
15418
|
-
* Ordered array of edge preferences when the window is in multiple snap zones simultaneously.
|
|
15419
|
-
* The first edge in the array that the window is in will be used for snapping.
|
|
15420
|
-
* If not provided, defaults to ['top', 'bottom'] (preferring top over bottom).
|
|
15421
|
-
*
|
|
15422
|
-
* @default ['top', 'bottom']
|
|
15423
|
-
*/
|
|
15424
|
-
locationPreference?: Array<'top' | 'bottom'>;
|
|
15425
|
-
};
|
|
15426
|
-
|
|
15427
15020
|
/**
|
|
15428
15021
|
* Generated when an application has started.
|
|
15429
15022
|
* @interface
|
|
@@ -16204,14 +15797,13 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
|
|
|
16204
15797
|
* Writes the passed message into both the log file and the console.
|
|
16205
15798
|
* @param level The log level for the entry. Can be either "info", "warning" or "error"
|
|
16206
15799
|
* @param message The log message text
|
|
16207
|
-
* @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.
|
|
16208
15800
|
*
|
|
16209
15801
|
* @example
|
|
16210
15802
|
* ```js
|
|
16211
|
-
* fin.System.log("info", "An example log message"
|
|
15803
|
+
* fin.System.log("info", "An example log message").then(() => console.log('Log info message')).catch(err => console.log(err));
|
|
16212
15804
|
* ```
|
|
16213
15805
|
*/
|
|
16214
|
-
log(level: string, message: string
|
|
15806
|
+
log(level: string, message: string): Promise<void>;
|
|
16215
15807
|
/**
|
|
16216
15808
|
* Opens the passed URL in the default web browser.
|
|
16217
15809
|
*
|
|
@@ -16950,123 +16542,11 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
|
|
|
16950
16542
|
* Not indended for general use, will be used by the `@openfin/workspace-platform` package.
|
|
16951
16543
|
*/
|
|
16952
16544
|
serveAsset(options: OpenFin.ServeAssetOptions): Promise<OpenFin.ServedAssetInfo>;
|
|
16953
|
-
/**
|
|
16954
|
-
* Get's the native theme preferences for the current runtime.
|
|
16955
|
-
* Prefer css media-queries wherever possible, but this can be useful to see if the system setting has been overridden.
|
|
16956
|
-
* See @link OpenFin.NativeTheme for more information.
|
|
16957
|
-
* @example Theme selector menu
|
|
16958
|
-
* ```ts
|
|
16959
|
-
async function handleThemeMenu(e: React.MouseEvent<HTMLDivElement>) {
|
|
16960
|
-
const currentTheme = await fin.System.getThemePreferences();
|
|
16961
|
-
const result = await (fin.me as OpenFin.Window).showPopupMenu({
|
|
16962
|
-
x: e.clientX,
|
|
16963
|
-
y: e.clientY,
|
|
16964
|
-
template: [
|
|
16965
|
-
{
|
|
16966
|
-
label: 'Light',
|
|
16967
|
-
type: 'checkbox',
|
|
16968
|
-
checked: currentTheme.themeSource === 'light',
|
|
16969
|
-
data: { themeSource: 'light' } as const
|
|
16970
|
-
},
|
|
16971
|
-
{
|
|
16972
|
-
label: 'Dark',
|
|
16973
|
-
type: 'checkbox',
|
|
16974
|
-
checked: currentTheme.themeSource === 'dark',
|
|
16975
|
-
data: { themeSource: 'dark' } as const
|
|
16976
|
-
},
|
|
16977
|
-
{
|
|
16978
|
-
label: 'System',
|
|
16979
|
-
type: 'checkbox',
|
|
16980
|
-
checked: currentTheme.themeSource === 'system',
|
|
16981
|
-
data: { themeSource: 'system' } as const
|
|
16982
|
-
}
|
|
16983
|
-
]
|
|
16984
|
-
});
|
|
16985
|
-
if (result.result === 'clicked') {
|
|
16986
|
-
await fin.System.setThemePreferences(result.data);
|
|
16987
|
-
}
|
|
16988
|
-
}
|
|
16989
|
-
```
|
|
16990
|
-
*/
|
|
16991
|
-
getThemePreferences(): Promise<OpenFin.NativeTheme>;
|
|
16992
|
-
/**
|
|
16993
|
-
* Sets the native theme preferences for the current runtime.
|
|
16994
|
-
* Can be used to force runtime-wide light or dark mode.
|
|
16995
|
-
* @important Due to this impacting all applications on a runtime, this method is only usable if a security realm has been set.
|
|
16996
|
-
* @example Theme selector menu
|
|
16997
|
-
* ```ts
|
|
16998
|
-
async function handleThemeMenu(e: React.MouseEvent<HTMLDivElement>) {
|
|
16999
|
-
const currentTheme = await fin.System.getThemePreferences();
|
|
17000
|
-
const result = await (fin.me as OpenFin.Window).showPopupMenu({
|
|
17001
|
-
x: e.clientX,
|
|
17002
|
-
y: e.clientY,
|
|
17003
|
-
template: [
|
|
17004
|
-
{
|
|
17005
|
-
label: 'Light',
|
|
17006
|
-
type: 'checkbox',
|
|
17007
|
-
checked: currentTheme.themeSource === 'light',
|
|
17008
|
-
data: { themeSource: 'light' } as const
|
|
17009
|
-
},
|
|
17010
|
-
{
|
|
17011
|
-
label: 'Dark',
|
|
17012
|
-
type: 'checkbox',
|
|
17013
|
-
checked: currentTheme.themeSource === 'dark',
|
|
17014
|
-
data: { themeSource: 'dark' } as const
|
|
17015
|
-
},
|
|
17016
|
-
{
|
|
17017
|
-
label: 'System',
|
|
17018
|
-
type: 'checkbox',
|
|
17019
|
-
checked: currentTheme.themeSource === 'system',
|
|
17020
|
-
data: { themeSource: 'system' } as const
|
|
17021
|
-
}
|
|
17022
|
-
]
|
|
17023
|
-
});
|
|
17024
|
-
if (result.result === 'clicked') {
|
|
17025
|
-
await fin.System.setThemePreferences(result.data);
|
|
17026
|
-
}
|
|
17027
|
-
}
|
|
17028
|
-
```
|
|
17029
|
-
*/
|
|
17030
|
-
setThemePreferences(preferences: OpenFin.ThemePreferences): Promise<OpenFin.ThemePreferences>;
|
|
17031
16545
|
/**
|
|
17032
16546
|
* Launches the Log Uploader. Full documentation can be found [here](https://resources.here.io/docs/core/develop/debug/log-uploader/).
|
|
17033
16547
|
* @experimental
|
|
17034
16548
|
*/
|
|
17035
16549
|
launchLogUploader(options: OpenFin.LogUploaderOptions): Promise<void>;
|
|
17036
|
-
/**
|
|
17037
|
-
* Overrides original Chromium theme color providers matching key (currently except high contrast ones). Only colors passed in the map will be overridden.
|
|
17038
|
-
* @param overrides - Array of ColorProviderOverrides objects
|
|
17039
|
-
* @example
|
|
17040
|
-
* ```ts
|
|
17041
|
-
* await fin.System.setThemePalette([
|
|
17042
|
-
* {
|
|
17043
|
-
* colorProviderKey: { colorMode: 'light' },
|
|
17044
|
-
* colorsMap: {
|
|
17045
|
-
* kColorLabelForeground: 4278190080,
|
|
17046
|
-
* kColorBubbleBackground: 4293980400
|
|
17047
|
-
* }
|
|
17048
|
-
* },
|
|
17049
|
-
* {
|
|
17050
|
-
* colorProviderKey: { colorMode: 'dark' },
|
|
17051
|
-
* colorsMap: {
|
|
17052
|
-
* kColorLabelForeground: 4293980400,
|
|
17053
|
-
* kColorBubbleBackground: 4293980400
|
|
17054
|
-
* }
|
|
17055
|
-
* }
|
|
17056
|
-
* ]);
|
|
17057
|
-
* ```
|
|
17058
|
-
*/
|
|
17059
|
-
setThemePalette(themePalette: Array<OpenFin.ThemePalette>): Promise<void>;
|
|
17060
|
-
/**
|
|
17061
|
-
* Retrieves currently used color overrides
|
|
17062
|
-
* @returns Array of ColorProviderOverrides objects
|
|
17063
|
-
* @example
|
|
17064
|
-
* ```ts
|
|
17065
|
-
* const themePalette = await fin.System.getThemePalette();
|
|
17066
|
-
* console.log(themePalette);
|
|
17067
|
-
* ```
|
|
17068
|
-
*/
|
|
17069
|
-
getThemePalette(): Promise<Array<OpenFin.ThemePalette>>;
|
|
17070
16550
|
}
|
|
17071
16551
|
|
|
17072
16552
|
/**
|
|
@@ -17105,8 +16585,6 @@ declare namespace SystemEvents {
|
|
|
17105
16585
|
ExtensionsInstallFailedEvent,
|
|
17106
16586
|
ExtensionInstallFailedEvent,
|
|
17107
16587
|
ExtensionsInitializationFailedEvent,
|
|
17108
|
-
ThemePaletteChangedEvent,
|
|
17109
|
-
NativeThemeUpdatedEvent,
|
|
17110
16588
|
Event_11 as Event,
|
|
17111
16589
|
SystemEvent,
|
|
17112
16590
|
EventType_8 as EventType,
|
|
@@ -17237,7 +16715,6 @@ declare class TabStack extends LayoutNode {
|
|
|
17237
16715
|
* and rendered at the front of the tab-stack, while the underlying order of tabs will remain unchanged.
|
|
17238
16716
|
* If that happens and then getViews() is called, it will return the identities in a different order than
|
|
17239
16717
|
* than the currently rendered tab order.
|
|
17240
|
-
* Note: This issue does not occur when using `tabOverflowBehavior: 'scroll'` in the layout configuration.
|
|
17241
16718
|
*
|
|
17242
16719
|
*
|
|
17243
16720
|
* @throws If the {@link TabStack} has been destroyed.
|
|
@@ -17262,7 +16739,6 @@ declare class TabStack extends LayoutNode {
|
|
|
17262
16739
|
*
|
|
17263
16740
|
* @remarks Known Issue: If adding a view overflows the tab-container, the added view will be set as active
|
|
17264
16741
|
* and rendered at the front of the tab-stack, while the underlying order of tabs will remain unchanged.
|
|
17265
|
-
* Note: This issue does not occur when using `tabOverflowBehavior: 'scroll'` in the layout configuration.
|
|
17266
16742
|
*
|
|
17267
16743
|
* @param view The identity of an existing view to add, or options to create a view.
|
|
17268
16744
|
* @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)
|
|
@@ -17384,109 +16860,6 @@ declare type TerminateExternalRequestType = {
|
|
|
17384
16860
|
killTree: boolean;
|
|
17385
16861
|
};
|
|
17386
16862
|
|
|
17387
|
-
/**
|
|
17388
|
-
* String literal type of all supported theme color IDs.
|
|
17389
|
-
* Useful wherever you need to refer to a color slot by name.
|
|
17390
|
-
* @interface
|
|
17391
|
-
*/
|
|
17392
|
-
declare type ThemeColorId = keyof ThemeColorsMap;
|
|
17393
|
-
|
|
17394
|
-
/**
|
|
17395
|
-
* All supported color slots for the Download Bubble and related UI.
|
|
17396
|
-
* @interface
|
|
17397
|
-
*/
|
|
17398
|
-
declare interface ThemeColorsMap {
|
|
17399
|
-
/**
|
|
17400
|
-
* Enterprise/Window/Background – bubble header and footer background.
|
|
17401
|
-
*/
|
|
17402
|
-
kColorBubbleBackground?: number;
|
|
17403
|
-
/**
|
|
17404
|
-
* Windows only – Enterprise/Window/Border.
|
|
17405
|
-
*/
|
|
17406
|
-
kColorBubbleBorder?: number;
|
|
17407
|
-
/**
|
|
17408
|
-
* Windows only – Enterprise/Window/Border (large shadow).
|
|
17409
|
-
*/
|
|
17410
|
-
kColorBubbleBorderShadowLarge?: number;
|
|
17411
|
-
/**
|
|
17412
|
-
* Windows only – Enterprise/Window/Border (small shadow).
|
|
17413
|
-
*/
|
|
17414
|
-
kColorBubbleBorderShadowSmall?: number;
|
|
17415
|
-
/**
|
|
17416
|
-
* Enterprise/Window/Background – downloaded item row background.
|
|
17417
|
-
*/
|
|
17418
|
-
kColorDialogBackground?: number;
|
|
17419
|
-
/**
|
|
17420
|
-
* Enterprise/Search Result/Background/Hover – download item row hover.
|
|
17421
|
-
*/
|
|
17422
|
-
kColorDownloadBubbleRowHover?: number;
|
|
17423
|
-
/**
|
|
17424
|
-
* Enterprise/Window/Icon – “Show all downloads” icon color.
|
|
17425
|
-
*/
|
|
17426
|
-
kColorDownloadBubbleShowAllDownloadsIcon?: number;
|
|
17427
|
-
/**
|
|
17428
|
-
* Enterprise/Search Result/Background/Hover – full download history
|
|
17429
|
-
* button (full row) hover background.
|
|
17430
|
-
*/
|
|
17431
|
-
kColorHoverButtonBackgroundHovered?: number;
|
|
17432
|
-
/**
|
|
17433
|
-
* Shared/Icon Button/Subtle/Icon/Default – SVG icon color
|
|
17434
|
-
* (except full download history button).
|
|
17435
|
-
*/
|
|
17436
|
-
kColorIcon?: number;
|
|
17437
|
-
/**
|
|
17438
|
-
* Enterprise/Window/Text/Base – main label text color.
|
|
17439
|
-
* May be post-processed to increase readability on kColorDialogBackground
|
|
17440
|
-
* (can be disabled via transparent kColorLabelBackground).
|
|
17441
|
-
*/
|
|
17442
|
-
kColorLabelForeground?: number;
|
|
17443
|
-
/**
|
|
17444
|
-
* Label background used for readability adjustment.
|
|
17445
|
-
* Set to transparent (0) to disable Chromium’s readability alignment logic.
|
|
17446
|
-
*/
|
|
17447
|
-
kColorLabelBackground?: number;
|
|
17448
|
-
/**
|
|
17449
|
-
* Enterprise/Window/Text/Soft – secondary text color.
|
|
17450
|
-
* May be post-processed to increase readability on kColorDialogBackground
|
|
17451
|
-
* (can be disabled via transparent kColorLabelBackground).
|
|
17452
|
-
*/
|
|
17453
|
-
kColorSecondaryForeground?: number;
|
|
17454
|
-
}
|
|
17455
|
-
|
|
17456
|
-
/**
|
|
17457
|
-
* Defines a set of color overrides for Chromium UI surfaces based on a theme
|
|
17458
|
-
* provider (e.g., light or dark mode).
|
|
17459
|
-
* @interface
|
|
17460
|
-
*/
|
|
17461
|
-
declare type ThemePalette = {
|
|
17462
|
-
/**
|
|
17463
|
-
* Identifies the color provider mode that the palette applies to.
|
|
17464
|
-
*/
|
|
17465
|
-
colorProviderKey: {
|
|
17466
|
-
/**
|
|
17467
|
-
* The UI color mode that this palette is intended to style.
|
|
17468
|
-
*/
|
|
17469
|
-
colorMode: 'light' | 'dark';
|
|
17470
|
-
};
|
|
17471
|
-
/**
|
|
17472
|
-
* A mapping of known Chromium color IDs to ARGB values (0xAARRGGBB).
|
|
17473
|
-
*/
|
|
17474
|
-
colorsMap: ThemeColorsMap;
|
|
17475
|
-
};
|
|
17476
|
-
|
|
17477
|
-
/**
|
|
17478
|
-
* An event that fires when the system theme palette is changed.
|
|
17479
|
-
*/
|
|
17480
|
-
declare type ThemePaletteChangedEvent = BaseEvent_9 & {
|
|
17481
|
-
type: 'theme-palette-changed';
|
|
17482
|
-
themePalette: OpenFin.ThemePalette;
|
|
17483
|
-
};
|
|
17484
|
-
|
|
17485
|
-
/**
|
|
17486
|
-
* Settable options for the native theme of the operating system.
|
|
17487
|
-
*/
|
|
17488
|
-
declare type ThemePreferences = Pick<NativeTheme, 'themeSource'>;
|
|
17489
|
-
|
|
17490
16863
|
/**
|
|
17491
16864
|
* @interface
|
|
17492
16865
|
*/
|
|
@@ -20820,62 +20193,6 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
|
|
|
20820
20193
|
* To print the views embedded in their page context, set `content` to `screenshot`.
|
|
20821
20194
|
*/
|
|
20822
20195
|
print(options?: OpenFin.WindowPrintOptions): Promise<void>;
|
|
20823
|
-
/**
|
|
20824
|
-
* Displays the download bubble UI. If an anchor is provided, the bubble
|
|
20825
|
-
* will be positioned according to the specified rectangle and anchor point.
|
|
20826
|
-
*
|
|
20827
|
-
* @param {OpenFin.Anchor} options
|
|
20828
|
-
* Anchor configuration used to position the download bubble. This includes
|
|
20829
|
-
* the bounding rectangle and the anchor location within that rectangle.
|
|
20830
|
-
*
|
|
20831
|
-
* @returns {Promise<void>}
|
|
20832
|
-
* A promise that resolves once the request to show the download bubble
|
|
20833
|
-
* has been processed.
|
|
20834
|
-
* @example
|
|
20835
|
-
* ```js
|
|
20836
|
-
* const w = fin.Window.getCurrentSync();
|
|
20837
|
-
* const el = document.getElementById("download-bubble-button");
|
|
20838
|
-
* const rect = el.getBoundingClientRect();
|
|
20839
|
-
* const anchor = {
|
|
20840
|
-
* bounds: rect,
|
|
20841
|
-
* location: "topRight"
|
|
20842
|
-
* };
|
|
20843
|
-
* w.showDownloadBubble(anchor);
|
|
20844
|
-
* ```
|
|
20845
|
-
*/
|
|
20846
|
-
showDownloadBubble(anchor?: OpenFin.Anchor): Promise<void>;
|
|
20847
|
-
/**
|
|
20848
|
-
* Updates the anchor used for positioning the download bubble. This allows
|
|
20849
|
-
* moving the bubble reactively—for example, in response to window resizes,
|
|
20850
|
-
* layout changes, or DOM element repositioning.
|
|
20851
|
-
*
|
|
20852
|
-
* @param {OpenFin.Anchor} options
|
|
20853
|
-
* New anchor configuration describing the updated position and anchor
|
|
20854
|
-
* location for the download bubble.
|
|
20855
|
-
*
|
|
20856
|
-
* @returns {Promise<void>}
|
|
20857
|
-
* A promise that resolves once the anchor update has been applied.
|
|
20858
|
-
* @example
|
|
20859
|
-
* ```js
|
|
20860
|
-
* var w = fin.Window.getCurrentSync();
|
|
20861
|
-
* w.on('download-button-visibility-changed', (evt) => {
|
|
20862
|
-
* if (evt.visible) {
|
|
20863
|
-
* const el = document.getElementById("download-bubble-button");
|
|
20864
|
-
* //We show our button and get it's bounding rect
|
|
20865
|
-
* el.classList.remove("hidden");
|
|
20866
|
-
* const rect = el.getBoundingClientRect();
|
|
20867
|
-
* const anchor = {
|
|
20868
|
-
* bounds: rect,
|
|
20869
|
-
* location: "topRight"
|
|
20870
|
-
* }
|
|
20871
|
-
* w.updateDownloadBubbleAnchor(anchor);
|
|
20872
|
-
* } else {
|
|
20873
|
-
* //We hide our button
|
|
20874
|
-
* document.getElementById("download-bubble-button")?.classList.add("hidden");
|
|
20875
|
-
* }
|
|
20876
|
-
});
|
|
20877
|
-
*/
|
|
20878
|
-
updateDownloadBubbleAnchor(anchor: OpenFin.Anchor): Promise<void>;
|
|
20879
20196
|
}
|
|
20880
20197
|
|
|
20881
20198
|
/**
|
|
@@ -21030,8 +20347,6 @@ declare namespace WindowEvents {
|
|
|
21030
20347
|
BoundsChangingEvent,
|
|
21031
20348
|
DisabledMovementBoundsChangedEvent,
|
|
21032
20349
|
DisabledMovementBoundsChangingEvent,
|
|
21033
|
-
SnappedEvent,
|
|
21034
|
-
SnapZoneChangedEvent,
|
|
21035
20350
|
UserBoundsChangeEvent,
|
|
21036
20351
|
BeginUserBoundsChangingEvent,
|
|
21037
20352
|
EndUserBoundsChangingEvent,
|
|
@@ -21071,8 +20386,6 @@ declare namespace WindowEvents {
|
|
|
21071
20386
|
NonPropagatedWindowEvent,
|
|
21072
20387
|
ShowAllDownloadsEvent,
|
|
21073
20388
|
DownloadShelfVisibilityChangedEvent,
|
|
21074
|
-
DownloadButtonVisibilityChangedEvent,
|
|
21075
|
-
DownloadButtonIconUpdatedEvent,
|
|
21076
20389
|
WindowSourcedEvent,
|
|
21077
20390
|
WillPropagateWindowEvent,
|
|
21078
20391
|
Event_6 as Event,
|
|
@@ -21276,7 +20589,7 @@ declare type WindowShowRequestedEvent = ShowRequestedEvent;
|
|
|
21276
20589
|
* A union of all events that emit natively on the `Window` topic, i.e. excluding those that propagate
|
|
21277
20590
|
* from {@link OpenFin.ViewEvents}.
|
|
21278
20591
|
*/
|
|
21279
|
-
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
|
|
20592
|
+
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;
|
|
21280
20593
|
|
|
21281
20594
|
/**
|
|
21282
20595
|
* Generated when a child window starts loading.
|