@openfin/fdc3-api 45.100.104 → 45.100.106
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 +35 -36
- package/out/fdc3-api-beta.d.ts +35 -36
- package/out/fdc3-api-public.d.ts +35 -36
- package/out/fdc3-api.d.ts +66 -18
- package/package.json +1 -1
package/out/fdc3-api-alpha.d.ts
CHANGED
|
@@ -3083,12 +3083,31 @@ declare interface ChildContentOptions {
|
|
|
3083
3083
|
*/
|
|
3084
3084
|
declare type ChildViewCreatedEvent = ContentCreationRulesEvent & {
|
|
3085
3085
|
type: 'child-view-created';
|
|
3086
|
+
/**
|
|
3087
|
+
* Recommended placement for the already-created child View.
|
|
3088
|
+
*
|
|
3089
|
+
* This is complementary to `disposition`: `disposition` describes the requested browser creation
|
|
3090
|
+
* behavior, while `destination` describes where the resulting View should be placed.
|
|
3091
|
+
*/
|
|
3092
|
+
destination: ChildViewDestination;
|
|
3086
3093
|
/**
|
|
3087
3094
|
* The options the child View was created with.
|
|
3088
3095
|
*/
|
|
3089
3096
|
childOptions: OpenFin.ViewOptions;
|
|
3090
3097
|
};
|
|
3091
3098
|
|
|
3099
|
+
/**
|
|
3100
|
+
* Describes where an already-created View should be placed.
|
|
3101
|
+
*/
|
|
3102
|
+
declare type ChildViewDestination = {
|
|
3103
|
+
/** Add the View to this existing window. */
|
|
3104
|
+
type: 'existing-window';
|
|
3105
|
+
identity: OpenFin.Identity;
|
|
3106
|
+
} | {
|
|
3107
|
+
/** Create a new window containing the View. */
|
|
3108
|
+
type: 'new-window';
|
|
3109
|
+
};
|
|
3110
|
+
|
|
3092
3111
|
/**
|
|
3093
3112
|
* Generated when a child Window is created.
|
|
3094
3113
|
* @interface
|
|
@@ -3101,22 +3120,7 @@ declare type ChildWindowCreatedEvent = ContentCreationRulesEvent & {
|
|
|
3101
3120
|
childOptions: OpenFin.WindowOptions;
|
|
3102
3121
|
};
|
|
3103
3122
|
|
|
3104
|
-
|
|
3105
|
-
* End of Interop Client Events
|
|
3106
|
-
*/
|
|
3107
|
-
/**
|
|
3108
|
-
* Client-side handle for the chrome-browser feature.
|
|
3109
|
-
*
|
|
3110
|
-
* For Chrome extension integration to be active on a window, that window must be
|
|
3111
|
-
* created with `chromeBrowser: true` in its window options. There is no separate
|
|
3112
|
-
* `init()` step.
|
|
3113
|
-
*/
|
|
3114
|
-
declare interface ChromeBrowser {
|
|
3115
|
-
/**
|
|
3116
|
-
* Extension action surface — observe and invoke installed Chrome extension actions.
|
|
3117
|
-
*/
|
|
3118
|
-
readonly Actions: ChromeBrowserActions;
|
|
3119
|
-
}
|
|
3123
|
+
/* Excluded from this release type: ChromeBrowser */
|
|
3120
3124
|
|
|
3121
3125
|
/**
|
|
3122
3126
|
* APIs for interacting with Chromium extension actions from an initialized ChromeBrowser window.
|
|
@@ -3886,14 +3890,7 @@ declare type ConstWindowOptions = {
|
|
|
3886
3890
|
* @default false
|
|
3887
3891
|
*/
|
|
3888
3892
|
backgroundThrottling: boolean;
|
|
3889
|
-
|
|
3890
|
-
* If `true`, the window is registered with Chromium as a `ChromeBrowser`,
|
|
3891
|
-
* making it visible to Chrome extensions via the `chrome.windows` API.
|
|
3892
|
-
* The window must be created with this option set; it cannot be flipped at runtime.
|
|
3893
|
-
*
|
|
3894
|
-
* @defaultValue false
|
|
3895
|
-
*/
|
|
3896
|
-
chromeBrowser: boolean;
|
|
3893
|
+
/* Excluded from this release type: chromeBrowser */
|
|
3897
3894
|
/**
|
|
3898
3895
|
* Configures how new content (e,g, from `window.open` or a link) is opened.
|
|
3899
3896
|
*/
|
|
@@ -3983,6 +3980,12 @@ declare type ConstWindowOptions = {
|
|
|
3983
3980
|
* triggered by the window itself, or a view targeting the window.
|
|
3984
3981
|
*/
|
|
3985
3982
|
downloadShelf: DownloadShelfOptions;
|
|
3983
|
+
/**
|
|
3984
|
+
* @defaultValue true
|
|
3985
|
+
*
|
|
3986
|
+
* Show the window's frame.
|
|
3987
|
+
*/
|
|
3988
|
+
frame: boolean;
|
|
3986
3989
|
height: number;
|
|
3987
3990
|
layout: any;
|
|
3988
3991
|
/**
|
|
@@ -5633,6 +5636,11 @@ declare type ExtensionTabCreatedEvent = BaseEvent_5 & {
|
|
|
5633
5636
|
type: 'extension-tab-created';
|
|
5634
5637
|
/** Identity of the auto-created view backing the new tab. */
|
|
5635
5638
|
viewIdentity: OpenFin.Identity;
|
|
5639
|
+
/**
|
|
5640
|
+
* Recommended placement for the auto-created View. This is complementary to `disposition`, which
|
|
5641
|
+
* describes the requested browser creation behavior.
|
|
5642
|
+
*/
|
|
5643
|
+
destination: WebContentsEvents.ChildViewDestination;
|
|
5636
5644
|
/**
|
|
5637
5645
|
* Identity of the view that was active when the extension triggered tab creation.
|
|
5638
5646
|
* Undefined if no tab was active (e.g. the first tab in a newly-opened window).
|
|
@@ -6393,7 +6401,7 @@ declare interface FinApi<MeType extends OpenFin.EntityType> {
|
|
|
6393
6401
|
readonly Interop: InteropModule;
|
|
6394
6402
|
readonly SnapshotSource: SnapshotSourceModule;
|
|
6395
6403
|
readonly NotificationManager: NotificationManagerModule;
|
|
6396
|
-
|
|
6404
|
+
/* Excluded from this release type: ChromeBrowser */
|
|
6397
6405
|
/**
|
|
6398
6406
|
* Provides access to the OpenFin representation of the current code context (usually an entity
|
|
6399
6407
|
* such as a {@link OpenFin.View} or {@link OpenFin.Window}), as well as to the current `Interop` context.
|
|
@@ -9598,7 +9606,7 @@ declare type LayoutSyncApi = {
|
|
|
9598
9606
|
/**
|
|
9599
9607
|
* @interface
|
|
9600
9608
|
*/
|
|
9601
|
-
declare type LegacyWinOptionsInAppOptions = Pick<WindowCreationOptions, 'accelerator' | 'alwaysOnTop' | 'api' | 'aspectRatio' | 'autoplayPolicy' | 'autoShow' | 'backgroundColor' | 'contentNavigation' | 'contextMenu' | 'cornerRounding' | 'customData' | 'customRequestHeaders' | 'defaultCentered' | 'defaultHeight' | 'defaultLeft' | 'defaultTop' | 'defaultWidth' | '
|
|
9609
|
+
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'>;
|
|
9602
9610
|
|
|
9603
9611
|
declare type Listener<T extends {
|
|
9604
9612
|
type: string;
|
|
@@ -10279,16 +10287,6 @@ declare type MutableWindowOptions = {
|
|
|
10279
10287
|
* _When omitted, _inherits_ from the parent application._
|
|
10280
10288
|
*/
|
|
10281
10289
|
customData: any;
|
|
10282
|
-
/**
|
|
10283
|
-
*
|
|
10284
|
-
* Show the window's frame.
|
|
10285
|
-
*
|
|
10286
|
-
* @remarks
|
|
10287
|
-
* This property will not be updatable starting runtime version 45.
|
|
10288
|
-
*
|
|
10289
|
-
* @default true
|
|
10290
|
-
*/
|
|
10291
|
-
frame: boolean;
|
|
10292
10290
|
/**
|
|
10293
10291
|
* Hides the window instead of closing it when the close button is pressed.
|
|
10294
10292
|
*
|
|
@@ -20010,6 +20008,7 @@ declare namespace WebContentsEvents {
|
|
|
20010
20008
|
ContentCreationRulesEvent,
|
|
20011
20009
|
ChildContentBlockedEvent,
|
|
20012
20010
|
ChildContentOpenedInBrowserEvent,
|
|
20011
|
+
ChildViewDestination,
|
|
20013
20012
|
ChildViewCreatedEvent,
|
|
20014
20013
|
ChildWindowCreatedEvent,
|
|
20015
20014
|
FileDownloadEvent,
|
package/out/fdc3-api-beta.d.ts
CHANGED
|
@@ -3083,12 +3083,31 @@ declare interface ChildContentOptions {
|
|
|
3083
3083
|
*/
|
|
3084
3084
|
declare type ChildViewCreatedEvent = ContentCreationRulesEvent & {
|
|
3085
3085
|
type: 'child-view-created';
|
|
3086
|
+
/**
|
|
3087
|
+
* Recommended placement for the already-created child View.
|
|
3088
|
+
*
|
|
3089
|
+
* This is complementary to `disposition`: `disposition` describes the requested browser creation
|
|
3090
|
+
* behavior, while `destination` describes where the resulting View should be placed.
|
|
3091
|
+
*/
|
|
3092
|
+
destination: ChildViewDestination;
|
|
3086
3093
|
/**
|
|
3087
3094
|
* The options the child View was created with.
|
|
3088
3095
|
*/
|
|
3089
3096
|
childOptions: OpenFin.ViewOptions;
|
|
3090
3097
|
};
|
|
3091
3098
|
|
|
3099
|
+
/**
|
|
3100
|
+
* Describes where an already-created View should be placed.
|
|
3101
|
+
*/
|
|
3102
|
+
declare type ChildViewDestination = {
|
|
3103
|
+
/** Add the View to this existing window. */
|
|
3104
|
+
type: 'existing-window';
|
|
3105
|
+
identity: OpenFin.Identity;
|
|
3106
|
+
} | {
|
|
3107
|
+
/** Create a new window containing the View. */
|
|
3108
|
+
type: 'new-window';
|
|
3109
|
+
};
|
|
3110
|
+
|
|
3092
3111
|
/**
|
|
3093
3112
|
* Generated when a child Window is created.
|
|
3094
3113
|
* @interface
|
|
@@ -3101,22 +3120,7 @@ declare type ChildWindowCreatedEvent = ContentCreationRulesEvent & {
|
|
|
3101
3120
|
childOptions: OpenFin.WindowOptions;
|
|
3102
3121
|
};
|
|
3103
3122
|
|
|
3104
|
-
|
|
3105
|
-
* End of Interop Client Events
|
|
3106
|
-
*/
|
|
3107
|
-
/**
|
|
3108
|
-
* Client-side handle for the chrome-browser feature.
|
|
3109
|
-
*
|
|
3110
|
-
* For Chrome extension integration to be active on a window, that window must be
|
|
3111
|
-
* created with `chromeBrowser: true` in its window options. There is no separate
|
|
3112
|
-
* `init()` step.
|
|
3113
|
-
*/
|
|
3114
|
-
declare interface ChromeBrowser {
|
|
3115
|
-
/**
|
|
3116
|
-
* Extension action surface — observe and invoke installed Chrome extension actions.
|
|
3117
|
-
*/
|
|
3118
|
-
readonly Actions: ChromeBrowserActions;
|
|
3119
|
-
}
|
|
3123
|
+
/* Excluded from this release type: ChromeBrowser */
|
|
3120
3124
|
|
|
3121
3125
|
/**
|
|
3122
3126
|
* APIs for interacting with Chromium extension actions from an initialized ChromeBrowser window.
|
|
@@ -3886,14 +3890,7 @@ declare type ConstWindowOptions = {
|
|
|
3886
3890
|
* @default false
|
|
3887
3891
|
*/
|
|
3888
3892
|
backgroundThrottling: boolean;
|
|
3889
|
-
|
|
3890
|
-
* If `true`, the window is registered with Chromium as a `ChromeBrowser`,
|
|
3891
|
-
* making it visible to Chrome extensions via the `chrome.windows` API.
|
|
3892
|
-
* The window must be created with this option set; it cannot be flipped at runtime.
|
|
3893
|
-
*
|
|
3894
|
-
* @defaultValue false
|
|
3895
|
-
*/
|
|
3896
|
-
chromeBrowser: boolean;
|
|
3893
|
+
/* Excluded from this release type: chromeBrowser */
|
|
3897
3894
|
/**
|
|
3898
3895
|
* Configures how new content (e,g, from `window.open` or a link) is opened.
|
|
3899
3896
|
*/
|
|
@@ -3983,6 +3980,12 @@ declare type ConstWindowOptions = {
|
|
|
3983
3980
|
* triggered by the window itself, or a view targeting the window.
|
|
3984
3981
|
*/
|
|
3985
3982
|
downloadShelf: DownloadShelfOptions;
|
|
3983
|
+
/**
|
|
3984
|
+
* @defaultValue true
|
|
3985
|
+
*
|
|
3986
|
+
* Show the window's frame.
|
|
3987
|
+
*/
|
|
3988
|
+
frame: boolean;
|
|
3986
3989
|
height: number;
|
|
3987
3990
|
layout: any;
|
|
3988
3991
|
/**
|
|
@@ -5633,6 +5636,11 @@ declare type ExtensionTabCreatedEvent = BaseEvent_5 & {
|
|
|
5633
5636
|
type: 'extension-tab-created';
|
|
5634
5637
|
/** Identity of the auto-created view backing the new tab. */
|
|
5635
5638
|
viewIdentity: OpenFin.Identity;
|
|
5639
|
+
/**
|
|
5640
|
+
* Recommended placement for the auto-created View. This is complementary to `disposition`, which
|
|
5641
|
+
* describes the requested browser creation behavior.
|
|
5642
|
+
*/
|
|
5643
|
+
destination: WebContentsEvents.ChildViewDestination;
|
|
5636
5644
|
/**
|
|
5637
5645
|
* Identity of the view that was active when the extension triggered tab creation.
|
|
5638
5646
|
* Undefined if no tab was active (e.g. the first tab in a newly-opened window).
|
|
@@ -6393,7 +6401,7 @@ declare interface FinApi<MeType extends OpenFin.EntityType> {
|
|
|
6393
6401
|
readonly Interop: InteropModule;
|
|
6394
6402
|
readonly SnapshotSource: SnapshotSourceModule;
|
|
6395
6403
|
readonly NotificationManager: NotificationManagerModule;
|
|
6396
|
-
|
|
6404
|
+
/* Excluded from this release type: ChromeBrowser */
|
|
6397
6405
|
/**
|
|
6398
6406
|
* Provides access to the OpenFin representation of the current code context (usually an entity
|
|
6399
6407
|
* such as a {@link OpenFin.View} or {@link OpenFin.Window}), as well as to the current `Interop` context.
|
|
@@ -9598,7 +9606,7 @@ declare type LayoutSyncApi = {
|
|
|
9598
9606
|
/**
|
|
9599
9607
|
* @interface
|
|
9600
9608
|
*/
|
|
9601
|
-
declare type LegacyWinOptionsInAppOptions = Pick<WindowCreationOptions, 'accelerator' | 'alwaysOnTop' | 'api' | 'aspectRatio' | 'autoplayPolicy' | 'autoShow' | 'backgroundColor' | 'contentNavigation' | 'contextMenu' | 'cornerRounding' | 'customData' | 'customRequestHeaders' | 'defaultCentered' | 'defaultHeight' | 'defaultLeft' | 'defaultTop' | 'defaultWidth' | '
|
|
9609
|
+
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'>;
|
|
9602
9610
|
|
|
9603
9611
|
declare type Listener<T extends {
|
|
9604
9612
|
type: string;
|
|
@@ -10279,16 +10287,6 @@ declare type MutableWindowOptions = {
|
|
|
10279
10287
|
* _When omitted, _inherits_ from the parent application._
|
|
10280
10288
|
*/
|
|
10281
10289
|
customData: any;
|
|
10282
|
-
/**
|
|
10283
|
-
*
|
|
10284
|
-
* Show the window's frame.
|
|
10285
|
-
*
|
|
10286
|
-
* @remarks
|
|
10287
|
-
* This property will not be updatable starting runtime version 45.
|
|
10288
|
-
*
|
|
10289
|
-
* @default true
|
|
10290
|
-
*/
|
|
10291
|
-
frame: boolean;
|
|
10292
10290
|
/**
|
|
10293
10291
|
* Hides the window instead of closing it when the close button is pressed.
|
|
10294
10292
|
*
|
|
@@ -20010,6 +20008,7 @@ declare namespace WebContentsEvents {
|
|
|
20010
20008
|
ContentCreationRulesEvent,
|
|
20011
20009
|
ChildContentBlockedEvent,
|
|
20012
20010
|
ChildContentOpenedInBrowserEvent,
|
|
20011
|
+
ChildViewDestination,
|
|
20013
20012
|
ChildViewCreatedEvent,
|
|
20014
20013
|
ChildWindowCreatedEvent,
|
|
20015
20014
|
FileDownloadEvent,
|
package/out/fdc3-api-public.d.ts
CHANGED
|
@@ -3083,12 +3083,31 @@ declare interface ChildContentOptions {
|
|
|
3083
3083
|
*/
|
|
3084
3084
|
declare type ChildViewCreatedEvent = ContentCreationRulesEvent & {
|
|
3085
3085
|
type: 'child-view-created';
|
|
3086
|
+
/**
|
|
3087
|
+
* Recommended placement for the already-created child View.
|
|
3088
|
+
*
|
|
3089
|
+
* This is complementary to `disposition`: `disposition` describes the requested browser creation
|
|
3090
|
+
* behavior, while `destination` describes where the resulting View should be placed.
|
|
3091
|
+
*/
|
|
3092
|
+
destination: ChildViewDestination;
|
|
3086
3093
|
/**
|
|
3087
3094
|
* The options the child View was created with.
|
|
3088
3095
|
*/
|
|
3089
3096
|
childOptions: OpenFin.ViewOptions;
|
|
3090
3097
|
};
|
|
3091
3098
|
|
|
3099
|
+
/**
|
|
3100
|
+
* Describes where an already-created View should be placed.
|
|
3101
|
+
*/
|
|
3102
|
+
declare type ChildViewDestination = {
|
|
3103
|
+
/** Add the View to this existing window. */
|
|
3104
|
+
type: 'existing-window';
|
|
3105
|
+
identity: OpenFin.Identity;
|
|
3106
|
+
} | {
|
|
3107
|
+
/** Create a new window containing the View. */
|
|
3108
|
+
type: 'new-window';
|
|
3109
|
+
};
|
|
3110
|
+
|
|
3092
3111
|
/**
|
|
3093
3112
|
* Generated when a child Window is created.
|
|
3094
3113
|
* @interface
|
|
@@ -3101,22 +3120,7 @@ declare type ChildWindowCreatedEvent = ContentCreationRulesEvent & {
|
|
|
3101
3120
|
childOptions: OpenFin.WindowOptions;
|
|
3102
3121
|
};
|
|
3103
3122
|
|
|
3104
|
-
|
|
3105
|
-
* End of Interop Client Events
|
|
3106
|
-
*/
|
|
3107
|
-
/**
|
|
3108
|
-
* Client-side handle for the chrome-browser feature.
|
|
3109
|
-
*
|
|
3110
|
-
* For Chrome extension integration to be active on a window, that window must be
|
|
3111
|
-
* created with `chromeBrowser: true` in its window options. There is no separate
|
|
3112
|
-
* `init()` step.
|
|
3113
|
-
*/
|
|
3114
|
-
declare interface ChromeBrowser {
|
|
3115
|
-
/**
|
|
3116
|
-
* Extension action surface — observe and invoke installed Chrome extension actions.
|
|
3117
|
-
*/
|
|
3118
|
-
readonly Actions: ChromeBrowserActions;
|
|
3119
|
-
}
|
|
3123
|
+
/* Excluded from this release type: ChromeBrowser */
|
|
3120
3124
|
|
|
3121
3125
|
/**
|
|
3122
3126
|
* APIs for interacting with Chromium extension actions from an initialized ChromeBrowser window.
|
|
@@ -3886,14 +3890,7 @@ declare type ConstWindowOptions = {
|
|
|
3886
3890
|
* @default false
|
|
3887
3891
|
*/
|
|
3888
3892
|
backgroundThrottling: boolean;
|
|
3889
|
-
|
|
3890
|
-
* If `true`, the window is registered with Chromium as a `ChromeBrowser`,
|
|
3891
|
-
* making it visible to Chrome extensions via the `chrome.windows` API.
|
|
3892
|
-
* The window must be created with this option set; it cannot be flipped at runtime.
|
|
3893
|
-
*
|
|
3894
|
-
* @defaultValue false
|
|
3895
|
-
*/
|
|
3896
|
-
chromeBrowser: boolean;
|
|
3893
|
+
/* Excluded from this release type: chromeBrowser */
|
|
3897
3894
|
/**
|
|
3898
3895
|
* Configures how new content (e,g, from `window.open` or a link) is opened.
|
|
3899
3896
|
*/
|
|
@@ -3983,6 +3980,12 @@ declare type ConstWindowOptions = {
|
|
|
3983
3980
|
* triggered by the window itself, or a view targeting the window.
|
|
3984
3981
|
*/
|
|
3985
3982
|
downloadShelf: DownloadShelfOptions;
|
|
3983
|
+
/**
|
|
3984
|
+
* @defaultValue true
|
|
3985
|
+
*
|
|
3986
|
+
* Show the window's frame.
|
|
3987
|
+
*/
|
|
3988
|
+
frame: boolean;
|
|
3986
3989
|
height: number;
|
|
3987
3990
|
layout: any;
|
|
3988
3991
|
/**
|
|
@@ -5633,6 +5636,11 @@ declare type ExtensionTabCreatedEvent = BaseEvent_5 & {
|
|
|
5633
5636
|
type: 'extension-tab-created';
|
|
5634
5637
|
/** Identity of the auto-created view backing the new tab. */
|
|
5635
5638
|
viewIdentity: OpenFin.Identity;
|
|
5639
|
+
/**
|
|
5640
|
+
* Recommended placement for the auto-created View. This is complementary to `disposition`, which
|
|
5641
|
+
* describes the requested browser creation behavior.
|
|
5642
|
+
*/
|
|
5643
|
+
destination: WebContentsEvents.ChildViewDestination;
|
|
5636
5644
|
/**
|
|
5637
5645
|
* Identity of the view that was active when the extension triggered tab creation.
|
|
5638
5646
|
* Undefined if no tab was active (e.g. the first tab in a newly-opened window).
|
|
@@ -6393,7 +6401,7 @@ declare interface FinApi<MeType extends OpenFin.EntityType> {
|
|
|
6393
6401
|
readonly Interop: InteropModule;
|
|
6394
6402
|
readonly SnapshotSource: SnapshotSourceModule;
|
|
6395
6403
|
readonly NotificationManager: NotificationManagerModule;
|
|
6396
|
-
|
|
6404
|
+
/* Excluded from this release type: ChromeBrowser */
|
|
6397
6405
|
/**
|
|
6398
6406
|
* Provides access to the OpenFin representation of the current code context (usually an entity
|
|
6399
6407
|
* such as a {@link OpenFin.View} or {@link OpenFin.Window}), as well as to the current `Interop` context.
|
|
@@ -9598,7 +9606,7 @@ declare type LayoutSyncApi = {
|
|
|
9598
9606
|
/**
|
|
9599
9607
|
* @interface
|
|
9600
9608
|
*/
|
|
9601
|
-
declare type LegacyWinOptionsInAppOptions = Pick<WindowCreationOptions, 'accelerator' | 'alwaysOnTop' | 'api' | 'aspectRatio' | 'autoplayPolicy' | 'autoShow' | 'backgroundColor' | 'contentNavigation' | 'contextMenu' | 'cornerRounding' | 'customData' | 'customRequestHeaders' | 'defaultCentered' | 'defaultHeight' | 'defaultLeft' | 'defaultTop' | 'defaultWidth' | '
|
|
9609
|
+
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'>;
|
|
9602
9610
|
|
|
9603
9611
|
declare type Listener<T extends {
|
|
9604
9612
|
type: string;
|
|
@@ -10279,16 +10287,6 @@ declare type MutableWindowOptions = {
|
|
|
10279
10287
|
* _When omitted, _inherits_ from the parent application._
|
|
10280
10288
|
*/
|
|
10281
10289
|
customData: any;
|
|
10282
|
-
/**
|
|
10283
|
-
*
|
|
10284
|
-
* Show the window's frame.
|
|
10285
|
-
*
|
|
10286
|
-
* @remarks
|
|
10287
|
-
* This property will not be updatable starting runtime version 45.
|
|
10288
|
-
*
|
|
10289
|
-
* @default true
|
|
10290
|
-
*/
|
|
10291
|
-
frame: boolean;
|
|
10292
10290
|
/**
|
|
10293
10291
|
* Hides the window instead of closing it when the close button is pressed.
|
|
10294
10292
|
*
|
|
@@ -20010,6 +20008,7 @@ declare namespace WebContentsEvents {
|
|
|
20010
20008
|
ContentCreationRulesEvent,
|
|
20011
20009
|
ChildContentBlockedEvent,
|
|
20012
20010
|
ChildContentOpenedInBrowserEvent,
|
|
20011
|
+
ChildViewDestination,
|
|
20013
20012
|
ChildViewCreatedEvent,
|
|
20014
20013
|
ChildWindowCreatedEvent,
|
|
20015
20014
|
FileDownloadEvent,
|
package/out/fdc3-api.d.ts
CHANGED
|
@@ -3139,12 +3139,31 @@ declare interface ChildContentOptions {
|
|
|
3139
3139
|
*/
|
|
3140
3140
|
declare type ChildViewCreatedEvent = ContentCreationRulesEvent & {
|
|
3141
3141
|
type: 'child-view-created';
|
|
3142
|
+
/**
|
|
3143
|
+
* Recommended placement for the already-created child View.
|
|
3144
|
+
*
|
|
3145
|
+
* This is complementary to `disposition`: `disposition` describes the requested browser creation
|
|
3146
|
+
* behavior, while `destination` describes where the resulting View should be placed.
|
|
3147
|
+
*/
|
|
3148
|
+
destination: ChildViewDestination;
|
|
3142
3149
|
/**
|
|
3143
3150
|
* The options the child View was created with.
|
|
3144
3151
|
*/
|
|
3145
3152
|
childOptions: OpenFin.ViewOptions;
|
|
3146
3153
|
};
|
|
3147
3154
|
|
|
3155
|
+
/**
|
|
3156
|
+
* Describes where an already-created View should be placed.
|
|
3157
|
+
*/
|
|
3158
|
+
declare type ChildViewDestination = {
|
|
3159
|
+
/** Add the View to this existing window. */
|
|
3160
|
+
type: 'existing-window';
|
|
3161
|
+
identity: OpenFin.Identity;
|
|
3162
|
+
} | {
|
|
3163
|
+
/** Create a new window containing the View. */
|
|
3164
|
+
type: 'new-window';
|
|
3165
|
+
};
|
|
3166
|
+
|
|
3148
3167
|
/**
|
|
3149
3168
|
* Generated when a child Window is created.
|
|
3150
3169
|
* @interface
|
|
@@ -3163,9 +3182,16 @@ declare type ChildWindowCreatedEvent = ContentCreationRulesEvent & {
|
|
|
3163
3182
|
/**
|
|
3164
3183
|
* Client-side handle for the chrome-browser feature.
|
|
3165
3184
|
*
|
|
3166
|
-
* For
|
|
3167
|
-
* created with `chromeBrowser: true` in its window options.
|
|
3168
|
-
*
|
|
3185
|
+
* For extension integration to be active on a window, that window must be
|
|
3186
|
+
* created with `chromeBrowser: true` in its window options.
|
|
3187
|
+
*
|
|
3188
|
+
* @remarks
|
|
3189
|
+
* This namespace is intended for internal experimentation only. Enabling the
|
|
3190
|
+
* `chromeBrowser` window option changes how the runtime manages content and standard
|
|
3191
|
+
* OpenFin content behavior is not guaranteed.
|
|
3192
|
+
*
|
|
3193
|
+
* @internal
|
|
3194
|
+
* @experimental This API is under active development and may change or be removed without notice.
|
|
3169
3195
|
*/
|
|
3170
3196
|
declare interface ChromeBrowser {
|
|
3171
3197
|
/**
|
|
@@ -3946,13 +3972,27 @@ declare type ConstWindowOptions = {
|
|
|
3946
3972
|
*/
|
|
3947
3973
|
backgroundThrottling: boolean;
|
|
3948
3974
|
/**
|
|
3949
|
-
*
|
|
3950
|
-
*
|
|
3951
|
-
*
|
|
3975
|
+
* Registers the window with Chromium as a `ChromeBrowser`, making it visible to
|
|
3976
|
+
* Chrome extensions via the `chrome.windows` API. The window must be created with
|
|
3977
|
+
* this option set; it cannot be flipped at runtime.
|
|
3952
3978
|
*
|
|
3979
|
+
* Pass `true` (equivalent to `{ type: 'normal' }`) to register as a normal tabbed
|
|
3980
|
+
* chrome-browser host, or `{ type: 'popup' }` to register as a popup chrome-browser
|
|
3981
|
+
* host (no tab strip; the window's own content is the single tab) — the same
|
|
3982
|
+
* registration that `window.open` popups and extension popups receive internally.
|
|
3983
|
+
*
|
|
3984
|
+
* @remarks
|
|
3985
|
+
* Enabling this option changes how Chromium manages the window's content. Standard
|
|
3986
|
+
* OpenFin content behavior is not guaranteed; for example, configured
|
|
3987
|
+
* {@link ContentCreationOptions content creation rules} will no longer be respected.
|
|
3988
|
+
*
|
|
3989
|
+
* @internal
|
|
3990
|
+
* @experimental This option is under active development and may change or be removed without notice.
|
|
3953
3991
|
* @defaultValue false
|
|
3954
3992
|
*/
|
|
3955
|
-
chromeBrowser: boolean
|
|
3993
|
+
chromeBrowser: boolean | {
|
|
3994
|
+
type: 'normal' | 'popup';
|
|
3995
|
+
};
|
|
3956
3996
|
/**
|
|
3957
3997
|
* Configures how new content (e,g, from `window.open` or a link) is opened.
|
|
3958
3998
|
*/
|
|
@@ -4042,6 +4082,12 @@ declare type ConstWindowOptions = {
|
|
|
4042
4082
|
* triggered by the window itself, or a view targeting the window.
|
|
4043
4083
|
*/
|
|
4044
4084
|
downloadShelf: DownloadShelfOptions;
|
|
4085
|
+
/**
|
|
4086
|
+
* @defaultValue true
|
|
4087
|
+
*
|
|
4088
|
+
* Show the window's frame.
|
|
4089
|
+
*/
|
|
4090
|
+
frame: boolean;
|
|
4045
4091
|
height: number;
|
|
4046
4092
|
layout: any;
|
|
4047
4093
|
/**
|
|
@@ -5715,6 +5761,11 @@ declare type ExtensionTabCreatedEvent = BaseEvent_5 & {
|
|
|
5715
5761
|
type: 'extension-tab-created';
|
|
5716
5762
|
/** Identity of the auto-created view backing the new tab. */
|
|
5717
5763
|
viewIdentity: OpenFin.Identity;
|
|
5764
|
+
/**
|
|
5765
|
+
* Recommended placement for the auto-created View. This is complementary to `disposition`, which
|
|
5766
|
+
* describes the requested browser creation behavior.
|
|
5767
|
+
*/
|
|
5768
|
+
destination: WebContentsEvents.ChildViewDestination;
|
|
5718
5769
|
/**
|
|
5719
5770
|
* Identity of the view that was active when the extension triggered tab creation.
|
|
5720
5771
|
* Undefined if no tab was active (e.g. the first tab in a newly-opened window).
|
|
@@ -6478,6 +6529,12 @@ declare interface FinApi<MeType extends OpenFin.EntityType> {
|
|
|
6478
6529
|
readonly Interop: InteropModule;
|
|
6479
6530
|
readonly SnapshotSource: SnapshotSourceModule;
|
|
6480
6531
|
readonly NotificationManager: NotificationManagerModule;
|
|
6532
|
+
/**
|
|
6533
|
+
* Internal, experimental APIs for Chrome extension integration.
|
|
6534
|
+
*
|
|
6535
|
+
* @internal
|
|
6536
|
+
* @experimental This API may change or be removed without notice.
|
|
6537
|
+
*/
|
|
6481
6538
|
readonly ChromeBrowser: OpenFin.ChromeBrowser;
|
|
6482
6539
|
/**
|
|
6483
6540
|
* Provides access to the OpenFin representation of the current code context (usually an entity
|
|
@@ -9907,7 +9964,7 @@ declare type LayoutSyncApi = {
|
|
|
9907
9964
|
/**
|
|
9908
9965
|
* @interface
|
|
9909
9966
|
*/
|
|
9910
|
-
declare type LegacyWinOptionsInAppOptions = Pick<WindowCreationOptions, 'accelerator' | 'alwaysOnTop' | 'api' | 'aspectRatio' | 'autoplayPolicy' | 'autoShow' | 'backgroundColor' | 'contentNavigation' | 'contextMenu' | 'cornerRounding' | 'customData' | 'customRequestHeaders' | 'defaultCentered' | 'defaultHeight' | 'defaultLeft' | 'defaultTop' | 'defaultWidth' | '
|
|
9967
|
+
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'>;
|
|
9911
9968
|
|
|
9912
9969
|
declare type Listener<T extends {
|
|
9913
9970
|
type: string;
|
|
@@ -10592,16 +10649,6 @@ declare type MutableWindowOptions = {
|
|
|
10592
10649
|
* _When omitted, _inherits_ from the parent application._
|
|
10593
10650
|
*/
|
|
10594
10651
|
customData: any;
|
|
10595
|
-
/**
|
|
10596
|
-
*
|
|
10597
|
-
* Show the window's frame.
|
|
10598
|
-
*
|
|
10599
|
-
* @remarks
|
|
10600
|
-
* This property will not be updatable starting runtime version 45.
|
|
10601
|
-
*
|
|
10602
|
-
* @default true
|
|
10603
|
-
*/
|
|
10604
|
-
frame: boolean;
|
|
10605
10652
|
/**
|
|
10606
10653
|
* Hides the window instead of closing it when the close button is pressed.
|
|
10607
10654
|
*
|
|
@@ -20477,6 +20524,7 @@ declare namespace WebContentsEvents {
|
|
|
20477
20524
|
ContentCreationRulesEvent,
|
|
20478
20525
|
ChildContentBlockedEvent,
|
|
20479
20526
|
ChildContentOpenedInBrowserEvent,
|
|
20527
|
+
ChildViewDestination,
|
|
20480
20528
|
ChildViewCreatedEvent,
|
|
20481
20529
|
ChildWindowCreatedEvent,
|
|
20482
20530
|
FileDownloadEvent,
|