@openfin/core 45.100.103 → 45.100.105
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/mock-alpha.d.ts +68 -37
- package/out/mock-beta.d.ts +68 -37
- package/out/mock-public.d.ts +68 -37
- package/out/stub.d.ts +99 -19
- package/out/stub.js +7 -1
- package/out/stub.mjs +7 -1
- package/package.json +1 -1
package/out/mock-alpha.d.ts
CHANGED
|
@@ -3086,12 +3086,31 @@ declare interface ChildContentOptions {
|
|
|
3086
3086
|
*/
|
|
3087
3087
|
declare type ChildViewCreatedEvent = ContentCreationRulesEvent & {
|
|
3088
3088
|
type: 'child-view-created';
|
|
3089
|
+
/**
|
|
3090
|
+
* Recommended placement for the already-created child View.
|
|
3091
|
+
*
|
|
3092
|
+
* This is complementary to `disposition`: `disposition` describes the requested browser creation
|
|
3093
|
+
* behavior, while `destination` describes where the resulting View should be placed.
|
|
3094
|
+
*/
|
|
3095
|
+
destination: ChildViewDestination;
|
|
3089
3096
|
/**
|
|
3090
3097
|
* The options the child View was created with.
|
|
3091
3098
|
*/
|
|
3092
3099
|
childOptions: OpenFin_2.ViewOptions;
|
|
3093
3100
|
};
|
|
3094
3101
|
|
|
3102
|
+
/**
|
|
3103
|
+
* Describes where an already-created View should be placed.
|
|
3104
|
+
*/
|
|
3105
|
+
declare type ChildViewDestination = {
|
|
3106
|
+
/** Add the View to this existing window. */
|
|
3107
|
+
type: 'existing-window';
|
|
3108
|
+
identity: OpenFin_2.Identity;
|
|
3109
|
+
} | {
|
|
3110
|
+
/** Create a new window containing the View. */
|
|
3111
|
+
type: 'new-window';
|
|
3112
|
+
};
|
|
3113
|
+
|
|
3095
3114
|
/**
|
|
3096
3115
|
* Generated when a child Window is created.
|
|
3097
3116
|
* @interface
|
|
@@ -3104,22 +3123,7 @@ declare type ChildWindowCreatedEvent = ContentCreationRulesEvent & {
|
|
|
3104
3123
|
childOptions: OpenFin_2.WindowOptions;
|
|
3105
3124
|
};
|
|
3106
3125
|
|
|
3107
|
-
|
|
3108
|
-
* End of Interop Client Events
|
|
3109
|
-
*/
|
|
3110
|
-
/**
|
|
3111
|
-
* Client-side handle for the chrome-browser feature.
|
|
3112
|
-
*
|
|
3113
|
-
* For Chrome extension integration to be active on a window, that window must be
|
|
3114
|
-
* created with `chromeBrowser: true` in its window options. There is no separate
|
|
3115
|
-
* `init()` step.
|
|
3116
|
-
*/
|
|
3117
|
-
declare interface ChromeBrowser {
|
|
3118
|
-
/**
|
|
3119
|
-
* Extension action surface — observe and invoke installed Chrome extension actions.
|
|
3120
|
-
*/
|
|
3121
|
-
readonly Actions: ChromeBrowserActions;
|
|
3122
|
-
}
|
|
3126
|
+
/* Excluded from this release type: ChromeBrowser */
|
|
3123
3127
|
|
|
3124
3128
|
/**
|
|
3125
3129
|
* APIs for interacting with Chromium extension actions from an initialized ChromeBrowser window.
|
|
@@ -3889,14 +3893,7 @@ declare type ConstWindowOptions = {
|
|
|
3889
3893
|
* @default false
|
|
3890
3894
|
*/
|
|
3891
3895
|
backgroundThrottling: boolean;
|
|
3892
|
-
|
|
3893
|
-
* If `true`, the window is registered with Chromium as a `ChromeBrowser`,
|
|
3894
|
-
* making it visible to Chrome extensions via the `chrome.windows` API.
|
|
3895
|
-
* The window must be created with this option set; it cannot be flipped at runtime.
|
|
3896
|
-
*
|
|
3897
|
-
* @defaultValue false
|
|
3898
|
-
*/
|
|
3899
|
-
chromeBrowser: boolean;
|
|
3896
|
+
/* Excluded from this release type: chromeBrowser */
|
|
3900
3897
|
/**
|
|
3901
3898
|
* Configures how new content (e,g, from `window.open` or a link) is opened.
|
|
3902
3899
|
*/
|
|
@@ -3986,6 +3983,12 @@ declare type ConstWindowOptions = {
|
|
|
3986
3983
|
* triggered by the window itself, or a view targeting the window.
|
|
3987
3984
|
*/
|
|
3988
3985
|
downloadShelf: DownloadShelfOptions;
|
|
3986
|
+
/**
|
|
3987
|
+
* @defaultValue true
|
|
3988
|
+
*
|
|
3989
|
+
* Show the window's frame.
|
|
3990
|
+
*/
|
|
3991
|
+
frame: boolean;
|
|
3989
3992
|
height: number;
|
|
3990
3993
|
layout: any;
|
|
3991
3994
|
/**
|
|
@@ -5636,6 +5639,11 @@ declare type ExtensionTabCreatedEvent = BaseEvent_5 & {
|
|
|
5636
5639
|
type: 'extension-tab-created';
|
|
5637
5640
|
/** Identity of the auto-created view backing the new tab. */
|
|
5638
5641
|
viewIdentity: OpenFin_2.Identity;
|
|
5642
|
+
/**
|
|
5643
|
+
* Recommended placement for the auto-created View. This is complementary to `disposition`, which
|
|
5644
|
+
* describes the requested browser creation behavior.
|
|
5645
|
+
*/
|
|
5646
|
+
destination: WebContentsEvents.ChildViewDestination;
|
|
5639
5647
|
/**
|
|
5640
5648
|
* Identity of the view that was active when the extension triggered tab creation.
|
|
5641
5649
|
* Undefined if no tab was active (e.g. the first tab in a newly-opened window).
|
|
@@ -5653,6 +5661,37 @@ declare type ExtensionTabCreatedEvent = BaseEvent_5 & {
|
|
|
5653
5661
|
* - `other` — any other or unrecognized Chromium disposition
|
|
5654
5662
|
*/
|
|
5655
5663
|
disposition: OpenFin_2.ContentCreationDisposition;
|
|
5664
|
+
/** Raw `window.open()` features string, if provided by `CreateContentsParams`. */
|
|
5665
|
+
features: string;
|
|
5666
|
+
/** Target frame name from `window.open(url, name)`, if provided. */
|
|
5667
|
+
frameName: string;
|
|
5668
|
+
/** Parsed window options derived from the features string. */
|
|
5669
|
+
parsedFeatures: Partial<OpenFin_2.WindowOptions>;
|
|
5670
|
+
};
|
|
5671
|
+
|
|
5672
|
+
/**
|
|
5673
|
+
* Generated when an extension creates a popup window on this host window
|
|
5674
|
+
* (e.g. via `chrome.windows.create({ type: 'popup' })`). The runtime
|
|
5675
|
+
* auto-creates a backing View and ChromeBrowser; this event notifies the
|
|
5676
|
+
* platform provider so it can create a registered OpenFin window.
|
|
5677
|
+
* Only fires on windows created with `chromeBrowser: true`.
|
|
5678
|
+
* @interface
|
|
5679
|
+
*/
|
|
5680
|
+
declare type ExtensionWindowCreatedEvent = BaseEvent_5 & {
|
|
5681
|
+
type: 'extension-window-created';
|
|
5682
|
+
/** Identity of the auto-created tab backing the popup window. */
|
|
5683
|
+
tabIdentity: OpenFin_2.Identity;
|
|
5684
|
+
/**
|
|
5685
|
+
* Identity of the view that was active when the extension triggered window creation.
|
|
5686
|
+
* Undefined if no tab was active.
|
|
5687
|
+
*/
|
|
5688
|
+
activeTabIdentity?: OpenFin_2.Identity;
|
|
5689
|
+
/** Initial URL the extension requested. */
|
|
5690
|
+
url: string;
|
|
5691
|
+
/** Always `'popup'` for extension-created popup windows. */
|
|
5692
|
+
disposition: 'popup';
|
|
5693
|
+
/** Options for the child window the platform provider should create. */
|
|
5694
|
+
childOptions: Record<string, unknown>;
|
|
5656
5695
|
};
|
|
5657
5696
|
|
|
5658
5697
|
/**
|
|
@@ -6020,7 +6059,7 @@ declare interface FinApi<MeType extends OpenFin_2.EntityType> {
|
|
|
6020
6059
|
readonly Interop: InteropModule;
|
|
6021
6060
|
readonly SnapshotSource: SnapshotSourceModule;
|
|
6022
6061
|
readonly NotificationManager: NotificationManagerModule;
|
|
6023
|
-
|
|
6062
|
+
/* Excluded from this release type: ChromeBrowser */
|
|
6024
6063
|
/**
|
|
6025
6064
|
* Provides access to the OpenFin representation of the current code context (usually an entity
|
|
6026
6065
|
* such as a {@link OpenFin.View} or {@link OpenFin.Window}), as well as to the current `Interop` context.
|
|
@@ -9225,7 +9264,7 @@ declare type LayoutSyncApi = {
|
|
|
9225
9264
|
/**
|
|
9226
9265
|
* @interface
|
|
9227
9266
|
*/
|
|
9228
|
-
declare type LegacyWinOptionsInAppOptions = Pick<WindowCreationOptions, 'accelerator' | 'alwaysOnTop' | 'api' | 'aspectRatio' | 'autoplayPolicy' | 'autoShow' | 'backgroundColor' | 'contentNavigation' | 'contextMenu' | 'cornerRounding' | 'customData' | 'customRequestHeaders' | 'defaultCentered' | 'defaultHeight' | 'defaultLeft' | 'defaultTop' | 'defaultWidth' | '
|
|
9267
|
+
declare type LegacyWinOptionsInAppOptions = Pick<WindowCreationOptions, 'accelerator' | 'alwaysOnTop' | 'api' | 'aspectRatio' | 'autoplayPolicy' | 'autoShow' | 'backgroundColor' | 'contentNavigation' | 'contextMenu' | 'cornerRounding' | 'customData' | 'customRequestHeaders' | 'defaultCentered' | 'defaultHeight' | 'defaultLeft' | 'defaultTop' | 'defaultWidth' | 'hideOnClose' | 'icon' | 'maxHeight' | 'maximizable' | 'maxWidth' | 'minHeight' | 'minimizable' | 'minWidth' | 'opacity' | 'preloadScripts' | 'resizable' | 'resizeRegion' | 'saveWindowState' | 'ignoreSavedWindowState' | 'shadow' | 'showTaskbarIcon' | 'smallWindow' | 'state' | 'taskbarIconGroup' | 'waitForPageLoad' | '_internalWorkspaceData'>;
|
|
9229
9268
|
|
|
9230
9269
|
declare type Listener<T extends {
|
|
9231
9270
|
type: string;
|
|
@@ -9906,16 +9945,6 @@ declare type MutableWindowOptions = {
|
|
|
9906
9945
|
* _When omitted, _inherits_ from the parent application._
|
|
9907
9946
|
*/
|
|
9908
9947
|
customData: any;
|
|
9909
|
-
/**
|
|
9910
|
-
*
|
|
9911
|
-
* Show the window's frame.
|
|
9912
|
-
*
|
|
9913
|
-
* @remarks
|
|
9914
|
-
* This property will not be updatable starting runtime version 45.
|
|
9915
|
-
*
|
|
9916
|
-
* @default true
|
|
9917
|
-
*/
|
|
9918
|
-
frame: boolean;
|
|
9919
9948
|
/**
|
|
9920
9949
|
* Hides the window instead of closing it when the close button is pressed.
|
|
9921
9950
|
*
|
|
@@ -19533,6 +19562,7 @@ declare namespace WebContentsEvents {
|
|
|
19533
19562
|
ContentCreationRulesEvent,
|
|
19534
19563
|
ChildContentBlockedEvent,
|
|
19535
19564
|
ChildContentOpenedInBrowserEvent,
|
|
19565
|
+
ChildViewDestination,
|
|
19536
19566
|
ChildViewCreatedEvent,
|
|
19537
19567
|
ChildWindowCreatedEvent,
|
|
19538
19568
|
FileDownloadEvent,
|
|
@@ -20892,6 +20922,7 @@ declare namespace WindowEvents {
|
|
|
20892
20922
|
BaseWindowEvent,
|
|
20893
20923
|
ViewAttachedEvent,
|
|
20894
20924
|
ExtensionTabCreatedEvent,
|
|
20925
|
+
ExtensionWindowCreatedEvent,
|
|
20895
20926
|
ViewDetachedEvent,
|
|
20896
20927
|
WindowViewEvent,
|
|
20897
20928
|
AlertRequestedEvent,
|
|
@@ -21161,7 +21192,7 @@ declare type WindowShowRequestedEvent = ShowRequestedEvent;
|
|
|
21161
21192
|
* A union of all events that emit natively on the `Window` topic, i.e. excluding those that propagate
|
|
21162
21193
|
* from {@link OpenFin.ViewEvents}.
|
|
21163
21194
|
*/
|
|
21164
|
-
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 | DownloadButtonVisibilityChangedEvent | DownloadButtonIconUpdatedEvent | SnappedEvent | SnapZoneChangedEvent | ExtensionTabCreatedEvent;
|
|
21195
|
+
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 | DownloadButtonVisibilityChangedEvent | DownloadButtonIconUpdatedEvent | SnappedEvent | SnapZoneChangedEvent | ExtensionTabCreatedEvent | ExtensionWindowCreatedEvent;
|
|
21165
21196
|
|
|
21166
21197
|
/**
|
|
21167
21198
|
* Generated when a child window starts loading.
|
package/out/mock-beta.d.ts
CHANGED
|
@@ -3086,12 +3086,31 @@ declare interface ChildContentOptions {
|
|
|
3086
3086
|
*/
|
|
3087
3087
|
declare type ChildViewCreatedEvent = ContentCreationRulesEvent & {
|
|
3088
3088
|
type: 'child-view-created';
|
|
3089
|
+
/**
|
|
3090
|
+
* Recommended placement for the already-created child View.
|
|
3091
|
+
*
|
|
3092
|
+
* This is complementary to `disposition`: `disposition` describes the requested browser creation
|
|
3093
|
+
* behavior, while `destination` describes where the resulting View should be placed.
|
|
3094
|
+
*/
|
|
3095
|
+
destination: ChildViewDestination;
|
|
3089
3096
|
/**
|
|
3090
3097
|
* The options the child View was created with.
|
|
3091
3098
|
*/
|
|
3092
3099
|
childOptions: OpenFin_2.ViewOptions;
|
|
3093
3100
|
};
|
|
3094
3101
|
|
|
3102
|
+
/**
|
|
3103
|
+
* Describes where an already-created View should be placed.
|
|
3104
|
+
*/
|
|
3105
|
+
declare type ChildViewDestination = {
|
|
3106
|
+
/** Add the View to this existing window. */
|
|
3107
|
+
type: 'existing-window';
|
|
3108
|
+
identity: OpenFin_2.Identity;
|
|
3109
|
+
} | {
|
|
3110
|
+
/** Create a new window containing the View. */
|
|
3111
|
+
type: 'new-window';
|
|
3112
|
+
};
|
|
3113
|
+
|
|
3095
3114
|
/**
|
|
3096
3115
|
* Generated when a child Window is created.
|
|
3097
3116
|
* @interface
|
|
@@ -3104,22 +3123,7 @@ declare type ChildWindowCreatedEvent = ContentCreationRulesEvent & {
|
|
|
3104
3123
|
childOptions: OpenFin_2.WindowOptions;
|
|
3105
3124
|
};
|
|
3106
3125
|
|
|
3107
|
-
|
|
3108
|
-
* End of Interop Client Events
|
|
3109
|
-
*/
|
|
3110
|
-
/**
|
|
3111
|
-
* Client-side handle for the chrome-browser feature.
|
|
3112
|
-
*
|
|
3113
|
-
* For Chrome extension integration to be active on a window, that window must be
|
|
3114
|
-
* created with `chromeBrowser: true` in its window options. There is no separate
|
|
3115
|
-
* `init()` step.
|
|
3116
|
-
*/
|
|
3117
|
-
declare interface ChromeBrowser {
|
|
3118
|
-
/**
|
|
3119
|
-
* Extension action surface — observe and invoke installed Chrome extension actions.
|
|
3120
|
-
*/
|
|
3121
|
-
readonly Actions: ChromeBrowserActions;
|
|
3122
|
-
}
|
|
3126
|
+
/* Excluded from this release type: ChromeBrowser */
|
|
3123
3127
|
|
|
3124
3128
|
/**
|
|
3125
3129
|
* APIs for interacting with Chromium extension actions from an initialized ChromeBrowser window.
|
|
@@ -3889,14 +3893,7 @@ declare type ConstWindowOptions = {
|
|
|
3889
3893
|
* @default false
|
|
3890
3894
|
*/
|
|
3891
3895
|
backgroundThrottling: boolean;
|
|
3892
|
-
|
|
3893
|
-
* If `true`, the window is registered with Chromium as a `ChromeBrowser`,
|
|
3894
|
-
* making it visible to Chrome extensions via the `chrome.windows` API.
|
|
3895
|
-
* The window must be created with this option set; it cannot be flipped at runtime.
|
|
3896
|
-
*
|
|
3897
|
-
* @defaultValue false
|
|
3898
|
-
*/
|
|
3899
|
-
chromeBrowser: boolean;
|
|
3896
|
+
/* Excluded from this release type: chromeBrowser */
|
|
3900
3897
|
/**
|
|
3901
3898
|
* Configures how new content (e,g, from `window.open` or a link) is opened.
|
|
3902
3899
|
*/
|
|
@@ -3986,6 +3983,12 @@ declare type ConstWindowOptions = {
|
|
|
3986
3983
|
* triggered by the window itself, or a view targeting the window.
|
|
3987
3984
|
*/
|
|
3988
3985
|
downloadShelf: DownloadShelfOptions;
|
|
3986
|
+
/**
|
|
3987
|
+
* @defaultValue true
|
|
3988
|
+
*
|
|
3989
|
+
* Show the window's frame.
|
|
3990
|
+
*/
|
|
3991
|
+
frame: boolean;
|
|
3989
3992
|
height: number;
|
|
3990
3993
|
layout: any;
|
|
3991
3994
|
/**
|
|
@@ -5636,6 +5639,11 @@ declare type ExtensionTabCreatedEvent = BaseEvent_5 & {
|
|
|
5636
5639
|
type: 'extension-tab-created';
|
|
5637
5640
|
/** Identity of the auto-created view backing the new tab. */
|
|
5638
5641
|
viewIdentity: OpenFin_2.Identity;
|
|
5642
|
+
/**
|
|
5643
|
+
* Recommended placement for the auto-created View. This is complementary to `disposition`, which
|
|
5644
|
+
* describes the requested browser creation behavior.
|
|
5645
|
+
*/
|
|
5646
|
+
destination: WebContentsEvents.ChildViewDestination;
|
|
5639
5647
|
/**
|
|
5640
5648
|
* Identity of the view that was active when the extension triggered tab creation.
|
|
5641
5649
|
* Undefined if no tab was active (e.g. the first tab in a newly-opened window).
|
|
@@ -5653,6 +5661,37 @@ declare type ExtensionTabCreatedEvent = BaseEvent_5 & {
|
|
|
5653
5661
|
* - `other` — any other or unrecognized Chromium disposition
|
|
5654
5662
|
*/
|
|
5655
5663
|
disposition: OpenFin_2.ContentCreationDisposition;
|
|
5664
|
+
/** Raw `window.open()` features string, if provided by `CreateContentsParams`. */
|
|
5665
|
+
features: string;
|
|
5666
|
+
/** Target frame name from `window.open(url, name)`, if provided. */
|
|
5667
|
+
frameName: string;
|
|
5668
|
+
/** Parsed window options derived from the features string. */
|
|
5669
|
+
parsedFeatures: Partial<OpenFin_2.WindowOptions>;
|
|
5670
|
+
};
|
|
5671
|
+
|
|
5672
|
+
/**
|
|
5673
|
+
* Generated when an extension creates a popup window on this host window
|
|
5674
|
+
* (e.g. via `chrome.windows.create({ type: 'popup' })`). The runtime
|
|
5675
|
+
* auto-creates a backing View and ChromeBrowser; this event notifies the
|
|
5676
|
+
* platform provider so it can create a registered OpenFin window.
|
|
5677
|
+
* Only fires on windows created with `chromeBrowser: true`.
|
|
5678
|
+
* @interface
|
|
5679
|
+
*/
|
|
5680
|
+
declare type ExtensionWindowCreatedEvent = BaseEvent_5 & {
|
|
5681
|
+
type: 'extension-window-created';
|
|
5682
|
+
/** Identity of the auto-created tab backing the popup window. */
|
|
5683
|
+
tabIdentity: OpenFin_2.Identity;
|
|
5684
|
+
/**
|
|
5685
|
+
* Identity of the view that was active when the extension triggered window creation.
|
|
5686
|
+
* Undefined if no tab was active.
|
|
5687
|
+
*/
|
|
5688
|
+
activeTabIdentity?: OpenFin_2.Identity;
|
|
5689
|
+
/** Initial URL the extension requested. */
|
|
5690
|
+
url: string;
|
|
5691
|
+
/** Always `'popup'` for extension-created popup windows. */
|
|
5692
|
+
disposition: 'popup';
|
|
5693
|
+
/** Options for the child window the platform provider should create. */
|
|
5694
|
+
childOptions: Record<string, unknown>;
|
|
5656
5695
|
};
|
|
5657
5696
|
|
|
5658
5697
|
/**
|
|
@@ -6020,7 +6059,7 @@ declare interface FinApi<MeType extends OpenFin_2.EntityType> {
|
|
|
6020
6059
|
readonly Interop: InteropModule;
|
|
6021
6060
|
readonly SnapshotSource: SnapshotSourceModule;
|
|
6022
6061
|
readonly NotificationManager: NotificationManagerModule;
|
|
6023
|
-
|
|
6062
|
+
/* Excluded from this release type: ChromeBrowser */
|
|
6024
6063
|
/**
|
|
6025
6064
|
* Provides access to the OpenFin representation of the current code context (usually an entity
|
|
6026
6065
|
* such as a {@link OpenFin.View} or {@link OpenFin.Window}), as well as to the current `Interop` context.
|
|
@@ -9225,7 +9264,7 @@ declare type LayoutSyncApi = {
|
|
|
9225
9264
|
/**
|
|
9226
9265
|
* @interface
|
|
9227
9266
|
*/
|
|
9228
|
-
declare type LegacyWinOptionsInAppOptions = Pick<WindowCreationOptions, 'accelerator' | 'alwaysOnTop' | 'api' | 'aspectRatio' | 'autoplayPolicy' | 'autoShow' | 'backgroundColor' | 'contentNavigation' | 'contextMenu' | 'cornerRounding' | 'customData' | 'customRequestHeaders' | 'defaultCentered' | 'defaultHeight' | 'defaultLeft' | 'defaultTop' | 'defaultWidth' | '
|
|
9267
|
+
declare type LegacyWinOptionsInAppOptions = Pick<WindowCreationOptions, 'accelerator' | 'alwaysOnTop' | 'api' | 'aspectRatio' | 'autoplayPolicy' | 'autoShow' | 'backgroundColor' | 'contentNavigation' | 'contextMenu' | 'cornerRounding' | 'customData' | 'customRequestHeaders' | 'defaultCentered' | 'defaultHeight' | 'defaultLeft' | 'defaultTop' | 'defaultWidth' | 'hideOnClose' | 'icon' | 'maxHeight' | 'maximizable' | 'maxWidth' | 'minHeight' | 'minimizable' | 'minWidth' | 'opacity' | 'preloadScripts' | 'resizable' | 'resizeRegion' | 'saveWindowState' | 'ignoreSavedWindowState' | 'shadow' | 'showTaskbarIcon' | 'smallWindow' | 'state' | 'taskbarIconGroup' | 'waitForPageLoad' | '_internalWorkspaceData'>;
|
|
9229
9268
|
|
|
9230
9269
|
declare type Listener<T extends {
|
|
9231
9270
|
type: string;
|
|
@@ -9906,16 +9945,6 @@ declare type MutableWindowOptions = {
|
|
|
9906
9945
|
* _When omitted, _inherits_ from the parent application._
|
|
9907
9946
|
*/
|
|
9908
9947
|
customData: any;
|
|
9909
|
-
/**
|
|
9910
|
-
*
|
|
9911
|
-
* Show the window's frame.
|
|
9912
|
-
*
|
|
9913
|
-
* @remarks
|
|
9914
|
-
* This property will not be updatable starting runtime version 45.
|
|
9915
|
-
*
|
|
9916
|
-
* @default true
|
|
9917
|
-
*/
|
|
9918
|
-
frame: boolean;
|
|
9919
9948
|
/**
|
|
9920
9949
|
* Hides the window instead of closing it when the close button is pressed.
|
|
9921
9950
|
*
|
|
@@ -19533,6 +19562,7 @@ declare namespace WebContentsEvents {
|
|
|
19533
19562
|
ContentCreationRulesEvent,
|
|
19534
19563
|
ChildContentBlockedEvent,
|
|
19535
19564
|
ChildContentOpenedInBrowserEvent,
|
|
19565
|
+
ChildViewDestination,
|
|
19536
19566
|
ChildViewCreatedEvent,
|
|
19537
19567
|
ChildWindowCreatedEvent,
|
|
19538
19568
|
FileDownloadEvent,
|
|
@@ -20892,6 +20922,7 @@ declare namespace WindowEvents {
|
|
|
20892
20922
|
BaseWindowEvent,
|
|
20893
20923
|
ViewAttachedEvent,
|
|
20894
20924
|
ExtensionTabCreatedEvent,
|
|
20925
|
+
ExtensionWindowCreatedEvent,
|
|
20895
20926
|
ViewDetachedEvent,
|
|
20896
20927
|
WindowViewEvent,
|
|
20897
20928
|
AlertRequestedEvent,
|
|
@@ -21161,7 +21192,7 @@ declare type WindowShowRequestedEvent = ShowRequestedEvent;
|
|
|
21161
21192
|
* A union of all events that emit natively on the `Window` topic, i.e. excluding those that propagate
|
|
21162
21193
|
* from {@link OpenFin.ViewEvents}.
|
|
21163
21194
|
*/
|
|
21164
|
-
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 | DownloadButtonVisibilityChangedEvent | DownloadButtonIconUpdatedEvent | SnappedEvent | SnapZoneChangedEvent | ExtensionTabCreatedEvent;
|
|
21195
|
+
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 | DownloadButtonVisibilityChangedEvent | DownloadButtonIconUpdatedEvent | SnappedEvent | SnapZoneChangedEvent | ExtensionTabCreatedEvent | ExtensionWindowCreatedEvent;
|
|
21165
21196
|
|
|
21166
21197
|
/**
|
|
21167
21198
|
* Generated when a child window starts loading.
|
package/out/mock-public.d.ts
CHANGED
|
@@ -3086,12 +3086,31 @@ declare interface ChildContentOptions {
|
|
|
3086
3086
|
*/
|
|
3087
3087
|
declare type ChildViewCreatedEvent = ContentCreationRulesEvent & {
|
|
3088
3088
|
type: 'child-view-created';
|
|
3089
|
+
/**
|
|
3090
|
+
* Recommended placement for the already-created child View.
|
|
3091
|
+
*
|
|
3092
|
+
* This is complementary to `disposition`: `disposition` describes the requested browser creation
|
|
3093
|
+
* behavior, while `destination` describes where the resulting View should be placed.
|
|
3094
|
+
*/
|
|
3095
|
+
destination: ChildViewDestination;
|
|
3089
3096
|
/**
|
|
3090
3097
|
* The options the child View was created with.
|
|
3091
3098
|
*/
|
|
3092
3099
|
childOptions: OpenFin_2.ViewOptions;
|
|
3093
3100
|
};
|
|
3094
3101
|
|
|
3102
|
+
/**
|
|
3103
|
+
* Describes where an already-created View should be placed.
|
|
3104
|
+
*/
|
|
3105
|
+
declare type ChildViewDestination = {
|
|
3106
|
+
/** Add the View to this existing window. */
|
|
3107
|
+
type: 'existing-window';
|
|
3108
|
+
identity: OpenFin_2.Identity;
|
|
3109
|
+
} | {
|
|
3110
|
+
/** Create a new window containing the View. */
|
|
3111
|
+
type: 'new-window';
|
|
3112
|
+
};
|
|
3113
|
+
|
|
3095
3114
|
/**
|
|
3096
3115
|
* Generated when a child Window is created.
|
|
3097
3116
|
* @interface
|
|
@@ -3104,22 +3123,7 @@ declare type ChildWindowCreatedEvent = ContentCreationRulesEvent & {
|
|
|
3104
3123
|
childOptions: OpenFin_2.WindowOptions;
|
|
3105
3124
|
};
|
|
3106
3125
|
|
|
3107
|
-
|
|
3108
|
-
* End of Interop Client Events
|
|
3109
|
-
*/
|
|
3110
|
-
/**
|
|
3111
|
-
* Client-side handle for the chrome-browser feature.
|
|
3112
|
-
*
|
|
3113
|
-
* For Chrome extension integration to be active on a window, that window must be
|
|
3114
|
-
* created with `chromeBrowser: true` in its window options. There is no separate
|
|
3115
|
-
* `init()` step.
|
|
3116
|
-
*/
|
|
3117
|
-
declare interface ChromeBrowser {
|
|
3118
|
-
/**
|
|
3119
|
-
* Extension action surface — observe and invoke installed Chrome extension actions.
|
|
3120
|
-
*/
|
|
3121
|
-
readonly Actions: ChromeBrowserActions;
|
|
3122
|
-
}
|
|
3126
|
+
/* Excluded from this release type: ChromeBrowser */
|
|
3123
3127
|
|
|
3124
3128
|
/**
|
|
3125
3129
|
* APIs for interacting with Chromium extension actions from an initialized ChromeBrowser window.
|
|
@@ -3889,14 +3893,7 @@ declare type ConstWindowOptions = {
|
|
|
3889
3893
|
* @default false
|
|
3890
3894
|
*/
|
|
3891
3895
|
backgroundThrottling: boolean;
|
|
3892
|
-
|
|
3893
|
-
* If `true`, the window is registered with Chromium as a `ChromeBrowser`,
|
|
3894
|
-
* making it visible to Chrome extensions via the `chrome.windows` API.
|
|
3895
|
-
* The window must be created with this option set; it cannot be flipped at runtime.
|
|
3896
|
-
*
|
|
3897
|
-
* @defaultValue false
|
|
3898
|
-
*/
|
|
3899
|
-
chromeBrowser: boolean;
|
|
3896
|
+
/* Excluded from this release type: chromeBrowser */
|
|
3900
3897
|
/**
|
|
3901
3898
|
* Configures how new content (e,g, from `window.open` or a link) is opened.
|
|
3902
3899
|
*/
|
|
@@ -3986,6 +3983,12 @@ declare type ConstWindowOptions = {
|
|
|
3986
3983
|
* triggered by the window itself, or a view targeting the window.
|
|
3987
3984
|
*/
|
|
3988
3985
|
downloadShelf: DownloadShelfOptions;
|
|
3986
|
+
/**
|
|
3987
|
+
* @defaultValue true
|
|
3988
|
+
*
|
|
3989
|
+
* Show the window's frame.
|
|
3990
|
+
*/
|
|
3991
|
+
frame: boolean;
|
|
3989
3992
|
height: number;
|
|
3990
3993
|
layout: any;
|
|
3991
3994
|
/**
|
|
@@ -5636,6 +5639,11 @@ declare type ExtensionTabCreatedEvent = BaseEvent_5 & {
|
|
|
5636
5639
|
type: 'extension-tab-created';
|
|
5637
5640
|
/** Identity of the auto-created view backing the new tab. */
|
|
5638
5641
|
viewIdentity: OpenFin_2.Identity;
|
|
5642
|
+
/**
|
|
5643
|
+
* Recommended placement for the auto-created View. This is complementary to `disposition`, which
|
|
5644
|
+
* describes the requested browser creation behavior.
|
|
5645
|
+
*/
|
|
5646
|
+
destination: WebContentsEvents.ChildViewDestination;
|
|
5639
5647
|
/**
|
|
5640
5648
|
* Identity of the view that was active when the extension triggered tab creation.
|
|
5641
5649
|
* Undefined if no tab was active (e.g. the first tab in a newly-opened window).
|
|
@@ -5653,6 +5661,37 @@ declare type ExtensionTabCreatedEvent = BaseEvent_5 & {
|
|
|
5653
5661
|
* - `other` — any other or unrecognized Chromium disposition
|
|
5654
5662
|
*/
|
|
5655
5663
|
disposition: OpenFin_2.ContentCreationDisposition;
|
|
5664
|
+
/** Raw `window.open()` features string, if provided by `CreateContentsParams`. */
|
|
5665
|
+
features: string;
|
|
5666
|
+
/** Target frame name from `window.open(url, name)`, if provided. */
|
|
5667
|
+
frameName: string;
|
|
5668
|
+
/** Parsed window options derived from the features string. */
|
|
5669
|
+
parsedFeatures: Partial<OpenFin_2.WindowOptions>;
|
|
5670
|
+
};
|
|
5671
|
+
|
|
5672
|
+
/**
|
|
5673
|
+
* Generated when an extension creates a popup window on this host window
|
|
5674
|
+
* (e.g. via `chrome.windows.create({ type: 'popup' })`). The runtime
|
|
5675
|
+
* auto-creates a backing View and ChromeBrowser; this event notifies the
|
|
5676
|
+
* platform provider so it can create a registered OpenFin window.
|
|
5677
|
+
* Only fires on windows created with `chromeBrowser: true`.
|
|
5678
|
+
* @interface
|
|
5679
|
+
*/
|
|
5680
|
+
declare type ExtensionWindowCreatedEvent = BaseEvent_5 & {
|
|
5681
|
+
type: 'extension-window-created';
|
|
5682
|
+
/** Identity of the auto-created tab backing the popup window. */
|
|
5683
|
+
tabIdentity: OpenFin_2.Identity;
|
|
5684
|
+
/**
|
|
5685
|
+
* Identity of the view that was active when the extension triggered window creation.
|
|
5686
|
+
* Undefined if no tab was active.
|
|
5687
|
+
*/
|
|
5688
|
+
activeTabIdentity?: OpenFin_2.Identity;
|
|
5689
|
+
/** Initial URL the extension requested. */
|
|
5690
|
+
url: string;
|
|
5691
|
+
/** Always `'popup'` for extension-created popup windows. */
|
|
5692
|
+
disposition: 'popup';
|
|
5693
|
+
/** Options for the child window the platform provider should create. */
|
|
5694
|
+
childOptions: Record<string, unknown>;
|
|
5656
5695
|
};
|
|
5657
5696
|
|
|
5658
5697
|
/**
|
|
@@ -6020,7 +6059,7 @@ declare interface FinApi<MeType extends OpenFin_2.EntityType> {
|
|
|
6020
6059
|
readonly Interop: InteropModule;
|
|
6021
6060
|
readonly SnapshotSource: SnapshotSourceModule;
|
|
6022
6061
|
readonly NotificationManager: NotificationManagerModule;
|
|
6023
|
-
|
|
6062
|
+
/* Excluded from this release type: ChromeBrowser */
|
|
6024
6063
|
/**
|
|
6025
6064
|
* Provides access to the OpenFin representation of the current code context (usually an entity
|
|
6026
6065
|
* such as a {@link OpenFin.View} or {@link OpenFin.Window}), as well as to the current `Interop` context.
|
|
@@ -9225,7 +9264,7 @@ declare type LayoutSyncApi = {
|
|
|
9225
9264
|
/**
|
|
9226
9265
|
* @interface
|
|
9227
9266
|
*/
|
|
9228
|
-
declare type LegacyWinOptionsInAppOptions = Pick<WindowCreationOptions, 'accelerator' | 'alwaysOnTop' | 'api' | 'aspectRatio' | 'autoplayPolicy' | 'autoShow' | 'backgroundColor' | 'contentNavigation' | 'contextMenu' | 'cornerRounding' | 'customData' | 'customRequestHeaders' | 'defaultCentered' | 'defaultHeight' | 'defaultLeft' | 'defaultTop' | 'defaultWidth' | '
|
|
9267
|
+
declare type LegacyWinOptionsInAppOptions = Pick<WindowCreationOptions, 'accelerator' | 'alwaysOnTop' | 'api' | 'aspectRatio' | 'autoplayPolicy' | 'autoShow' | 'backgroundColor' | 'contentNavigation' | 'contextMenu' | 'cornerRounding' | 'customData' | 'customRequestHeaders' | 'defaultCentered' | 'defaultHeight' | 'defaultLeft' | 'defaultTop' | 'defaultWidth' | 'hideOnClose' | 'icon' | 'maxHeight' | 'maximizable' | 'maxWidth' | 'minHeight' | 'minimizable' | 'minWidth' | 'opacity' | 'preloadScripts' | 'resizable' | 'resizeRegion' | 'saveWindowState' | 'ignoreSavedWindowState' | 'shadow' | 'showTaskbarIcon' | 'smallWindow' | 'state' | 'taskbarIconGroup' | 'waitForPageLoad' | '_internalWorkspaceData'>;
|
|
9229
9268
|
|
|
9230
9269
|
declare type Listener<T extends {
|
|
9231
9270
|
type: string;
|
|
@@ -9906,16 +9945,6 @@ declare type MutableWindowOptions = {
|
|
|
9906
9945
|
* _When omitted, _inherits_ from the parent application._
|
|
9907
9946
|
*/
|
|
9908
9947
|
customData: any;
|
|
9909
|
-
/**
|
|
9910
|
-
*
|
|
9911
|
-
* Show the window's frame.
|
|
9912
|
-
*
|
|
9913
|
-
* @remarks
|
|
9914
|
-
* This property will not be updatable starting runtime version 45.
|
|
9915
|
-
*
|
|
9916
|
-
* @default true
|
|
9917
|
-
*/
|
|
9918
|
-
frame: boolean;
|
|
9919
9948
|
/**
|
|
9920
9949
|
* Hides the window instead of closing it when the close button is pressed.
|
|
9921
9950
|
*
|
|
@@ -19533,6 +19562,7 @@ declare namespace WebContentsEvents {
|
|
|
19533
19562
|
ContentCreationRulesEvent,
|
|
19534
19563
|
ChildContentBlockedEvent,
|
|
19535
19564
|
ChildContentOpenedInBrowserEvent,
|
|
19565
|
+
ChildViewDestination,
|
|
19536
19566
|
ChildViewCreatedEvent,
|
|
19537
19567
|
ChildWindowCreatedEvent,
|
|
19538
19568
|
FileDownloadEvent,
|
|
@@ -20892,6 +20922,7 @@ declare namespace WindowEvents {
|
|
|
20892
20922
|
BaseWindowEvent,
|
|
20893
20923
|
ViewAttachedEvent,
|
|
20894
20924
|
ExtensionTabCreatedEvent,
|
|
20925
|
+
ExtensionWindowCreatedEvent,
|
|
20895
20926
|
ViewDetachedEvent,
|
|
20896
20927
|
WindowViewEvent,
|
|
20897
20928
|
AlertRequestedEvent,
|
|
@@ -21161,7 +21192,7 @@ declare type WindowShowRequestedEvent = ShowRequestedEvent;
|
|
|
21161
21192
|
* A union of all events that emit natively on the `Window` topic, i.e. excluding those that propagate
|
|
21162
21193
|
* from {@link OpenFin.ViewEvents}.
|
|
21163
21194
|
*/
|
|
21164
|
-
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 | DownloadButtonVisibilityChangedEvent | DownloadButtonIconUpdatedEvent | SnappedEvent | SnapZoneChangedEvent | ExtensionTabCreatedEvent;
|
|
21195
|
+
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 | DownloadButtonVisibilityChangedEvent | DownloadButtonIconUpdatedEvent | SnappedEvent | SnapZoneChangedEvent | ExtensionTabCreatedEvent | ExtensionWindowCreatedEvent;
|
|
21165
21196
|
|
|
21166
21197
|
/**
|
|
21167
21198
|
* Generated when a child window starts loading.
|
package/out/stub.d.ts
CHANGED
|
@@ -3142,12 +3142,31 @@ declare interface ChildContentOptions {
|
|
|
3142
3142
|
*/
|
|
3143
3143
|
declare type ChildViewCreatedEvent = ContentCreationRulesEvent & {
|
|
3144
3144
|
type: 'child-view-created';
|
|
3145
|
+
/**
|
|
3146
|
+
* Recommended placement for the already-created child View.
|
|
3147
|
+
*
|
|
3148
|
+
* This is complementary to `disposition`: `disposition` describes the requested browser creation
|
|
3149
|
+
* behavior, while `destination` describes where the resulting View should be placed.
|
|
3150
|
+
*/
|
|
3151
|
+
destination: ChildViewDestination;
|
|
3145
3152
|
/**
|
|
3146
3153
|
* The options the child View was created with.
|
|
3147
3154
|
*/
|
|
3148
3155
|
childOptions: OpenFin_2.ViewOptions;
|
|
3149
3156
|
};
|
|
3150
3157
|
|
|
3158
|
+
/**
|
|
3159
|
+
* Describes where an already-created View should be placed.
|
|
3160
|
+
*/
|
|
3161
|
+
declare type ChildViewDestination = {
|
|
3162
|
+
/** Add the View to this existing window. */
|
|
3163
|
+
type: 'existing-window';
|
|
3164
|
+
identity: OpenFin_2.Identity;
|
|
3165
|
+
} | {
|
|
3166
|
+
/** Create a new window containing the View. */
|
|
3167
|
+
type: 'new-window';
|
|
3168
|
+
};
|
|
3169
|
+
|
|
3151
3170
|
/**
|
|
3152
3171
|
* Generated when a child Window is created.
|
|
3153
3172
|
* @interface
|
|
@@ -3166,9 +3185,16 @@ declare type ChildWindowCreatedEvent = ContentCreationRulesEvent & {
|
|
|
3166
3185
|
/**
|
|
3167
3186
|
* Client-side handle for the chrome-browser feature.
|
|
3168
3187
|
*
|
|
3169
|
-
* For
|
|
3170
|
-
* created with `chromeBrowser: true` in its window options.
|
|
3171
|
-
*
|
|
3188
|
+
* For extension integration to be active on a window, that window must be
|
|
3189
|
+
* created with `chromeBrowser: true` in its window options.
|
|
3190
|
+
*
|
|
3191
|
+
* @remarks
|
|
3192
|
+
* This namespace is intended for internal experimentation only. Enabling the
|
|
3193
|
+
* `chromeBrowser` window option changes how the runtime manages content and standard
|
|
3194
|
+
* OpenFin content behavior is not guaranteed.
|
|
3195
|
+
*
|
|
3196
|
+
* @internal
|
|
3197
|
+
* @experimental This API is under active development and may change or be removed without notice.
|
|
3172
3198
|
*/
|
|
3173
3199
|
declare interface ChromeBrowser {
|
|
3174
3200
|
/**
|
|
@@ -3949,13 +3975,27 @@ declare type ConstWindowOptions = {
|
|
|
3949
3975
|
*/
|
|
3950
3976
|
backgroundThrottling: boolean;
|
|
3951
3977
|
/**
|
|
3952
|
-
*
|
|
3953
|
-
*
|
|
3954
|
-
*
|
|
3978
|
+
* Registers the window with Chromium as a `ChromeBrowser`, making it visible to
|
|
3979
|
+
* Chrome extensions via the `chrome.windows` API. The window must be created with
|
|
3980
|
+
* this option set; it cannot be flipped at runtime.
|
|
3955
3981
|
*
|
|
3982
|
+
* Pass `true` (equivalent to `{ type: 'normal' }`) to register as a normal tabbed
|
|
3983
|
+
* chrome-browser host, or `{ type: 'popup' }` to register as a popup chrome-browser
|
|
3984
|
+
* host (no tab strip; the window's own content is the single tab) — the same
|
|
3985
|
+
* registration that `window.open` popups and extension popups receive internally.
|
|
3986
|
+
*
|
|
3987
|
+
* @remarks
|
|
3988
|
+
* Enabling this option changes how Chromium manages the window's content. Standard
|
|
3989
|
+
* OpenFin content behavior is not guaranteed; for example, configured
|
|
3990
|
+
* {@link ContentCreationOptions content creation rules} will no longer be respected.
|
|
3991
|
+
*
|
|
3992
|
+
* @internal
|
|
3993
|
+
* @experimental This option is under active development and may change or be removed without notice.
|
|
3956
3994
|
* @defaultValue false
|
|
3957
3995
|
*/
|
|
3958
|
-
chromeBrowser: boolean
|
|
3996
|
+
chromeBrowser: boolean | {
|
|
3997
|
+
type: 'normal' | 'popup';
|
|
3998
|
+
};
|
|
3959
3999
|
/**
|
|
3960
4000
|
* Configures how new content (e,g, from `window.open` or a link) is opened.
|
|
3961
4001
|
*/
|
|
@@ -4045,6 +4085,12 @@ declare type ConstWindowOptions = {
|
|
|
4045
4085
|
* triggered by the window itself, or a view targeting the window.
|
|
4046
4086
|
*/
|
|
4047
4087
|
downloadShelf: DownloadShelfOptions;
|
|
4088
|
+
/**
|
|
4089
|
+
* @defaultValue true
|
|
4090
|
+
*
|
|
4091
|
+
* Show the window's frame.
|
|
4092
|
+
*/
|
|
4093
|
+
frame: boolean;
|
|
4048
4094
|
height: number;
|
|
4049
4095
|
layout: any;
|
|
4050
4096
|
/**
|
|
@@ -5718,6 +5764,11 @@ declare type ExtensionTabCreatedEvent = BaseEvent_5 & {
|
|
|
5718
5764
|
type: 'extension-tab-created';
|
|
5719
5765
|
/** Identity of the auto-created view backing the new tab. */
|
|
5720
5766
|
viewIdentity: OpenFin_2.Identity;
|
|
5767
|
+
/**
|
|
5768
|
+
* Recommended placement for the auto-created View. This is complementary to `disposition`, which
|
|
5769
|
+
* describes the requested browser creation behavior.
|
|
5770
|
+
*/
|
|
5771
|
+
destination: WebContentsEvents.ChildViewDestination;
|
|
5721
5772
|
/**
|
|
5722
5773
|
* Identity of the view that was active when the extension triggered tab creation.
|
|
5723
5774
|
* Undefined if no tab was active (e.g. the first tab in a newly-opened window).
|
|
@@ -5735,6 +5786,37 @@ declare type ExtensionTabCreatedEvent = BaseEvent_5 & {
|
|
|
5735
5786
|
* - `other` — any other or unrecognized Chromium disposition
|
|
5736
5787
|
*/
|
|
5737
5788
|
disposition: OpenFin_2.ContentCreationDisposition;
|
|
5789
|
+
/** Raw `window.open()` features string, if provided by `CreateContentsParams`. */
|
|
5790
|
+
features: string;
|
|
5791
|
+
/** Target frame name from `window.open(url, name)`, if provided. */
|
|
5792
|
+
frameName: string;
|
|
5793
|
+
/** Parsed window options derived from the features string. */
|
|
5794
|
+
parsedFeatures: Partial<OpenFin_2.WindowOptions>;
|
|
5795
|
+
};
|
|
5796
|
+
|
|
5797
|
+
/**
|
|
5798
|
+
* Generated when an extension creates a popup window on this host window
|
|
5799
|
+
* (e.g. via `chrome.windows.create({ type: 'popup' })`). The runtime
|
|
5800
|
+
* auto-creates a backing View and ChromeBrowser; this event notifies the
|
|
5801
|
+
* platform provider so it can create a registered OpenFin window.
|
|
5802
|
+
* Only fires on windows created with `chromeBrowser: true`.
|
|
5803
|
+
* @interface
|
|
5804
|
+
*/
|
|
5805
|
+
declare type ExtensionWindowCreatedEvent = BaseEvent_5 & {
|
|
5806
|
+
type: 'extension-window-created';
|
|
5807
|
+
/** Identity of the auto-created tab backing the popup window. */
|
|
5808
|
+
tabIdentity: OpenFin_2.Identity;
|
|
5809
|
+
/**
|
|
5810
|
+
* Identity of the view that was active when the extension triggered window creation.
|
|
5811
|
+
* Undefined if no tab was active.
|
|
5812
|
+
*/
|
|
5813
|
+
activeTabIdentity?: OpenFin_2.Identity;
|
|
5814
|
+
/** Initial URL the extension requested. */
|
|
5815
|
+
url: string;
|
|
5816
|
+
/** Always `'popup'` for extension-created popup windows. */
|
|
5817
|
+
disposition: 'popup';
|
|
5818
|
+
/** Options for the child window the platform provider should create. */
|
|
5819
|
+
childOptions: Record<string, unknown>;
|
|
5738
5820
|
};
|
|
5739
5821
|
|
|
5740
5822
|
/**
|
|
@@ -6105,6 +6187,12 @@ declare interface FinApi<MeType extends OpenFin_2.EntityType> {
|
|
|
6105
6187
|
readonly Interop: InteropModule;
|
|
6106
6188
|
readonly SnapshotSource: SnapshotSourceModule;
|
|
6107
6189
|
readonly NotificationManager: NotificationManagerModule;
|
|
6190
|
+
/**
|
|
6191
|
+
* Internal, experimental APIs for Chrome extension integration.
|
|
6192
|
+
*
|
|
6193
|
+
* @internal
|
|
6194
|
+
* @experimental This API may change or be removed without notice.
|
|
6195
|
+
*/
|
|
6108
6196
|
readonly ChromeBrowser: OpenFin_2.ChromeBrowser;
|
|
6109
6197
|
/**
|
|
6110
6198
|
* Provides access to the OpenFin representation of the current code context (usually an entity
|
|
@@ -9534,7 +9622,7 @@ declare type LayoutSyncApi = {
|
|
|
9534
9622
|
/**
|
|
9535
9623
|
* @interface
|
|
9536
9624
|
*/
|
|
9537
|
-
declare type LegacyWinOptionsInAppOptions = Pick<WindowCreationOptions, 'accelerator' | 'alwaysOnTop' | 'api' | 'aspectRatio' | 'autoplayPolicy' | 'autoShow' | 'backgroundColor' | 'contentNavigation' | 'contextMenu' | 'cornerRounding' | 'customData' | 'customRequestHeaders' | 'defaultCentered' | 'defaultHeight' | 'defaultLeft' | 'defaultTop' | 'defaultWidth' | '
|
|
9625
|
+
declare type LegacyWinOptionsInAppOptions = Pick<WindowCreationOptions, 'accelerator' | 'alwaysOnTop' | 'api' | 'aspectRatio' | 'autoplayPolicy' | 'autoShow' | 'backgroundColor' | 'contentNavigation' | 'contextMenu' | 'cornerRounding' | 'customData' | 'customRequestHeaders' | 'defaultCentered' | 'defaultHeight' | 'defaultLeft' | 'defaultTop' | 'defaultWidth' | 'hideOnClose' | 'icon' | 'maxHeight' | 'maximizable' | 'maxWidth' | 'minHeight' | 'minimizable' | 'minWidth' | 'opacity' | 'preloadScripts' | 'resizable' | 'resizeRegion' | 'saveWindowState' | 'ignoreSavedWindowState' | 'shadow' | 'showTaskbarIcon' | 'smallWindow' | 'state' | 'taskbarIconGroup' | 'waitForPageLoad' | '_internalWorkspaceData'>;
|
|
9538
9626
|
|
|
9539
9627
|
declare type Listener<T extends {
|
|
9540
9628
|
type: string;
|
|
@@ -10219,16 +10307,6 @@ declare type MutableWindowOptions = {
|
|
|
10219
10307
|
* _When omitted, _inherits_ from the parent application._
|
|
10220
10308
|
*/
|
|
10221
10309
|
customData: any;
|
|
10222
|
-
/**
|
|
10223
|
-
*
|
|
10224
|
-
* Show the window's frame.
|
|
10225
|
-
*
|
|
10226
|
-
* @remarks
|
|
10227
|
-
* This property will not be updatable starting runtime version 45.
|
|
10228
|
-
*
|
|
10229
|
-
* @default true
|
|
10230
|
-
*/
|
|
10231
|
-
frame: boolean;
|
|
10232
10310
|
/**
|
|
10233
10311
|
* Hides the window instead of closing it when the close button is pressed.
|
|
10234
10312
|
*
|
|
@@ -20000,6 +20078,7 @@ declare namespace WebContentsEvents {
|
|
|
20000
20078
|
ContentCreationRulesEvent,
|
|
20001
20079
|
ChildContentBlockedEvent,
|
|
20002
20080
|
ChildContentOpenedInBrowserEvent,
|
|
20081
|
+
ChildViewDestination,
|
|
20003
20082
|
ChildViewCreatedEvent,
|
|
20004
20083
|
ChildWindowCreatedEvent,
|
|
20005
20084
|
FileDownloadEvent,
|
|
@@ -21362,6 +21441,7 @@ declare namespace WindowEvents {
|
|
|
21362
21441
|
BaseWindowEvent,
|
|
21363
21442
|
ViewAttachedEvent,
|
|
21364
21443
|
ExtensionTabCreatedEvent,
|
|
21444
|
+
ExtensionWindowCreatedEvent,
|
|
21365
21445
|
ViewDetachedEvent,
|
|
21366
21446
|
WindowViewEvent,
|
|
21367
21447
|
AlertRequestedEvent,
|
|
@@ -21631,7 +21711,7 @@ declare type WindowShowRequestedEvent = ShowRequestedEvent;
|
|
|
21631
21711
|
* A union of all events that emit natively on the `Window` topic, i.e. excluding those that propagate
|
|
21632
21712
|
* from {@link OpenFin.ViewEvents}.
|
|
21633
21713
|
*/
|
|
21634
|
-
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 | DownloadButtonVisibilityChangedEvent | DownloadButtonIconUpdatedEvent | SnappedEvent | SnapZoneChangedEvent | ExtensionTabCreatedEvent;
|
|
21714
|
+
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 | DownloadButtonVisibilityChangedEvent | DownloadButtonIconUpdatedEvent | SnappedEvent | SnapZoneChangedEvent | ExtensionTabCreatedEvent | ExtensionWindowCreatedEvent;
|
|
21635
21715
|
|
|
21636
21716
|
/**
|
|
21637
21717
|
* Generated when a child window starts loading.
|
package/out/stub.js
CHANGED
|
@@ -16817,8 +16817,14 @@ _ChromeBrowserActionsImpl_wire = new WeakMap(), _ChromeBrowserActionsImpl_state
|
|
|
16817
16817
|
* Client-side handle for the chrome-browser feature on the current window.
|
|
16818
16818
|
*
|
|
16819
16819
|
* The window must have been created with `chromeBrowser: true` for these APIs to do
|
|
16820
|
-
* anything meaningful
|
|
16820
|
+
* anything meaningful. From a view or a non
|
|
16821
16821
|
* chrome-browser window, calls into `Actions` will resolve to empty results.
|
|
16822
|
+
*
|
|
16823
|
+
* Enabling the `chromeBrowser` window option changes how the runtime manages content,
|
|
16824
|
+
* and standard OpenFin content behavior is not guaranteed.
|
|
16825
|
+
*
|
|
16826
|
+
* @internal
|
|
16827
|
+
* @experimental This API may change or be removed without notice.
|
|
16822
16828
|
*/
|
|
16823
16829
|
class ChromeBrowserModule {
|
|
16824
16830
|
constructor(wire, isWindow) {
|
package/out/stub.mjs
CHANGED
|
@@ -16813,8 +16813,14 @@ _ChromeBrowserActionsImpl_wire = new WeakMap(), _ChromeBrowserActionsImpl_state
|
|
|
16813
16813
|
* Client-side handle for the chrome-browser feature on the current window.
|
|
16814
16814
|
*
|
|
16815
16815
|
* The window must have been created with `chromeBrowser: true` for these APIs to do
|
|
16816
|
-
* anything meaningful
|
|
16816
|
+
* anything meaningful. From a view or a non
|
|
16817
16817
|
* chrome-browser window, calls into `Actions` will resolve to empty results.
|
|
16818
|
+
*
|
|
16819
|
+
* Enabling the `chromeBrowser` window option changes how the runtime manages content,
|
|
16820
|
+
* and standard OpenFin content behavior is not guaranteed.
|
|
16821
|
+
*
|
|
16822
|
+
* @internal
|
|
16823
|
+
* @experimental This API may change or be removed without notice.
|
|
16818
16824
|
*/
|
|
16819
16825
|
class ChromeBrowserModule {
|
|
16820
16826
|
constructor(wire, isWindow) {
|