@openfin/core 42.100.11 → 42.100.13
Sign up to get free protection for your applications and to get access to all the features.
- package/out/mock-alpha.d.ts +33 -27
- package/out/mock-beta.d.ts +33 -27
- package/out/mock-public.d.ts +33 -27
- package/out/stub.d.ts +33 -27
- package/package.json +1 -1
package/out/mock-alpha.d.ts
CHANGED
@@ -84,12 +84,6 @@ declare type AlertRequestedEvent = BaseEvent_5 & {
|
|
84
84
|
url: string;
|
85
85
|
};
|
86
86
|
|
87
|
-
/**
|
88
|
-
* @interface
|
89
|
-
* A string literal union that represents possible values for behaviors in {@link DomainSettings}
|
90
|
-
*/
|
91
|
-
declare type AllowOrBlock = 'allow' | 'block';
|
92
|
-
|
93
87
|
declare type AnchorType = 'top-left' | 'top-right' | 'bottom-left' | 'bottom-right';
|
94
88
|
|
95
89
|
declare type AnyStrategy = ChannelStrategy<any>;
|
@@ -1691,7 +1685,7 @@ declare type BaseConfig = {
|
|
1691
1685
|
timeout?: number;
|
1692
1686
|
};
|
1693
1687
|
|
1694
|
-
declare type BaseContentBehavior =
|
1688
|
+
declare type BaseContentBehavior = 'allow' | 'block';
|
1695
1689
|
|
1696
1690
|
/**
|
1697
1691
|
* Properties shared by all content creation rules, regardless of context.
|
@@ -1836,10 +1830,6 @@ declare type BaseLoadFailedEvent = NamedEvent & {
|
|
1836
1830
|
isMainFrame: boolean;
|
1837
1831
|
};
|
1838
1832
|
|
1839
|
-
declare type BaseStructuredContentBehavior = {
|
1840
|
-
behavior: BaseContentBehavior;
|
1841
|
-
};
|
1842
|
-
|
1843
1833
|
declare type BaseUrlEvent = NamedEvent & {
|
1844
1834
|
type: 'url-changed';
|
1845
1835
|
url: string;
|
@@ -1940,11 +1930,15 @@ declare type BoundsDidChangeEvent = BoundsChangeEvent & {
|
|
1940
1930
|
|
1941
1931
|
declare type BoundsEvent = BaseEvent_5 & OpenFin_2.Bounds;
|
1942
1932
|
|
1933
|
+
/**
|
1934
|
+
* Opens matched URLs in the browser.
|
1935
|
+
*
|
1936
|
+
* @interface
|
1937
|
+
*/
|
1943
1938
|
declare type BrowserContentBehavior = {
|
1944
1939
|
behavior: 'browser';
|
1945
1940
|
/**
|
1946
|
-
*
|
1947
|
-
* When set to true will close the Window or View that tried to navigate or redirect to the blocked URL.
|
1941
|
+
* When true, closes the window or view that initiated the navigation.
|
1948
1942
|
*/
|
1949
1943
|
closeExisting?: boolean;
|
1950
1944
|
};
|
@@ -3255,6 +3249,7 @@ declare type ClipboardPasteBlockedEvent = NamedEvent & {
|
|
3255
3249
|
|
3256
3250
|
/**
|
3257
3251
|
* Clipboard Permissions
|
3252
|
+
* @interface
|
3258
3253
|
*/
|
3259
3254
|
declare type ClipboardPermissions = {
|
3260
3255
|
copy?: CopyPermissions;
|
@@ -3814,7 +3809,7 @@ declare type ContainerCreatedEvent = LayoutDOMEvent & {
|
|
3814
3809
|
};
|
3815
3810
|
|
3816
3811
|
/**
|
3817
|
-
*
|
3812
|
+
* Behavior when displaying content from matched URLs.
|
3818
3813
|
*
|
3819
3814
|
* 'allow': The content url is allowed.
|
3820
3815
|
* 'block': The content url is blocked.
|
@@ -4051,6 +4046,7 @@ declare type CopyBlockedEventReason = 'disabled';
|
|
4051
4046
|
|
4052
4047
|
/**
|
4053
4048
|
* Control copy operations for a matched URL.
|
4049
|
+
* @interface
|
4054
4050
|
*/
|
4055
4051
|
declare type CopyPermissions = {
|
4056
4052
|
/**
|
@@ -4062,7 +4058,7 @@ declare type CopyPermissions = {
|
|
4062
4058
|
* block: Disables all copy operations.
|
4063
4059
|
* protect: Protects any copied content. Only URLs that have set paste.behavior: 'all-content' will be allowed to paste this content.
|
4064
4060
|
*/
|
4065
|
-
behavior:
|
4061
|
+
behavior: 'allow' | 'block' | 'protect';
|
4066
4062
|
/**
|
4067
4063
|
* Additional copy operation options
|
4068
4064
|
*/
|
@@ -4303,6 +4299,7 @@ declare type DefaultDomainSettings = DomainSettings;
|
|
4303
4299
|
|
4304
4300
|
/**
|
4305
4301
|
* @deprecated Use {@link OpenFin.DomainSettingsRule} instead.
|
4302
|
+
* @interface
|
4306
4303
|
*/
|
4307
4304
|
declare type DefaultDomainSettingsRule = DomainSettingsRule;
|
4308
4305
|
|
@@ -4506,9 +4503,8 @@ declare type DomainSettings = {
|
|
4506
4503
|
};
|
4507
4504
|
|
4508
4505
|
/**
|
4509
|
-
* @interface
|
4510
|
-
*
|
4511
4506
|
* Defines domain-conditional settings for an OpenFin application.
|
4507
|
+
* @interface
|
4512
4508
|
*/
|
4513
4509
|
declare type DomainSettingsRule = {
|
4514
4510
|
/**
|
@@ -5466,6 +5462,7 @@ declare type FileDownloadProgressEvent = FileDownloadEvent & {
|
|
5466
5462
|
* Domain-conditional rules for file downloads.
|
5467
5463
|
*
|
5468
5464
|
* @remarks See: https://developers.openfin.co/of-docs/docs/file-download#manifest-properties-for-file-downloads
|
5465
|
+
* @interface
|
5469
5466
|
*/
|
5470
5467
|
declare type FileDownloadSettings = {
|
5471
5468
|
/**
|
@@ -7674,7 +7671,7 @@ declare type LaunchExternalProcessListener = (code: ExitCode) => void;
|
|
7674
7671
|
* @interface
|
7675
7672
|
*/
|
7676
7673
|
declare type LaunchExternalProcessRule = {
|
7677
|
-
behavior:
|
7674
|
+
behavior: 'allow' | 'block';
|
7678
7675
|
match: string[];
|
7679
7676
|
};
|
7680
7677
|
|
@@ -9675,12 +9672,10 @@ declare namespace OpenFin_2 {
|
|
9675
9672
|
DomainApiSettings,
|
9676
9673
|
BaseContentBehavior,
|
9677
9674
|
ContentBehavior,
|
9678
|
-
BaseStructuredContentBehavior,
|
9679
9675
|
BrowserContentBehavior,
|
9680
9676
|
StructuredContentBehavior,
|
9681
9677
|
StructuredContentPermissions,
|
9682
9678
|
ContentPermission,
|
9683
|
-
AllowOrBlock,
|
9684
9679
|
ScreenCaptureBehavior,
|
9685
9680
|
PerDomainSettings,
|
9686
9681
|
CopyPermissions,
|
@@ -9876,6 +9871,7 @@ declare type PasteBlockedEventReason = 'invalid-data' | 'disabled';
|
|
9876
9871
|
|
9877
9872
|
/**
|
9878
9873
|
* Control copy operations for a matched URL.
|
9874
|
+
* @interface
|
9879
9875
|
*/
|
9880
9876
|
declare type PastePermissions = {
|
9881
9877
|
/**
|
@@ -10046,11 +10042,11 @@ declare type PerDomainSettings = {
|
|
10046
10042
|
* Defaults to 'allow'.
|
10047
10043
|
* Disables the `print` option in the context menu, and prevents printing via both OpenFin and browser APIs.
|
10048
10044
|
*/
|
10049
|
-
print?:
|
10045
|
+
print?: 'allow' | 'block';
|
10050
10046
|
/**
|
10051
10047
|
* * Controls whether HTML5 dragging for this content is allowed or blocked.
|
10052
10048
|
*/
|
10053
|
-
drag?:
|
10049
|
+
drag?: 'allow' | 'block';
|
10054
10050
|
};
|
10055
10051
|
};
|
10056
10052
|
|
@@ -11446,6 +11442,14 @@ declare interface PlatformProvider {
|
|
11446
11442
|
* ```
|
11447
11443
|
*/
|
11448
11444
|
handleFailedViewCreation(viewIdentity: OpenFin_2.Identity, error: Error): Promise<OpenFin_2.ViewCreationSuccess | void>;
|
11445
|
+
/**
|
11446
|
+
* Determines whether a given window should prevent the application from quitting when it is closed.
|
11447
|
+
* This method is called when checking if closing a window should trigger application termination.
|
11448
|
+
*
|
11449
|
+
* @param windowIdentity - The identity of the window being checked.
|
11450
|
+
* @returns A promise resolving to `true` if the window should prevent the app from quitting, otherwise `false`.
|
11451
|
+
*/
|
11452
|
+
shouldWindowPreventQuit(windowIdentity: OpenFin_2.Identity): Promise<boolean>;
|
11449
11453
|
}
|
11450
11454
|
|
11451
11455
|
/**
|
@@ -13236,10 +13240,9 @@ declare type RvmLaunchOptions = {
|
|
13236
13240
|
};
|
13237
13241
|
|
13238
13242
|
/**
|
13239
|
-
* @interface
|
13240
13243
|
* Controls whether this content should be allowed or blocked when capturing the screen.
|
13241
13244
|
*/
|
13242
|
-
declare type ScreenCaptureBehavior =
|
13245
|
+
declare type ScreenCaptureBehavior = 'allow' | 'block';
|
13243
13246
|
|
13244
13247
|
/**
|
13245
13248
|
* Returned by getScreenCapturePermission. Includes sub-entity permission states and the resulting permission.
|
@@ -13728,12 +13731,15 @@ declare type StartedEvent = BaseEvents.IdentityEvent & {
|
|
13728
13731
|
};
|
13729
13732
|
|
13730
13733
|
/**
|
13731
|
-
*
|
13734
|
+
* Behavior when displaying content from matched URLs.
|
13732
13735
|
*/
|
13733
|
-
declare type StructuredContentBehavior =
|
13736
|
+
declare type StructuredContentBehavior = {
|
13737
|
+
behavior: BaseContentBehavior;
|
13738
|
+
} | BrowserContentBehavior;
|
13734
13739
|
|
13735
13740
|
/**
|
13736
|
-
*
|
13741
|
+
* Behavior when displaying content from matched URLs. Varies depending on type of navigation.
|
13742
|
+
* @interface
|
13737
13743
|
*/
|
13738
13744
|
declare type StructuredContentPermissions = {
|
13739
13745
|
/**
|
package/out/mock-beta.d.ts
CHANGED
@@ -84,12 +84,6 @@ declare type AlertRequestedEvent = BaseEvent_5 & {
|
|
84
84
|
url: string;
|
85
85
|
};
|
86
86
|
|
87
|
-
/**
|
88
|
-
* @interface
|
89
|
-
* A string literal union that represents possible values for behaviors in {@link DomainSettings}
|
90
|
-
*/
|
91
|
-
declare type AllowOrBlock = 'allow' | 'block';
|
92
|
-
|
93
87
|
declare type AnchorType = 'top-left' | 'top-right' | 'bottom-left' | 'bottom-right';
|
94
88
|
|
95
89
|
declare type AnyStrategy = ChannelStrategy<any>;
|
@@ -1691,7 +1685,7 @@ declare type BaseConfig = {
|
|
1691
1685
|
timeout?: number;
|
1692
1686
|
};
|
1693
1687
|
|
1694
|
-
declare type BaseContentBehavior =
|
1688
|
+
declare type BaseContentBehavior = 'allow' | 'block';
|
1695
1689
|
|
1696
1690
|
/**
|
1697
1691
|
* Properties shared by all content creation rules, regardless of context.
|
@@ -1836,10 +1830,6 @@ declare type BaseLoadFailedEvent = NamedEvent & {
|
|
1836
1830
|
isMainFrame: boolean;
|
1837
1831
|
};
|
1838
1832
|
|
1839
|
-
declare type BaseStructuredContentBehavior = {
|
1840
|
-
behavior: BaseContentBehavior;
|
1841
|
-
};
|
1842
|
-
|
1843
1833
|
declare type BaseUrlEvent = NamedEvent & {
|
1844
1834
|
type: 'url-changed';
|
1845
1835
|
url: string;
|
@@ -1940,11 +1930,15 @@ declare type BoundsDidChangeEvent = BoundsChangeEvent & {
|
|
1940
1930
|
|
1941
1931
|
declare type BoundsEvent = BaseEvent_5 & OpenFin_2.Bounds;
|
1942
1932
|
|
1933
|
+
/**
|
1934
|
+
* Opens matched URLs in the browser.
|
1935
|
+
*
|
1936
|
+
* @interface
|
1937
|
+
*/
|
1943
1938
|
declare type BrowserContentBehavior = {
|
1944
1939
|
behavior: 'browser';
|
1945
1940
|
/**
|
1946
|
-
*
|
1947
|
-
* When set to true will close the Window or View that tried to navigate or redirect to the blocked URL.
|
1941
|
+
* When true, closes the window or view that initiated the navigation.
|
1948
1942
|
*/
|
1949
1943
|
closeExisting?: boolean;
|
1950
1944
|
};
|
@@ -3255,6 +3249,7 @@ declare type ClipboardPasteBlockedEvent = NamedEvent & {
|
|
3255
3249
|
|
3256
3250
|
/**
|
3257
3251
|
* Clipboard Permissions
|
3252
|
+
* @interface
|
3258
3253
|
*/
|
3259
3254
|
declare type ClipboardPermissions = {
|
3260
3255
|
copy?: CopyPermissions;
|
@@ -3814,7 +3809,7 @@ declare type ContainerCreatedEvent = LayoutDOMEvent & {
|
|
3814
3809
|
};
|
3815
3810
|
|
3816
3811
|
/**
|
3817
|
-
*
|
3812
|
+
* Behavior when displaying content from matched URLs.
|
3818
3813
|
*
|
3819
3814
|
* 'allow': The content url is allowed.
|
3820
3815
|
* 'block': The content url is blocked.
|
@@ -4051,6 +4046,7 @@ declare type CopyBlockedEventReason = 'disabled';
|
|
4051
4046
|
|
4052
4047
|
/**
|
4053
4048
|
* Control copy operations for a matched URL.
|
4049
|
+
* @interface
|
4054
4050
|
*/
|
4055
4051
|
declare type CopyPermissions = {
|
4056
4052
|
/**
|
@@ -4062,7 +4058,7 @@ declare type CopyPermissions = {
|
|
4062
4058
|
* block: Disables all copy operations.
|
4063
4059
|
* protect: Protects any copied content. Only URLs that have set paste.behavior: 'all-content' will be allowed to paste this content.
|
4064
4060
|
*/
|
4065
|
-
behavior:
|
4061
|
+
behavior: 'allow' | 'block' | 'protect';
|
4066
4062
|
/**
|
4067
4063
|
* Additional copy operation options
|
4068
4064
|
*/
|
@@ -4303,6 +4299,7 @@ declare type DefaultDomainSettings = DomainSettings;
|
|
4303
4299
|
|
4304
4300
|
/**
|
4305
4301
|
* @deprecated Use {@link OpenFin.DomainSettingsRule} instead.
|
4302
|
+
* @interface
|
4306
4303
|
*/
|
4307
4304
|
declare type DefaultDomainSettingsRule = DomainSettingsRule;
|
4308
4305
|
|
@@ -4506,9 +4503,8 @@ declare type DomainSettings = {
|
|
4506
4503
|
};
|
4507
4504
|
|
4508
4505
|
/**
|
4509
|
-
* @interface
|
4510
|
-
*
|
4511
4506
|
* Defines domain-conditional settings for an OpenFin application.
|
4507
|
+
* @interface
|
4512
4508
|
*/
|
4513
4509
|
declare type DomainSettingsRule = {
|
4514
4510
|
/**
|
@@ -5466,6 +5462,7 @@ declare type FileDownloadProgressEvent = FileDownloadEvent & {
|
|
5466
5462
|
* Domain-conditional rules for file downloads.
|
5467
5463
|
*
|
5468
5464
|
* @remarks See: https://developers.openfin.co/of-docs/docs/file-download#manifest-properties-for-file-downloads
|
5465
|
+
* @interface
|
5469
5466
|
*/
|
5470
5467
|
declare type FileDownloadSettings = {
|
5471
5468
|
/**
|
@@ -7674,7 +7671,7 @@ declare type LaunchExternalProcessListener = (code: ExitCode) => void;
|
|
7674
7671
|
* @interface
|
7675
7672
|
*/
|
7676
7673
|
declare type LaunchExternalProcessRule = {
|
7677
|
-
behavior:
|
7674
|
+
behavior: 'allow' | 'block';
|
7678
7675
|
match: string[];
|
7679
7676
|
};
|
7680
7677
|
|
@@ -9675,12 +9672,10 @@ declare namespace OpenFin_2 {
|
|
9675
9672
|
DomainApiSettings,
|
9676
9673
|
BaseContentBehavior,
|
9677
9674
|
ContentBehavior,
|
9678
|
-
BaseStructuredContentBehavior,
|
9679
9675
|
BrowserContentBehavior,
|
9680
9676
|
StructuredContentBehavior,
|
9681
9677
|
StructuredContentPermissions,
|
9682
9678
|
ContentPermission,
|
9683
|
-
AllowOrBlock,
|
9684
9679
|
ScreenCaptureBehavior,
|
9685
9680
|
PerDomainSettings,
|
9686
9681
|
CopyPermissions,
|
@@ -9876,6 +9871,7 @@ declare type PasteBlockedEventReason = 'invalid-data' | 'disabled';
|
|
9876
9871
|
|
9877
9872
|
/**
|
9878
9873
|
* Control copy operations for a matched URL.
|
9874
|
+
* @interface
|
9879
9875
|
*/
|
9880
9876
|
declare type PastePermissions = {
|
9881
9877
|
/**
|
@@ -10046,11 +10042,11 @@ declare type PerDomainSettings = {
|
|
10046
10042
|
* Defaults to 'allow'.
|
10047
10043
|
* Disables the `print` option in the context menu, and prevents printing via both OpenFin and browser APIs.
|
10048
10044
|
*/
|
10049
|
-
print?:
|
10045
|
+
print?: 'allow' | 'block';
|
10050
10046
|
/**
|
10051
10047
|
* * Controls whether HTML5 dragging for this content is allowed or blocked.
|
10052
10048
|
*/
|
10053
|
-
drag?:
|
10049
|
+
drag?: 'allow' | 'block';
|
10054
10050
|
};
|
10055
10051
|
};
|
10056
10052
|
|
@@ -11446,6 +11442,14 @@ declare interface PlatformProvider {
|
|
11446
11442
|
* ```
|
11447
11443
|
*/
|
11448
11444
|
handleFailedViewCreation(viewIdentity: OpenFin_2.Identity, error: Error): Promise<OpenFin_2.ViewCreationSuccess | void>;
|
11445
|
+
/**
|
11446
|
+
* Determines whether a given window should prevent the application from quitting when it is closed.
|
11447
|
+
* This method is called when checking if closing a window should trigger application termination.
|
11448
|
+
*
|
11449
|
+
* @param windowIdentity - The identity of the window being checked.
|
11450
|
+
* @returns A promise resolving to `true` if the window should prevent the app from quitting, otherwise `false`.
|
11451
|
+
*/
|
11452
|
+
shouldWindowPreventQuit(windowIdentity: OpenFin_2.Identity): Promise<boolean>;
|
11449
11453
|
}
|
11450
11454
|
|
11451
11455
|
/**
|
@@ -13236,10 +13240,9 @@ declare type RvmLaunchOptions = {
|
|
13236
13240
|
};
|
13237
13241
|
|
13238
13242
|
/**
|
13239
|
-
* @interface
|
13240
13243
|
* Controls whether this content should be allowed or blocked when capturing the screen.
|
13241
13244
|
*/
|
13242
|
-
declare type ScreenCaptureBehavior =
|
13245
|
+
declare type ScreenCaptureBehavior = 'allow' | 'block';
|
13243
13246
|
|
13244
13247
|
/**
|
13245
13248
|
* Returned by getScreenCapturePermission. Includes sub-entity permission states and the resulting permission.
|
@@ -13728,12 +13731,15 @@ declare type StartedEvent = BaseEvents.IdentityEvent & {
|
|
13728
13731
|
};
|
13729
13732
|
|
13730
13733
|
/**
|
13731
|
-
*
|
13734
|
+
* Behavior when displaying content from matched URLs.
|
13732
13735
|
*/
|
13733
|
-
declare type StructuredContentBehavior =
|
13736
|
+
declare type StructuredContentBehavior = {
|
13737
|
+
behavior: BaseContentBehavior;
|
13738
|
+
} | BrowserContentBehavior;
|
13734
13739
|
|
13735
13740
|
/**
|
13736
|
-
*
|
13741
|
+
* Behavior when displaying content from matched URLs. Varies depending on type of navigation.
|
13742
|
+
* @interface
|
13737
13743
|
*/
|
13738
13744
|
declare type StructuredContentPermissions = {
|
13739
13745
|
/**
|
package/out/mock-public.d.ts
CHANGED
@@ -84,12 +84,6 @@ declare type AlertRequestedEvent = BaseEvent_5 & {
|
|
84
84
|
url: string;
|
85
85
|
};
|
86
86
|
|
87
|
-
/**
|
88
|
-
* @interface
|
89
|
-
* A string literal union that represents possible values for behaviors in {@link DomainSettings}
|
90
|
-
*/
|
91
|
-
declare type AllowOrBlock = 'allow' | 'block';
|
92
|
-
|
93
87
|
declare type AnchorType = 'top-left' | 'top-right' | 'bottom-left' | 'bottom-right';
|
94
88
|
|
95
89
|
declare type AnyStrategy = ChannelStrategy<any>;
|
@@ -1691,7 +1685,7 @@ declare type BaseConfig = {
|
|
1691
1685
|
timeout?: number;
|
1692
1686
|
};
|
1693
1687
|
|
1694
|
-
declare type BaseContentBehavior =
|
1688
|
+
declare type BaseContentBehavior = 'allow' | 'block';
|
1695
1689
|
|
1696
1690
|
/**
|
1697
1691
|
* Properties shared by all content creation rules, regardless of context.
|
@@ -1836,10 +1830,6 @@ declare type BaseLoadFailedEvent = NamedEvent & {
|
|
1836
1830
|
isMainFrame: boolean;
|
1837
1831
|
};
|
1838
1832
|
|
1839
|
-
declare type BaseStructuredContentBehavior = {
|
1840
|
-
behavior: BaseContentBehavior;
|
1841
|
-
};
|
1842
|
-
|
1843
1833
|
declare type BaseUrlEvent = NamedEvent & {
|
1844
1834
|
type: 'url-changed';
|
1845
1835
|
url: string;
|
@@ -1940,11 +1930,15 @@ declare type BoundsDidChangeEvent = BoundsChangeEvent & {
|
|
1940
1930
|
|
1941
1931
|
declare type BoundsEvent = BaseEvent_5 & OpenFin_2.Bounds;
|
1942
1932
|
|
1933
|
+
/**
|
1934
|
+
* Opens matched URLs in the browser.
|
1935
|
+
*
|
1936
|
+
* @interface
|
1937
|
+
*/
|
1943
1938
|
declare type BrowserContentBehavior = {
|
1944
1939
|
behavior: 'browser';
|
1945
1940
|
/**
|
1946
|
-
*
|
1947
|
-
* When set to true will close the Window or View that tried to navigate or redirect to the blocked URL.
|
1941
|
+
* When true, closes the window or view that initiated the navigation.
|
1948
1942
|
*/
|
1949
1943
|
closeExisting?: boolean;
|
1950
1944
|
};
|
@@ -3255,6 +3249,7 @@ declare type ClipboardPasteBlockedEvent = NamedEvent & {
|
|
3255
3249
|
|
3256
3250
|
/**
|
3257
3251
|
* Clipboard Permissions
|
3252
|
+
* @interface
|
3258
3253
|
*/
|
3259
3254
|
declare type ClipboardPermissions = {
|
3260
3255
|
copy?: CopyPermissions;
|
@@ -3814,7 +3809,7 @@ declare type ContainerCreatedEvent = LayoutDOMEvent & {
|
|
3814
3809
|
};
|
3815
3810
|
|
3816
3811
|
/**
|
3817
|
-
*
|
3812
|
+
* Behavior when displaying content from matched URLs.
|
3818
3813
|
*
|
3819
3814
|
* 'allow': The content url is allowed.
|
3820
3815
|
* 'block': The content url is blocked.
|
@@ -4051,6 +4046,7 @@ declare type CopyBlockedEventReason = 'disabled';
|
|
4051
4046
|
|
4052
4047
|
/**
|
4053
4048
|
* Control copy operations for a matched URL.
|
4049
|
+
* @interface
|
4054
4050
|
*/
|
4055
4051
|
declare type CopyPermissions = {
|
4056
4052
|
/**
|
@@ -4062,7 +4058,7 @@ declare type CopyPermissions = {
|
|
4062
4058
|
* block: Disables all copy operations.
|
4063
4059
|
* protect: Protects any copied content. Only URLs that have set paste.behavior: 'all-content' will be allowed to paste this content.
|
4064
4060
|
*/
|
4065
|
-
behavior:
|
4061
|
+
behavior: 'allow' | 'block' | 'protect';
|
4066
4062
|
/**
|
4067
4063
|
* Additional copy operation options
|
4068
4064
|
*/
|
@@ -4303,6 +4299,7 @@ declare type DefaultDomainSettings = DomainSettings;
|
|
4303
4299
|
|
4304
4300
|
/**
|
4305
4301
|
* @deprecated Use {@link OpenFin.DomainSettingsRule} instead.
|
4302
|
+
* @interface
|
4306
4303
|
*/
|
4307
4304
|
declare type DefaultDomainSettingsRule = DomainSettingsRule;
|
4308
4305
|
|
@@ -4506,9 +4503,8 @@ declare type DomainSettings = {
|
|
4506
4503
|
};
|
4507
4504
|
|
4508
4505
|
/**
|
4509
|
-
* @interface
|
4510
|
-
*
|
4511
4506
|
* Defines domain-conditional settings for an OpenFin application.
|
4507
|
+
* @interface
|
4512
4508
|
*/
|
4513
4509
|
declare type DomainSettingsRule = {
|
4514
4510
|
/**
|
@@ -5466,6 +5462,7 @@ declare type FileDownloadProgressEvent = FileDownloadEvent & {
|
|
5466
5462
|
* Domain-conditional rules for file downloads.
|
5467
5463
|
*
|
5468
5464
|
* @remarks See: https://developers.openfin.co/of-docs/docs/file-download#manifest-properties-for-file-downloads
|
5465
|
+
* @interface
|
5469
5466
|
*/
|
5470
5467
|
declare type FileDownloadSettings = {
|
5471
5468
|
/**
|
@@ -7674,7 +7671,7 @@ declare type LaunchExternalProcessListener = (code: ExitCode) => void;
|
|
7674
7671
|
* @interface
|
7675
7672
|
*/
|
7676
7673
|
declare type LaunchExternalProcessRule = {
|
7677
|
-
behavior:
|
7674
|
+
behavior: 'allow' | 'block';
|
7678
7675
|
match: string[];
|
7679
7676
|
};
|
7680
7677
|
|
@@ -9675,12 +9672,10 @@ declare namespace OpenFin_2 {
|
|
9675
9672
|
DomainApiSettings,
|
9676
9673
|
BaseContentBehavior,
|
9677
9674
|
ContentBehavior,
|
9678
|
-
BaseStructuredContentBehavior,
|
9679
9675
|
BrowserContentBehavior,
|
9680
9676
|
StructuredContentBehavior,
|
9681
9677
|
StructuredContentPermissions,
|
9682
9678
|
ContentPermission,
|
9683
|
-
AllowOrBlock,
|
9684
9679
|
ScreenCaptureBehavior,
|
9685
9680
|
PerDomainSettings,
|
9686
9681
|
CopyPermissions,
|
@@ -9876,6 +9871,7 @@ declare type PasteBlockedEventReason = 'invalid-data' | 'disabled';
|
|
9876
9871
|
|
9877
9872
|
/**
|
9878
9873
|
* Control copy operations for a matched URL.
|
9874
|
+
* @interface
|
9879
9875
|
*/
|
9880
9876
|
declare type PastePermissions = {
|
9881
9877
|
/**
|
@@ -10046,11 +10042,11 @@ declare type PerDomainSettings = {
|
|
10046
10042
|
* Defaults to 'allow'.
|
10047
10043
|
* Disables the `print` option in the context menu, and prevents printing via both OpenFin and browser APIs.
|
10048
10044
|
*/
|
10049
|
-
print?:
|
10045
|
+
print?: 'allow' | 'block';
|
10050
10046
|
/**
|
10051
10047
|
* * Controls whether HTML5 dragging for this content is allowed or blocked.
|
10052
10048
|
*/
|
10053
|
-
drag?:
|
10049
|
+
drag?: 'allow' | 'block';
|
10054
10050
|
};
|
10055
10051
|
};
|
10056
10052
|
|
@@ -11446,6 +11442,14 @@ declare interface PlatformProvider {
|
|
11446
11442
|
* ```
|
11447
11443
|
*/
|
11448
11444
|
handleFailedViewCreation(viewIdentity: OpenFin_2.Identity, error: Error): Promise<OpenFin_2.ViewCreationSuccess | void>;
|
11445
|
+
/**
|
11446
|
+
* Determines whether a given window should prevent the application from quitting when it is closed.
|
11447
|
+
* This method is called when checking if closing a window should trigger application termination.
|
11448
|
+
*
|
11449
|
+
* @param windowIdentity - The identity of the window being checked.
|
11450
|
+
* @returns A promise resolving to `true` if the window should prevent the app from quitting, otherwise `false`.
|
11451
|
+
*/
|
11452
|
+
shouldWindowPreventQuit(windowIdentity: OpenFin_2.Identity): Promise<boolean>;
|
11449
11453
|
}
|
11450
11454
|
|
11451
11455
|
/**
|
@@ -13236,10 +13240,9 @@ declare type RvmLaunchOptions = {
|
|
13236
13240
|
};
|
13237
13241
|
|
13238
13242
|
/**
|
13239
|
-
* @interface
|
13240
13243
|
* Controls whether this content should be allowed or blocked when capturing the screen.
|
13241
13244
|
*/
|
13242
|
-
declare type ScreenCaptureBehavior =
|
13245
|
+
declare type ScreenCaptureBehavior = 'allow' | 'block';
|
13243
13246
|
|
13244
13247
|
/**
|
13245
13248
|
* Returned by getScreenCapturePermission. Includes sub-entity permission states and the resulting permission.
|
@@ -13728,12 +13731,15 @@ declare type StartedEvent = BaseEvents.IdentityEvent & {
|
|
13728
13731
|
};
|
13729
13732
|
|
13730
13733
|
/**
|
13731
|
-
*
|
13734
|
+
* Behavior when displaying content from matched URLs.
|
13732
13735
|
*/
|
13733
|
-
declare type StructuredContentBehavior =
|
13736
|
+
declare type StructuredContentBehavior = {
|
13737
|
+
behavior: BaseContentBehavior;
|
13738
|
+
} | BrowserContentBehavior;
|
13734
13739
|
|
13735
13740
|
/**
|
13736
|
-
*
|
13741
|
+
* Behavior when displaying content from matched URLs. Varies depending on type of navigation.
|
13742
|
+
* @interface
|
13737
13743
|
*/
|
13738
13744
|
declare type StructuredContentPermissions = {
|
13739
13745
|
/**
|
package/out/stub.d.ts
CHANGED
@@ -84,12 +84,6 @@ declare type AlertRequestedEvent = BaseEvent_5 & {
|
|
84
84
|
url: string;
|
85
85
|
};
|
86
86
|
|
87
|
-
/**
|
88
|
-
* @interface
|
89
|
-
* A string literal union that represents possible values for behaviors in {@link DomainSettings}
|
90
|
-
*/
|
91
|
-
declare type AllowOrBlock = 'allow' | 'block';
|
92
|
-
|
93
87
|
declare type AnchorType = 'top-left' | 'top-right' | 'bottom-left' | 'bottom-right';
|
94
88
|
|
95
89
|
declare type AnyStrategy = ChannelStrategy<any>;
|
@@ -1723,7 +1717,7 @@ declare type BaseConfig = {
|
|
1723
1717
|
timeout?: number;
|
1724
1718
|
};
|
1725
1719
|
|
1726
|
-
declare type BaseContentBehavior =
|
1720
|
+
declare type BaseContentBehavior = 'allow' | 'block';
|
1727
1721
|
|
1728
1722
|
/**
|
1729
1723
|
* Properties shared by all content creation rules, regardless of context.
|
@@ -1868,10 +1862,6 @@ declare type BaseLoadFailedEvent = NamedEvent & {
|
|
1868
1862
|
isMainFrame: boolean;
|
1869
1863
|
};
|
1870
1864
|
|
1871
|
-
declare type BaseStructuredContentBehavior = {
|
1872
|
-
behavior: BaseContentBehavior;
|
1873
|
-
};
|
1874
|
-
|
1875
1865
|
declare type BaseUrlEvent = NamedEvent & {
|
1876
1866
|
type: 'url-changed';
|
1877
1867
|
url: string;
|
@@ -1972,11 +1962,15 @@ declare type BoundsDidChangeEvent = BoundsChangeEvent & {
|
|
1972
1962
|
|
1973
1963
|
declare type BoundsEvent = BaseEvent_5 & OpenFin_2.Bounds;
|
1974
1964
|
|
1965
|
+
/**
|
1966
|
+
* Opens matched URLs in the browser.
|
1967
|
+
*
|
1968
|
+
* @interface
|
1969
|
+
*/
|
1975
1970
|
declare type BrowserContentBehavior = {
|
1976
1971
|
behavior: 'browser';
|
1977
1972
|
/**
|
1978
|
-
*
|
1979
|
-
* When set to true will close the Window or View that tried to navigate or redirect to the blocked URL.
|
1973
|
+
* When true, closes the window or view that initiated the navigation.
|
1980
1974
|
*/
|
1981
1975
|
closeExisting?: boolean;
|
1982
1976
|
};
|
@@ -3311,6 +3305,7 @@ declare type ClipboardPasteBlockedEvent = NamedEvent & {
|
|
3311
3305
|
|
3312
3306
|
/**
|
3313
3307
|
* Clipboard Permissions
|
3308
|
+
* @interface
|
3314
3309
|
*/
|
3315
3310
|
declare type ClipboardPermissions = {
|
3316
3311
|
copy?: CopyPermissions;
|
@@ -3873,7 +3868,7 @@ declare type ContainerCreatedEvent = LayoutDOMEvent & {
|
|
3873
3868
|
};
|
3874
3869
|
|
3875
3870
|
/**
|
3876
|
-
*
|
3871
|
+
* Behavior when displaying content from matched URLs.
|
3877
3872
|
*
|
3878
3873
|
* 'allow': The content url is allowed.
|
3879
3874
|
* 'block': The content url is blocked.
|
@@ -4110,6 +4105,7 @@ declare type CopyBlockedEventReason = 'disabled';
|
|
4110
4105
|
|
4111
4106
|
/**
|
4112
4107
|
* Control copy operations for a matched URL.
|
4108
|
+
* @interface
|
4113
4109
|
*/
|
4114
4110
|
declare type CopyPermissions = {
|
4115
4111
|
/**
|
@@ -4121,7 +4117,7 @@ declare type CopyPermissions = {
|
|
4121
4117
|
* block: Disables all copy operations.
|
4122
4118
|
* protect: Protects any copied content. Only URLs that have set paste.behavior: 'all-content' will be allowed to paste this content.
|
4123
4119
|
*/
|
4124
|
-
behavior:
|
4120
|
+
behavior: 'allow' | 'block' | 'protect';
|
4125
4121
|
/**
|
4126
4122
|
* Additional copy operation options
|
4127
4123
|
*/
|
@@ -4362,6 +4358,7 @@ declare type DefaultDomainSettings = DomainSettings;
|
|
4362
4358
|
|
4363
4359
|
/**
|
4364
4360
|
* @deprecated Use {@link OpenFin.DomainSettingsRule} instead.
|
4361
|
+
* @interface
|
4365
4362
|
*/
|
4366
4363
|
declare type DefaultDomainSettingsRule = DomainSettingsRule;
|
4367
4364
|
|
@@ -4565,9 +4562,8 @@ declare type DomainSettings = {
|
|
4565
4562
|
};
|
4566
4563
|
|
4567
4564
|
/**
|
4568
|
-
* @interface
|
4569
|
-
*
|
4570
4565
|
* Defines domain-conditional settings for an OpenFin application.
|
4566
|
+
* @interface
|
4571
4567
|
*/
|
4572
4568
|
declare type DomainSettingsRule = {
|
4573
4569
|
/**
|
@@ -5551,6 +5547,7 @@ declare type FileDownloadProgressEvent = FileDownloadEvent & {
|
|
5551
5547
|
* Domain-conditional rules for file downloads.
|
5552
5548
|
*
|
5553
5549
|
* @remarks See: https://developers.openfin.co/of-docs/docs/file-download#manifest-properties-for-file-downloads
|
5550
|
+
* @interface
|
5554
5551
|
*/
|
5555
5552
|
declare type FileDownloadSettings = {
|
5556
5553
|
/**
|
@@ -7791,7 +7788,7 @@ declare type LaunchExternalProcessListener = (code: ExitCode) => void;
|
|
7791
7788
|
* @interface
|
7792
7789
|
*/
|
7793
7790
|
declare type LaunchExternalProcessRule = {
|
7794
|
-
behavior:
|
7791
|
+
behavior: 'allow' | 'block';
|
7795
7792
|
match: string[];
|
7796
7793
|
};
|
7797
7794
|
|
@@ -9993,12 +9990,10 @@ declare namespace OpenFin_2 {
|
|
9993
9990
|
DomainApiSettings,
|
9994
9991
|
BaseContentBehavior,
|
9995
9992
|
ContentBehavior,
|
9996
|
-
BaseStructuredContentBehavior,
|
9997
9993
|
BrowserContentBehavior,
|
9998
9994
|
StructuredContentBehavior,
|
9999
9995
|
StructuredContentPermissions,
|
10000
9996
|
ContentPermission,
|
10001
|
-
AllowOrBlock,
|
10002
9997
|
ScreenCaptureBehavior,
|
10003
9998
|
PerDomainSettings,
|
10004
9999
|
CopyPermissions,
|
@@ -10194,6 +10189,7 @@ declare type PasteBlockedEventReason = 'invalid-data' | 'disabled';
|
|
10194
10189
|
|
10195
10190
|
/**
|
10196
10191
|
* Control copy operations for a matched URL.
|
10192
|
+
* @interface
|
10197
10193
|
*/
|
10198
10194
|
declare type PastePermissions = {
|
10199
10195
|
/**
|
@@ -10364,11 +10360,11 @@ declare type PerDomainSettings = {
|
|
10364
10360
|
* Defaults to 'allow'.
|
10365
10361
|
* Disables the `print` option in the context menu, and prevents printing via both OpenFin and browser APIs.
|
10366
10362
|
*/
|
10367
|
-
print?:
|
10363
|
+
print?: 'allow' | 'block';
|
10368
10364
|
/**
|
10369
10365
|
* * Controls whether HTML5 dragging for this content is allowed or blocked.
|
10370
10366
|
*/
|
10371
|
-
drag?:
|
10367
|
+
drag?: 'allow' | 'block';
|
10372
10368
|
};
|
10373
10369
|
};
|
10374
10370
|
|
@@ -11847,6 +11843,14 @@ declare interface PlatformProvider {
|
|
11847
11843
|
* ```
|
11848
11844
|
*/
|
11849
11845
|
handleFailedViewCreation(viewIdentity: OpenFin_2.Identity, error: Error): Promise<OpenFin_2.ViewCreationSuccess | void>;
|
11846
|
+
/**
|
11847
|
+
* Determines whether a given window should prevent the application from quitting when it is closed.
|
11848
|
+
* This method is called when checking if closing a window should trigger application termination.
|
11849
|
+
*
|
11850
|
+
* @param windowIdentity - The identity of the window being checked.
|
11851
|
+
* @returns A promise resolving to `true` if the window should prevent the app from quitting, otherwise `false`.
|
11852
|
+
*/
|
11853
|
+
shouldWindowPreventQuit(windowIdentity: OpenFin_2.Identity): Promise<boolean>;
|
11850
11854
|
}
|
11851
11855
|
|
11852
11856
|
/**
|
@@ -13637,10 +13641,9 @@ declare type RvmLaunchOptions = {
|
|
13637
13641
|
};
|
13638
13642
|
|
13639
13643
|
/**
|
13640
|
-
* @interface
|
13641
13644
|
* Controls whether this content should be allowed or blocked when capturing the screen.
|
13642
13645
|
*/
|
13643
|
-
declare type ScreenCaptureBehavior =
|
13646
|
+
declare type ScreenCaptureBehavior = 'allow' | 'block';
|
13644
13647
|
|
13645
13648
|
/**
|
13646
13649
|
* Returned by getScreenCapturePermission. Includes sub-entity permission states and the resulting permission.
|
@@ -14132,12 +14135,15 @@ declare type StartedEvent = BaseEvents.IdentityEvent & {
|
|
14132
14135
|
};
|
14133
14136
|
|
14134
14137
|
/**
|
14135
|
-
*
|
14138
|
+
* Behavior when displaying content from matched URLs.
|
14136
14139
|
*/
|
14137
|
-
declare type StructuredContentBehavior =
|
14140
|
+
declare type StructuredContentBehavior = {
|
14141
|
+
behavior: BaseContentBehavior;
|
14142
|
+
} | BrowserContentBehavior;
|
14138
14143
|
|
14139
14144
|
/**
|
14140
|
-
*
|
14145
|
+
* Behavior when displaying content from matched URLs. Varies depending on type of navigation.
|
14146
|
+
* @interface
|
14141
14147
|
*/
|
14142
14148
|
declare type StructuredContentPermissions = {
|
14143
14149
|
/**
|