@openfin/core 42.100.10 → 42.100.12

package/out/stub.d.ts

@@ -84,12 +84,6 @@ declare type AlertRequestedEvent = BaseEvent_5 & {
     url: string;
 };
 
-/**
- * @interface
- * A string literal union that represents possible values for behaviors in {@link DomainSettings}
- */
-declare type AllowOrBlock = 'allow' | 'block';
-
 declare type AnchorType = 'top-left' | 'top-right' | 'bottom-left' | 'bottom-right';
 
 declare type AnyStrategy = ChannelStrategy<any>;
@@ -1723,7 +1717,7 @@ declare type BaseConfig = {
     timeout?: number;
 };
 
-declare type BaseContentBehavior = AllowOrBlock;
+declare type BaseContentBehavior = 'allow' | 'block';
 
 /**
  * Properties shared by all content creation rules, regardless of context.
@@ -1868,10 +1862,6 @@ declare type BaseLoadFailedEvent = NamedEvent & {
     isMainFrame: boolean;
 };
 
-declare type BaseStructuredContentBehavior = {
-    behavior: BaseContentBehavior;
-};
-
 declare type BaseUrlEvent = NamedEvent & {
     type: 'url-changed';
     url: string;
@@ -1972,11 +1962,15 @@ declare type BoundsDidChangeEvent = BoundsChangeEvent & {
 
 declare type BoundsEvent = BaseEvent_5 & OpenFin_2.Bounds;
 
+/**
+ * Opens matched URLs in the browser.
+ *
+ * @interface
+ */
 declare type BrowserContentBehavior = {
     behavior: 'browser';
     /**
-     * Additional property that can be specified when setting the behavior to browser.
-     * When set to true will close the Window or View that tried to navigate or redirect to the blocked URL.
+     * When true, closes the window or view that initiated the navigation.
      */
     closeExisting?: boolean;
 };
@@ -3311,6 +3305,7 @@ declare type ClipboardPasteBlockedEvent = NamedEvent & {
 
 /**
  * Clipboard Permissions
+ * @interface
  */
 declare type ClipboardPermissions = {
     copy?: CopyPermissions;
@@ -3873,7 +3868,7 @@ declare type ContainerCreatedEvent = LayoutDOMEvent & {
 };
 
 /**
- * Sets the behavior for when a Window or View navigates or redirects to a matching URL
+ * Behavior when displaying content from matched URLs.
  *
  * 'allow': The content url is allowed.
  * 'block': The content url is blocked.
@@ -4110,6 +4105,7 @@ declare type CopyBlockedEventReason = 'disabled';
 
 /**
  * Control copy operations for a matched URL.
+ * @interface
  */
 declare type CopyPermissions = {
     /**
@@ -4121,7 +4117,7 @@ declare type CopyPermissions = {
      * block: Disables all copy operations.
      * protect: Protects any copied content. Only URLs that have set paste.behavior: 'all-content' will be allowed to paste this content.
      */
-    behavior: AllowOrBlock | 'protect';
+    behavior: 'allow' | 'block' | 'protect';
     /**
      * Additional copy operation options
      */
@@ -4362,6 +4358,7 @@ declare type DefaultDomainSettings = DomainSettings;
 
 /**
  * @deprecated Use {@link OpenFin.DomainSettingsRule} instead.
+ * @interface
  */
 declare type DefaultDomainSettingsRule = DomainSettingsRule;
 
@@ -4565,9 +4562,8 @@ declare type DomainSettings = {
 };
 
 /**
- * @interface
- *
  * Defines domain-conditional settings for an OpenFin application.
+ * @interface
  */
 declare type DomainSettingsRule = {
     /**
@@ -5551,6 +5547,7 @@ declare type FileDownloadProgressEvent = FileDownloadEvent & {
  * Domain-conditional rules for file downloads.
  *
  * @remarks See: https://developers.openfin.co/of-docs/docs/file-download#manifest-properties-for-file-downloads
+ * @interface
  */
 declare type FileDownloadSettings = {
     /**
@@ -7791,7 +7788,7 @@ declare type LaunchExternalProcessListener = (code: ExitCode) => void;
  * @interface
  */
 declare type LaunchExternalProcessRule = {
-    behavior: AllowOrBlock;
+    behavior: 'allow' | 'block';
     match: string[];
 };
 
@@ -9993,12 +9990,10 @@ declare namespace OpenFin_2 {
         DomainApiSettings,
         BaseContentBehavior,
         ContentBehavior,
-        BaseStructuredContentBehavior,
         BrowserContentBehavior,
         StructuredContentBehavior,
         StructuredContentPermissions,
         ContentPermission,
-        AllowOrBlock,
         ScreenCaptureBehavior,
         PerDomainSettings,
         CopyPermissions,
@@ -10194,6 +10189,7 @@ declare type PasteBlockedEventReason = 'invalid-data' | 'disabled';
 
 /**
  * Control copy operations for a matched URL.
+ * @interface
  */
 declare type PastePermissions = {
     /**
@@ -10364,11 +10360,11 @@ declare type PerDomainSettings = {
          * Defaults to 'allow'.
          * Disables the `print` option in the context menu, and prevents printing via both OpenFin and browser APIs.
          */
-        print?: AllowOrBlock;
+        print?: 'allow' | 'block';
         /**
          * * Controls whether HTML5 dragging for this content is allowed or blocked.
          */
-        drag?: AllowOrBlock;
+        drag?: 'allow' | 'block';
     };
 };
 
@@ -11847,6 +11843,14 @@ declare interface PlatformProvider {
      * ```
      */
     handleFailedViewCreation(viewIdentity: OpenFin_2.Identity, error: Error): Promise<OpenFin_2.ViewCreationSuccess | void>;
+    /**
+     * Determines whether a given window should prevent the application from quitting when it is closed.
+     * This method is called when checking if closing a window should trigger application termination.
+     *
+     * @param windowIdentity - The identity of the window being checked.
+     * @returns A promise resolving to `true` if the window should prevent the app from quitting, otherwise `false`.
+     */
+    shouldWindowPreventQuit(windowIdentity: OpenFin_2.Identity): Promise<boolean>;
 }
 
 /**
@@ -13637,10 +13641,9 @@ declare type RvmLaunchOptions = {
 };
 
 /**
- * @interface
  * Controls whether this content should be allowed or blocked when capturing the screen.
  */
-declare type ScreenCaptureBehavior = AllowOrBlock;
+declare type ScreenCaptureBehavior = 'allow' | 'block';
 
 /**
  * Returned by getScreenCapturePermission. Includes sub-entity permission states and the resulting permission.
@@ -14132,12 +14135,15 @@ declare type StartedEvent = BaseEvents.IdentityEvent & {
 };
 
 /**
- * Allows more control over content behaviors
+ * Behavior when displaying content from matched URLs.
  */
-declare type StructuredContentBehavior = BaseStructuredContentBehavior | BrowserContentBehavior;
+declare type StructuredContentBehavior = {
+    behavior: BaseContentBehavior;
+} | BrowserContentBehavior;
 
 /**
- * Specify rules for specific actions.
+ * Behavior when displaying content from matched URLs. Varies depending on type of navigation.
+ * @interface
  */
 declare type StructuredContentPermissions = {
     /**