@types/office-js 1.0.471 → 1.0.472

office-js/README.md

@@ -8,7 +8,7 @@ This package contains type definitions for office-js (https://github.com/OfficeD
 Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-js.
 
 ### Additional Details
- * Last updated: Fri, 21 Feb 2025 19:32:15 GMT
+ * Last updated: Tue, 25 Feb 2025 01:29:27 GMT
  * Dependencies: none
 
 # Credits

office-js/index.d.ts

@@ -8382,10 +8382,9 @@ declare namespace Office {
      */
     interface TextBinding extends Binding { }
     /**
-     * Provides objects and methods that you can use to create and manipulate UI components, such as dialog boxes, in your Office Add-ins.
+     * Provides objects and methods to create and manipulate UI components, such as dialog boxes, in your Office Add-ins.
      *
-     * Visit "{@link https://learn.microsoft.com/office/dev/add-ins/develop/dialog-api-in-office-add-ins | Use the Dialog API in your Office Add-ins}"
-     * for more information.
+     * For guidance on how to configure dialog boxes, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/dialog-api-in-office-add-ins | Use the Dialog API in your Office Add-ins}.
      */
     interface UI {
         /**
@@ -8436,60 +8435,23 @@ declare namespace Office {
          * if you're using the add-in only manifest. If you're using the unified manifest for Microsoft 365, see
          * {@link https://learn.microsoft.com/office/dev/add-ins/develop/unified-manifest-overview | Office Add-ins with the unified app manifest for Microsoft 365}.
          *
-         * The initial page must be on the same domain as the parent page (the startAddress parameter). After the initial page loads, you can go to
-         * other domains.
-         *
-         * Any page calling `Office.context.ui.messageParent` must also be on the same domain as the parent page.
-         *
-         * **Design considerations**:
-         *
-         * The following design considerations apply to dialog boxes.
-         *
-         * - An Office Add-in task pane can have only one dialog box open at any time. Multiple dialogs can be open at the same time from Add-in
-         * Commands (custom ribbon buttons or menu items).
-         *
-         * - Every dialog box can be moved and resized by the user.
-         *
-         * - Every dialog box is centered on the screen when opened.
-         *
-         * - Dialog boxes appear on top of the application and in the order in which they were created.
-         *
-         * Use a dialog box to:
-         *
-         * - Display authentication pages to collect user credentials.
+         * **Important**:
          *
-         * - Display an error/progress/input screen from a ShowTaskpane or ExecuteAction command.
+         * - The initial page must be on the same domain as the parent page (the startAddress parameter). After the initial page loads, you can go to
+         * other domains.
          *
-         * - Temporarily increase the surface area that a user has available to complete a task.
+         * - Any page calling `Office.context.ui.messageParent` must also be on the same domain as the parent page.
          *
-         * Do not use a dialog box to interact with a document. Use a task pane instead.
+         * - To learn about rules, limitations, and best practices for the Office Dialog API, see
+         * {@link https://learn.microsoft.com/office/dev/add-ins/develop/dialog-best-practices | Best practices and rules for the Office dialog API}.
          *
-         * **displayDialogAsync Errors**
+         * - For information on errors and how to handle them, see
+         * {@link https://learn.microsoft.com/office/dev/add-ins/develop/dialog-handle-errors-events | Handle errors and events in the Office dialog box}.
          *
-         * <table>
-         *   <tr>
-         *     <th>Code number</th>
-         *     <th>Meaning</th>
-         *   </tr>
-         *   <tr>
-         *     <td>12004</td>
-         *     <td>The domain of the URL passed to displayDialogAsync isn't trusted. The domain must be either the same domain as the host page (including protocol and port number), or it must be registered in the <code>AppDomains</code> section of the add-in manifest.</td>
-         *   </tr>
-         *   <tr>
-         *     <td>12005</td>
-         *     <td>The URL passed to displayDialogAsync uses the HTTP protocol. HTTPS is required. (In some versions of Office, the error message returned with 12005 is the same one returned for 12004.)</td>
-         *   </tr>
-         *   <tr>
-         *     <td>12007</td>
-         *     <td>A dialog box is already opened from the task pane. A task pane add-in can only have one dialog box open at a time.</td>
-         *   </tr>
-         *   <tr>
-         *     <td>12009</td>
-         *     <td>The user chose to ignore the dialog box. This error can occur in online versions of Office, where users may choose not to allow an add-in to present a dialog.</td>
-         *   </tr>
-         * </table>
+         * - In Outlook on the web and new Outlook on Windows, don't set the {@link https://developer.mozilla.org/docs/Web/API/Window/name | window.name} property
+         * when configuring a dialog in your add-in. The `window.name` property is used by these Outlook clients to maintain functionality across page redirects.
          *
-         * In the callback function passed to the displayDialogAsync method, you can use the properties of the AsyncResult object to return the
+         * - In the callback function passed to the displayDialogAsync method, you can use the properties of the AsyncResult object to return the
          * following information.
          *
          * <table>
@@ -8539,60 +8501,23 @@ declare namespace Office {
          * if you're using the add-in only manifest. If you're using the unified manifest for Microsoft 365, see
          * {@link https://learn.microsoft.com/office/dev/add-ins/develop/unified-manifest-overview | Office Add-ins with the unified app manifest for Microsoft 365}.
          *
-         * The initial page must be on the same domain as the parent page (the startAddress parameter). After the initial page loads, you can go to
-         * other domains.
-         *
-         * Any page calling `Office.context.ui.messageParent` must also be on the same domain as the parent page.
-         *
-         * **Design considerations**:
-         *
-         * The following design considerations apply to dialog boxes.
-         *
-         * - An Office Add-in task pane can have only one dialog box open at any time. Multiple dialogs can be open at the same time from Add-in
-         * Commands (custom ribbon buttons or menu items).
-         *
-         * - Every dialog box can be moved and resized by the user.
-         *
-         * - Every dialog box is centered on the screen when opened.
-         *
-         * - Dialog boxes appear on top of the application and in the order in which they were created.
-         *
-         * Use a dialog box to:
-         *
-         * - Display authentication pages to collect user credentials.
+         * **Important**:
          *
-         * - Display an error/progress/input screen from a ShowTaskpane or ExecuteAction command.
+         * - The initial page must be on the same domain as the parent page (the startAddress parameter). After the initial page loads, you can go to
+         * other domains.
          *
-         * - Temporarily increase the surface area that a user has available to complete a task.
+         * - Any page calling `Office.context.ui.messageParent` must also be on the same domain as the parent page.
          *
-         * Do not use a dialog box to interact with a document. Use a task pane instead.
+         * - To learn about rules, limitations, and best practices for the Office Dialog API, see
+         * {@link https://learn.microsoft.com/office/dev/add-ins/develop/dialog-best-practices | Best practices and rules for the Office dialog API}.
          *
-         * **displayDialogAsync Errors**
+         * - For information on errors and how to handle them, see
+         * {@link https://learn.microsoft.com/office/dev/add-ins/develop/dialog-handle-errors-events | Handle errors and events in the Office dialog box}.
          *
-         * <table>
-         *   <tr>
-         *     <th>Code number</th>
-         *     <th>Meaning</th>
-         *   </tr>
-         *   <tr>
-         *     <td>12004</td>
-         *     <td>The domain of the URL passed to displayDialogAsync isn't trusted. The domain must be either the same domain as the host page (including protocol and port number), or it must be registered in the <code>AppDomains</code> section of the add-in manifest.</td>
-         *   </tr>
-         *   <tr>
-         *     <td>12005</td>
-         *     <td>The URL passed to displayDialogAsync uses the HTTP protocol. HTTPS is required. (In some versions of Office, the error message returned with 12005 is the same one returned for 12004.)</td>
-         *   </tr>
-         *   <tr>
-         *     <td>12007</td>
-         *     <td>A dialog box is already opened from the task pane. A task pane add-in can only have one dialog box open at a time.</td>
-         *   </tr>
-         *   <tr>
-         *     <td>12009</td>
-         *     <td>The user chose to ignore the dialog box. This error can occur in online versions of Office, where users may choose not to allow an add-in to present a dialog.</td>
-         *   </tr>
-         * </table>
+         * - In Outlook on the web and new Outlook on Windows, don't set the {@link https://developer.mozilla.org/docs/Web/API/Window/name | window.name} property
+         * when configuring a dialog in your add-in. The `window.name` property is used by these Outlook clients to maintain functionality across page redirects.
          *
-         * In the callback function passed to the displayDialogAsync method, you can use the properties of the AsyncResult object to return the
+         * - In the callback function passed to the displayDialogAsync method, you can use the properties of the AsyncResult object to return the
          * following information.
          *
          * <table>

office-js/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@types/office-js",
-    "version": "1.0.471",
+    "version": "1.0.472",
     "description": "TypeScript definitions for office-js",
     "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-js",
     "license": "MIT",
@@ -46,6 +46,6 @@
     "scripts": {},
     "dependencies": {},
     "peerDependencies": {},
-    "typesPublisherContentHash": "ede7f416b00d9102884a8f6cf936d43bb2bc3740b23464f1a23177e01b5b2da1",
+    "typesPublisherContentHash": "55593866e1b15768b5c51f2e53d644121261125ff67f4ed3d72c0f273b5b5e72",
     "typeScriptVersion": "5.0"
 }