@openfin/fdc3-api 41.102.4 → 41.102.6

package/out/fdc3-api-alpha.d.ts

@@ -130,13 +130,13 @@ declare type ApiSettings = {
         /**
          * Inject OpenFin API into cross-origin iframes
          *
-         * @defaultValue false
+         * @default false
          */
         crossOriginInjection?: boolean;
         /**
          * Inject OpenFin API into same-origin iframes
          *
-         * @defaultValue true
+         * @default true
          */
         sameOriginInjection?: boolean;
         /**
@@ -1175,19 +1175,19 @@ declare class ApplicationModule extends Base {
  */
 declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
     /**
-     * @defaultValue false
-     *
      * Disables IAB secure logging for the app.
+     *
+     * @default false
      */
     disableIabSecureLogging: boolean;
     /**
-     * @defaultValue 'There was an error loading the application.'
-     *
      * An error message to display when the application (launched via manifest) fails to load.
      * A dialog box will be launched with the error message just before the runtime exits.
      * Load fails such as failed DNS resolutions or aborted connections as well as cancellations, _e.g.,_ `window.stop()`,
      * will trigger this dialog.
      * Client response codes such as `404 Not Found` are not treated as fails as they are valid server responses.
+     *
+     * @default 'There was an error loading the application.'
      */
     loadErrorMessage: string;
     /**
@@ -1206,28 +1206,28 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
      */
     name: string;
     /**
-     * @defaultValue false
-     *
      * A flag to configure the application as non-persistent.
      * Runtime exits when there are no persistent apps running.
+     *
+     * @default false
      */
     nonPersistent: boolean;
     /**
-     * @defaultValue false
-     *
      * Enable Flash at the application level.
+     *
+     * @default false
      */
     plugins: boolean;
     /**
-     * @defaultValue false
-     *
      * Enable spell check at the application level.
+     *
+     * @default false
      */
     spellCheck: boolean;
     /**
-     * @defaultValue 'about:blank'
-     *
      * The url to the application (specifically the application's main window).
+     *
+     * @default 'about:blank'
      */
     url: string;
     /**
@@ -1236,9 +1236,9 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
      */
     uuid: string;
     /**
-     * @defaultValue true
-     *
      * When set to `false` it will disable the same-origin policy for the app.
+     *
+     * @default true
      */
     webSecurity: boolean;
     /**
@@ -1248,10 +1248,10 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
     commands: ShortcutOverride[];
     isPlatformController: boolean;
     /**
-     * @defaultValue 1000
-     *
      * **Platforms Only.** The maximum number of "detached" or "pooled" Views that can exist in the Platform before being closed.
      * If you do not wish for views to be pooled on your platform, set this property to zero.
+     *
+     * @default 1000
      */
     maxViewPoolSize: number;
     /**
@@ -1267,12 +1267,12 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
      */
     snapshot: Snapshot;
     /**
-     * @defaultValue false
-     *
      * **Platforms Only.** Prevent the Platform Provider from quitting automatically when the last Platform Window is closed.
      *
      * Note: if the Platform Provider is showing, it won't close automatically.
      * If you want a hidden Platform Provider to remain open after the last Platform Window has been closed, set this property to true.
+     *
+     * @default false
      */
     preventQuitOnLastWindowClosed: boolean;
     /**
@@ -1280,9 +1280,9 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
      */
     interopBrokerConfiguration: InteropBrokerOptions;
     /**
-     * @defaultValue true
-     *
      * When set to `false` it will disable OpenFin Diagnostics for the app.
+     *
+     * @default true
      */
     apiDiagnostics: boolean;
     /**
@@ -1298,16 +1298,16 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
      */
     permissions?: Partial<Permissions_2>;
     /**
-     * @defaultValue false
-     *
      * Enables the use of the Jumplists API and the 'pin to taskbar' functionality.
      * Only relevant in Windows.
+     *
+     * @default false
      */
     enableJumpList: boolean;
     /**
-     * @defaultValue false
-     *
      * When set to `true`, any `beforeunload` handler set on the app will fire.
+     *
+     * @default false
      */
     enableBeforeUnload: boolean;
     /**
@@ -1388,25 +1388,25 @@ declare type ApplicationWindowInfo = {
  */
 declare type ApplySnapshotOptions = {
     /**
-     * @defaultValue false
-     *
      * When true, applySnapshot will close existing windows,
      * replacing current Platform state with the given snapshot.
+     *
+     * @default false
      */
     closeExistingWindows?: boolean;
     /**
-     * @defaultValue false
-     *
      * When true, applySnapshot will close existing includeInSnapshots: true windows,
      * replacing current Platform state with the given snapshot.
+     *
+     * @default false
      */
     closeSnapshotWindows?: boolean;
     /**
-     * @defaultValue false
-     *
      * When true, applySnapshot will not check whether any windows in a
      * snapshot are off-screen. By default, such windows will be repositioned to be on-screen,
      * as defined by {@link PlatformProvider#positionOutOfBoundsWindows PlatformProvider.positionOutOfBoundsWindows}.
+     *
+     * @default false
      */
     skipOutOfBoundsCheck?: boolean;
 };
@@ -2063,15 +2063,15 @@ declare type CapturePageOptions = {
      */
     area?: Rectangle;
     /**
-     * @defaultValue 'png'
-     *
      * The format of the captured image.  Can be 'png', 'jpg', or 'bmp'.
+     *
+     * @default 'png'
      */
     format?: 'bmp' | 'jpg' | 'png';
     /**
-     * @defaultValue 100
-     *
      * Quality of JPEG image. Between 0 - 100.
+     *
+     * @default 100
      */
     quality?: number;
 };
@@ -2704,9 +2704,9 @@ declare type ChannelClientDisconnectionListener = (identity: ClientIdentity) =>
  */
 declare type ChannelConnectOptions = ChannelCreateOptions & {
     /**
-     * @defaultValue true
-     *
      * If true will wait for ChannelProvider to connect. If false will fail if ChannelProvider is not found.
+     *
+     * @default true
      */
     wait?: boolean;
     /**
@@ -3365,9 +3365,9 @@ declare interface CloseWindowPayload {
     windowId: Identity_4;
     options: {
         /**
-         * @defaultValue false
-         *
          * When set to true skips any before handler set on views that are part of the window
+         *
+         * @default false
          */
         skipBeforeUnload?: boolean;
     };
@@ -3472,9 +3472,9 @@ declare type ConstViewOptions = {
      */
     name: string;
     /**
-     * @defaultValue "about:blank"
-     *
      * The URL of the window
+     *
+     * @default "about:blank"
      */
     url: string;
     /**
@@ -3499,6 +3499,15 @@ declare type ConstViewOptions = {
      * Custom headers for requests sent by the view.
      */
     customRequestHeaders: CustomRequestHeaders[];
+    /**
+     * @experimental
+     *
+     * When set to true, will prevent setting the `-webkit-app-region` and `app-region` css properties on the view.
+     * These css properties are used to enable dragging of a frameless window.
+     *
+     * @default false
+     */
+    disableAppRegion: boolean;
     /**
      * Initial bounds given relative to the window.
      */
@@ -3535,9 +3544,9 @@ declare type ConstViewOptions = {
     experimental: any;
     fdc3InteropApi?: string;
     /**
-     * @defaultValue false
-     *
      * When set to `true`, any `beforeunload` handler set on Views will fire.
+     *
+     * @default false
      */
     enableBeforeUnload: boolean;
     /**
@@ -3618,13 +3627,12 @@ declare type ConstWindowOptions = {
      */
     backgroundColor: string;
     /**
-     * @defaultValue false
-     *
      * Determines whether WebContents will throttle animations and timers when the page becomes backgrounded.
      * This also affects the Page Visibility API.
      *
      * When `true`, the page is throttled whether it is hidden or not.
      *
+     * @default false
      */
     backgroundThrottling: boolean;
     /**
@@ -3648,21 +3656,30 @@ declare type ConstWindowOptions = {
      */
     customRequestHeaders: CustomRequestHeaders[];
     /**
-     * @defaultValue true
-     *
      * Setting this to false would keep the Window alive even if all its Views were closed.
      * This is meant for advanced users and should be used with caution.
      * Limitations - Once a Layout has been emptied out of all views it's not usable anymore, and certain API calls will fail.
      * Use `layout.replace` to create a fresh Layout instance in case you want to populate it with Views again.
      * **NOTE:** - This option is ignored in non-Platforms apps.
+     *
+     * @default true
      */
     closeOnLastViewRemoved: boolean;
     /**
-     * @defaultValue 'all'
+     * @experimental
      *
+     * When set to true, will prevent setting the `-webkit-app-region` and `app-region` css properties on the window.
+     * These css properties are used to enable dragging of a frameless window.
+     *
+     * @default false
+     */
+    disableAppRegion: boolean;
+    /**
      * When `closeOnLastViewRemoved` is set to true, determines which views prevent closing the window.
-     +    * Defaults to `all`. You may want to switch this to `layout` if using View closeBehavior: 'hide'.
+     * Defaults to `all`. You may want to switch this to `layout` if using View closeBehavior: 'hide'.
      * **NOTE:** - This option is ignored in non-Platforms apps.
+     *
+     * @default 'all'
      */
     viewsPreventingClose: 'all' | 'layout';
     /**
@@ -3673,31 +3690,31 @@ declare type ConstWindowOptions = {
      */
     defaultCentered: boolean;
     /**
-     * @defaultValue 500
-     *
      * The default height of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent launches
      * in favor of the cached value.
+     *
+     * @default 500
      */
     defaultHeight: number;
     /**
-     * @defaultValue 100
-     *
      * The default left position of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent
      * launches in favor of the cached value.
+     *
+     * @default 100
      */
     defaultLeft: number;
     /**
-     * @defaultValue 100
-     *
      * The default top position of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent
      * launches in favor of the cached value.
+     *
+     * @default 100
      */
     defaultTop: number;
     /**
-     * @defaultValue 800
-     *
      * The default width of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent
      * launches in favor of the cached value.
+     *
+     * @default 800
      */
     defaultWidth: number;
     /**
@@ -3743,19 +3760,19 @@ declare type ConstWindowOptions = {
      */
     processAffinity: string;
     /**
-     * @defaultValue false
-     *
      * Displays a shadow on frameless windows.
      * `shadow` and `cornerRounding` are mutually exclusive.
      * On Windows 7, Aero theme is required.
+     *
+     * @default false
      */
     shadow: boolean;
     /**
-     * @defaultValue true
-     *
      * Caches the location of the window.
      *
      * Note: this option is ignored in Platforms as it would cause inconsistent {@link Platform#applySnapshot applySnapshot} behavior.
+     *
+     * @default true
      */
     saveWindowState: boolean;
     /**
@@ -3764,22 +3781,22 @@ declare type ConstWindowOptions = {
      */
     ignoreSavedWindowState: boolean;
     /**
-     * @defaultValue false
-     *
      * Makes this window a frameless window that can be created and resized to less than 41x36 px (width x height).
      *
      * Note: Caveats of small windows are no Aero Snap and drag to/from maximize.
      * _Windows 10: Requires `maximizable` to be false. Resizing with the mouse is only possible down to 38x39 px._
+     *
+     * @default false
      */
     smallWindow: boolean;
     /**
-     * @defaultValue "normal"
-     *
      * The visible state of the window on creation.
      * One of:
      * * `"maximized"`
      * * `"minimized"`
      * * `"normal"`
+     *
+     * @default "normal"
      */
     state: WindowState;
     /**
@@ -3794,26 +3811,26 @@ declare type ConstWindowOptions = {
      */
     taskbarIconGroup: string;
     /**
-     * @defaultValue "about:blank"
-     *
      * The URL of the window
+     *
+     * @default "about:blank"
      */
     url: string;
     /**
-     * @defaultValue <application UUID>
-     *
      * The `uuid` of the application, unique within the set of all `Application`s running in OpenFin Runtime.
      * If omitted, defaults to the `uuid` of the application spawning the window.
      * If given, must match the `uuid` of the application spawning the window.
      * In other words, the application's `uuid` is the only acceptable value, but is the default, so there's
      * really no need to provide it.
+     *
+     * @default <application UUID>
      */
     uuid: string;
     /**
-     * @defaultValue false
-     *
      * When set to `true`, the window will not appear until the `window` object's `load` event fires.
      * When set to `false`, the window will appear immediately without waiting for content to be loaded.
+     *
+     * @default false
      */
     waitForPageLoad: boolean;
     width: number;
@@ -4095,13 +4112,13 @@ declare type CopyBlockedEventReason = 'disabled';
  */
 declare type CopyPermissions = {
     /**
-     * @defaultValue 'allowed'
-     *
      * Controls the behavior for copy operations for a matched URL.
      *
      * allow: Enables all copy operations.
      * 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.
+     *
+     * @default 'allowed'
      */
     behavior: 'allow' | 'block' | 'protect';
     /**
@@ -4109,9 +4126,9 @@ declare type CopyPermissions = {
      */
     options?: {
         /**
-         * @defaultValue ''
-         *
          * When setting behavior = 'protected' , this string will be pasted to other applications that do not have a matching URL instead of the original content.
+         *
+         * @default ''
          */
         replacementText: string;
     };
@@ -4125,15 +4142,15 @@ declare type CopyPermissions = {
  */
 declare type CornerRounding = {
     /**
-     * @defaultValue 0
-     *
      * The height in pixels.
+     *
+     * @default 0
      */
     height: number;
     /**
-     * @defaultValue 0
-     *
      * The width in pixels.
+     *
+     * @default 0
      */
     width: number;
 };
@@ -4223,8 +4240,6 @@ declare type CreateLayoutOptions = {
     layoutName: string;
     layout: LayoutOptions;
     /**
-     * @defaultValue 'default'
-     *
      * Controls the View behavior for the given `layout` property. Note
      * that the selected behavior only applies to unnamed Views or
      * Views with the prefix `internal-generated-`. In all cases, if any
@@ -4246,6 +4261,8 @@ declare type CreateLayoutOptions = {
      * override. Note that during applyLayoutSnapshot, Views are created and
      * attached to the Provider while the Window is being created, so it's
      * important to not 'duplicate' Views in this workflow.
+     *
+     * @default 'default'
      */
     multiInstanceViewBehavior?: MultiInstanceViewBehavior;
 };
@@ -4504,7 +4521,7 @@ declare type DomainApiSettings = {
      * * 'none': The `fin` API will be not available.
      * * 'global': The entire `fin` API will be available.
      *
-     * @defaultValue 'global'
+     * @default 'global'
      */
     fin?: InjectionType;
     /**
@@ -5089,9 +5106,9 @@ declare type EventType_9 = Event_12['type'];
  */
 declare type ExcludeOptions = {
     /**
-     * @defaultValue false
-     *
      * When true, will not merge default preload scripts from {@link ApplicationOptions.defaultWindowOptions} or {@link ApplicationOptions.defaultViewOptions}.
+     *
+     * @default false
      */
     preloadScripts: boolean;
 };
@@ -5910,34 +5927,34 @@ declare interface FinApi<MeType extends OpenFin.EntityType> {
  */
 declare type FindInPageOptions = {
     /**
-     * @defaultValue true
-     *
      * Searches in the forward direction (backward otherwise)
+     *
+     * @default true
      */
     forward?: boolean;
     /**
-     * @defaultValue false
-     *
      * Begins a new text-finding session; should be true for first request only, and false on subsequent requests.
+     *
+     * @default false
      */
     findNext?: boolean;
     /**
-     * @defaultValue false
-     *
      * Enables case-sensitive searching.
+     *
+     * @default false
      */
     matchCase?: boolean;
     /**
-     * @defaultValue false
-     *
      * Only searches from the start of words.
+     *
+     * @default false
      */
     wordStart?: boolean;
     /**
-     * @defaultValue false
-     *
      * When combined with wordStart, accepts a match in the middle of a word if the match begins with an uppercase letter followed by a<br>
      * lowercase or non-letter. Accepts several other intra-word matches.
+     *
+     * @default false
      */
     medialCapitalAsWordStart?: boolean;
 };
@@ -6445,9 +6462,9 @@ declare type Hotkey = {
      */
     keys: string;
     /**
-     * @defaultValue false
-     *
      * Prevent default key handling before emitting the event.
+     *
+     * @default false
      */
     preventDefault?: boolean;
 };
@@ -8804,77 +8821,79 @@ declare type LayoutOptions = {
          */
         newTabButtonUrl?: string;
         /**
-         * @defaultValue false
-         *
          * When true the splitters will not be draggable and the layout will not resize.
+         *
+         * @default false
          */
         preventSplitterResize?: boolean;
         /**
-         * @defaultValue false
-         *
          * Whether the popout button will only act on the entire stack,
          * as opposed to only the active tab.
+         *
+         * @default false
          */
         popoutWholeStack?: boolean;
         /**
-         * @defaultValue false
-         *
          * Limits the area to which tabs can be dragged.
          * If true, the layout container is the only area where tabs can be dropped.
+         *
+         * @default false
          */
         constrainDragToContainer?: boolean;
         /**
-         * @defaultValue false
-         *
          * Whether to show the popout button on stack header.
          * The button will create a new window with current tab as its content.
          * In case `popoutWholeStack` is set to true, all tabs in the stack will be in the new window.
+         *
+         * @default false
          */
         showPopoutIcon?: boolean;
         /**
-         * @defaultValue false
-         *
          * Whether to show the maximize button on stack header.
          * The button will maximize the current tab to fill the entire window.
+         *
+         * @default false
          */
         showMaximiseIcon?: boolean;
         /**
-         * @defaultValue false
-         *
          * Whether to show the close button on stack header
          * (not to be confused with close button on every tab).
+         *
+         * @default false
          */
         showCloseIcon?: boolean;
         /**
-         * @defaultValue false
-         *
          * Limits the area to which tabs can be dragged. If true, stack headers are the only areas where tabs can be dropped.
+         *
+         * @default false
          */
         constrainDragToHeaders?: boolean;
         /**
-         * @defaultValue true
-         *
          * Turns tab headers on or off.
          * If false, the layout will be displayed with splitters only.
+         *
+         * @default true
          */
         hasHeaders?: boolean;
         /**
-         * @defaultValue true
-         *
          * If true, the user can re-arrange the layout by
          * dragging items by their tabs to the desired location.
+         *
+         * @default true
          */
         reorderEnabled?: boolean;
         /**
-         * @defaultValue false
-         *
          * If true, tabs can't be dragged out of the window.
+         *
+         * @default false
          */
         preventDragOut?: boolean;
         /**
          * @defaultValue=false
          *
          * If true, tabs can't be dragged into the window.
+         *
+         * @default false
          */
         preventDragIn?: boolean;
     };
@@ -9326,10 +9345,10 @@ declare type MutableViewOptions = {
     /**
      * @deprecated Superseded by {@link contextMenuOptions}, which offers a larger feature-set and cleaner syntax.
      *
-     * @defaultValue true
-     *
      * Show the context menu when right-clicking on the view.
      * Gives access to the devtools for the view.
+     *
+     * @default true
      */
     contextMenu: boolean;
     /**
@@ -9376,24 +9395,25 @@ declare type MutableViewOptions = {
     contentNavigation: ContentNavigation;
     contentRedirect: ContentRedirect;
     /**
-     * @defaultValue false
      * @deprecated
      * **Platforms Only.**  If true, will hide and detach the View from the window for later use instead of closing,
      * allowing the state of the View to be saved and the View to be immediately shown in a new Layout.
+     *
+     * @default false
      */
     detachOnClose: boolean;
     /**
-     * @defaultValue true
-     *
      * **Platforms Only.** If false, the view will be persistent and can't be closed through
      * either UI or `Platform.closeView`. Note that the view will still be closed if the host window is closed or
      * if the view isn't part of the new layout when running `Layout.replace`.
+     *
+     * @default true
      */
     isClosable: boolean;
     /**
-     * @defaultValue false
-     *
      * **Platforms Only.** If true, the tab of the view can't be dragged out of its host window.
+     *
+     * @default false
      */
     preventDragOut: boolean;
     interop?: InteropConfig;
@@ -9401,7 +9421,7 @@ declare type MutableViewOptions = {
     /**
      * {@inheritDoc ViewThrottling}
      *
-     * @defaultValue 'enabled'
+     * @default 'enabled'
      */
     throttling: ViewThrottling;
     /**
@@ -9420,7 +9440,7 @@ declare type MutableWindowOptions = {
      * Turns anything of matching RGB value transparent.
      *
      * Caveats:
-     * * runtime key --disable-gpu is required. Note: Unclear behavior on remote Desktop support
+     * * Runtime flags --disable-gpu and --allow-unsafe-compositing are required. Note: Unclear behavior on remote Desktop support
      * * User cannot click-through transparent regions
      * * Not supported on Mac
      * * Windows Aero must be enabled
@@ -9429,25 +9449,25 @@ declare type MutableWindowOptions = {
      */
     alphaMask: RGB;
     /**
-     * @defaultValue false
-     *
      * Always position the window at the top of the window stack.
+     *
+     * @default false
      */
     alwaysOnTop: boolean;
     /**
-     * @defaultValue 0
-     *
      * The aspect ratio of width to height to enforce for the window. If this value is equal to or less than zero,
      * an aspect ratio will not be enforced.
+     *
+     * @default 0
      */
     aspectRatio: number;
     /**
      * @deprecated Superseded by {@link contextMenuOptions}, which offers a larger feature-set and cleaner syntax.
      *
-     * @defaultValue true
-     *
      * Show the context menu when right-clicking on the window.
      * Gives access to the devtools for the window.
+     *
+     * @default true
      */
     contextMenu: boolean;
     /**
@@ -9514,15 +9534,18 @@ declare type MutableWindowOptions = {
      */
     customData: any;
     /**
+     * @deprecated Will be removed in runtime version 45
      * @defaultValue true
      *
      * Show the window's frame.
+     *
+     * @default true
      */
     frame: boolean;
     /**
-     * @defaultValue false
-     *
      * Hides the window instead of closing it when the close button is pressed.
+     *
+     * @default false
      */
     hideOnClose: boolean;
     /**
@@ -9575,60 +9598,61 @@ declare type MutableWindowOptions = {
      */
     icon: string;
     /**
-     * @defaultValue true
-     *
      * Include window in snapshots returned by Platform.getSnapshot(). Turning this off may be desirable when dealing with
      * inherently temporary windows whose state shouldn't be preserved, such as modals, menus, or popups.
+     *
+     * @default true
      */
     includeInSnapshots: boolean;
     /**
-     * @defaultValue -1
-     *
      * The maximum height of a window. Will default to the OS defined value if set to -1.
+     *
+     * @default -1
      */
     maxHeight: number;
     /**
-     * @defaultValue true
-     *
      * Allows the window to be maximized.
+     *
+     * @default true
      */
     maximizable: boolean;
     /**
-     * @defaultValue -1
-     *
      * The maximum width of a window. Will default to the OS defined value if set to -1.
+     *
+     * @default -1
      */
     maxWidth: number;
     /**
-     * @defaultValue 0
-     *
      * The minimum height of the window.
+     *
+     * @default 0
      */
     minHeight: number;
     /**
-     * @defaultValue true
-     *
      * Allows the window to be minimized.
+     *
+     * @default true
      */
     minimizable: boolean;
     /**
-     * @defaultValue true
-     *
      * The minimum width of the window.
+     *
+     * @default true
      */
     minWidth: number;
     /**
-     * @defaultValue 1
-     *
      * A flag that specifies how transparent the window will be.
      * Changing opacity doesn't work on Windows 7 without Aero so setting this value will have no effect there.
      * This value is clamped between `0.0` and `1.0`.
+     * In software composition mode, the runtime flag --allow-unsafe-compositing is required.
+     *
+     * @default 1
      */
     opacity: number;
     /**
-     * @defaultValue true
-     *
      * A flag to allow the user to resize the window.
+     *
+     * @default true
      */
     resizable: boolean;
     /**
@@ -9636,16 +9660,16 @@ declare type MutableWindowOptions = {
      */
     resizeRegion: ResizeRegion;
     /**
-     * @defaultValue false
-     *
      * **Platforms Only.**  If true, will show background images in the layout when the Views are hidden.
      * This occurs when the window is resizing or a tab is being dragged within the layout.
+     *
+     * @default false
      */
     showBackgroundImages: boolean;
     /**
-     * @defaultValue true
-     *
      * Shows the window's icon in the taskbar.
+     *
+     * @default true
      */
     showTaskbarIcon: boolean;
     /**
@@ -9664,7 +9688,7 @@ declare type MutableWindowOptions = {
     /**
      * {@inheritDoc WindowThrottling}
      *
-     * @defaultValue 'enabled'
+     * @default 'enabled'
      *
      * @remarks If `throttling` option is present, the `backgroundThrottling` option is completely ignored for windows.
      */
@@ -10274,12 +10298,12 @@ declare type PasteBlockedEventReason = 'invalid-data' | 'disabled';
  */
 declare type PastePermissions = {
     /**
-     * @defaultValue 'non-protected-content'
-     *
      * Controls the behavior for paste operations for a matched URL.
      *
      * non-protected-content: All matching URLs will be able to paste content copied from non-protected URLs.
      * all-content: All matching URLs will be able to paste content copied from both protected (copy.behavior = 'protect') and on-protected (copy.behavior = 'allow') URLs.
+     *
+     * @default 'non-protected-content'
      */
     behavior: 'non-protected-content' | 'all-content';
 };
@@ -11310,11 +11334,11 @@ declare type PlatformOptions = ApplicationCreationOptions & {
      */
     providerUrl?: string;
     /**
-     * @defaultValue true
-     *
      * Controls whether it is allowed to launch content manifests into the Platform. If omitted, defaults to `true`.
      *
      * NOTE: Starting in v38, the default value will change to `false` and content launching must be explicitly opted into.
+     *
+     * @default true
      */
     allowLaunchIntoPlatform?: boolean;
 };
@@ -11958,22 +11982,22 @@ declare type PopupOptions = {
     url?: string;
     /**
      * Height of the popup window in pixels (takes priority over `intialOptions` size properties).
-     * @defaultValue 300
+     * @default 300
      */
     height?: number;
     /**
      * Width of the popup window in pixels (takes priority over `intialOptions` size properties).
-     * @defaultValue 300
+     * @default 300
      */
     width?: number;
     /**
      * Left position in pixels where the popup window will be shown (relative to the window calling `showPopupWindow`).
-     * @defaultValue 0
+     * @default 0
      */
     x?: number;
     /**
      * Top position in pixels where the popup window will be shown (relative to the window calling `showPopupWindow`).
-     * @defaultValue 0
+     * @default 0
      */
     y?: number;
     /**
@@ -11981,7 +12005,7 @@ declare type PopupOptions = {
      * * 'modal' restricts resizing and positioning in the caller.
      * * 'hide' hides the popup window on blur.
      * * 'close' closes the popup window on blur.
-     * @defaultValue 'close'
+     * @default 'close'
      */
     blurBehavior?: PopupBlurBehavior;
     /**
@@ -11989,19 +12013,19 @@ declare type PopupOptions = {
      * * 'none' will do nothing.
      * * 'hide' hides the popup window on `dispatchPopupResult`.
      * * 'close' closes the popup window on `dispatchPopupResult`.
-     * @defaultValue 'close'
+     * @default 'close'
      */
     resultDispatchBehavior?: PopupResultBehavior;
     /**
      * Hide the popup window instead of closing when `close` is called on it.
      *
      * Note: if this is `true` and `blurBehavior` and/or `resultDispatchBehavior` are set to `close`, the window will be hidden.
-     * @defaultValue false
+     * @default false
      */
     hideOnClose?: boolean;
     /**
      * Determines if the popup window should or should not be focused when it is shown.
-     * @defaultValue true
+     * @default true
      */
     focus?: boolean;
     /**
@@ -12095,9 +12119,9 @@ declare type PrebuiltContextMenuItem = 'separator' | 'undo' | 'redo' | 'cut' | '
  */
 declare type PreloadScript = {
     /**
-     * @defaultValue false
-     *
      * Fail to load the window if this preload script fails
+     *
+     * @default false
      */
     mandatory?: boolean;
     /**
@@ -12193,15 +12217,15 @@ declare type PrinterInfo = {
 declare type PrintOptions = {
     content?: 'self';
     /**
-     * @defaultValue false
-     *
      * Disables prompting the user for print settings.
+     *
+     * @default false
      */
     silent?: boolean;
     /**
-     * @defaultValue false
-     *
      * Includes the webpage background color and image when printing.
+     *
+     * @default false
      */
     printBackground?: boolean;
     /**
@@ -12209,9 +12233,9 @@ declare type PrintOptions = {
      */
     deviceName?: string;
     /**
-     * @defaultValue true
-     *
      * Prints in full color (greyscale otherwise).
+     *
+     * @default true
      */
     color?: boolean;
     /**
@@ -12219,9 +12243,9 @@ declare type PrintOptions = {
      */
     margins?: Margins;
     /**
-     * @defaultValue true
-     *
      * Prints in landscape mode (portrait otherwise).
+     *
+     * @default true
      */
     landscape?: boolean;
     /**
@@ -13402,15 +13426,15 @@ declare type ReplaceViewPayload = {
  */
 declare type ResizeRegion = {
     /**
-     * @defaultValue 7
-     *
      * The size of the resize region in pixels.
+     *
+     * @default 7
      */
     size?: number;
     /**
-     * @defaultValue 9
-     *
      * The size in pixels of an additional square resizable region located at the bottom right corner of a frameless window.
+     *
+     * @default 9
      */
     bottomRightCorner?: number;
     /**
@@ -13418,27 +13442,27 @@ declare type ResizeRegion = {
      */
     sides?: {
         /**
-         * @defaultValue true
-         *
          * Enables resizing from the top of the window.
+         *
+         * @default true
          */
         top?: boolean;
         /**
-         * @defaultValue true
-         *
          * Enables resizing from the bottom of the window.
+         *
+         * @default true
          */
         bottom?: boolean;
         /**
-         * @defaultValue true
-         *
          * Enables resizing from the left side of the window.
+         *
+         * @default true
          */
         left?: boolean;
         /**
-         * @defaultValue true
-         *
          * Enables resizing from the right side of the window.
+         *
+         * @default true
          */
         right?: boolean;
     };
@@ -13990,9 +14014,9 @@ declare type ShowTrayIconPopupMenuOptions<Data extends unknown = unknown> = {
  */
 declare type ShowViewOnWindowResizeOptions = ViewVisibilityOption & {
     /**
-     * @defaultValue 0
-     *
      * Number of milliseconds to wait between view repaints.
+     *
+     * @default 0
      */
     paintIntervalMs?: number;
 };
@@ -16036,9 +16060,9 @@ declare type TransitionBase = {
      */
     duration: number;
     /**
-     * @defaultValue false
-     *
      * Treats 'opacity' as absolute or as a delta. Defaults to false.
+     *
+     * @default false
      */
     relative?: boolean;
 };
@@ -16054,9 +16078,9 @@ declare type TransitionOptions = {
      */
     interrupt: boolean;
     /**
-     * @defaultValue false
-     *
      * Treats 'opacity' as absolute or as a delta. Defaults to false.
+     *
+     * @default false
      */
     relative?: boolean;
     tween?: tween;
@@ -17090,9 +17114,9 @@ declare type ViewTitlePriority = 'document' | 'options';
  */
 declare type ViewVisibilityOption = {
     /**
-     * @defaultValue false
-     *
      * Enables or disables showing views when the layout splitter or a tab is being dragged or a Platform Window is being resized.
+     *
+     * @default false
      */
     enabled?: boolean;
 };