@types/office-js 1.0.304 → 1.0.306

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: Mon, 05 Dec 2022 20:33:21 GMT
+ * Last updated: Mon, 12 Dec 2022 21:49:43 GMT
  * Dependencies: none
  * Global values: `Excel`, `Office`, `OfficeCore`, `OfficeExtension`, `OneNote`, `PowerPoint`, `Visio`, `Word`
 

office-js/index.d.ts

@@ -653,6 +653,61 @@ declare namespace Office {
         onVisibilityModeChanged(
             handler: (message: VisibilityModeChangedMessage) => void,
         ): Promise<() => Promise<void>>;
+        /**
+         * Represents a modal notification dialog that can appear when the user attempts to close a document. The document won't close until the user responds.
+         * This API is only supported in Excel.
+         *
+         * @remarks
+         * **Requirement set**: {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/shared-runtime-requirement-sets | SharedRuntime 1.2}
+        */
+        beforeDocumentCloseNotification: BeforeDocumentCloseNotification;
+    }
+    /**
+     * Represents a modal notification dialog that can appear when the user attempts to close a document. The document won't close until the user responds.
+     * The notification dialog will allow the user to confirm the request to close the document or cancel the request to close the document.
+     * This API is only supported in Excel.
+     *
+     * @remarks
+     * **Requirement set**: {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/shared-runtime-requirement-sets | SharedRuntime 1.2}
+     */
+    interface BeforeDocumentCloseNotification {
+        /**
+         * Enable a modal notification dialog that appears when the user attempts to close a document. The document won't close until the user responds.
+         * This notification dialog asks the user to confirm the request to close the document, or allows the user to cancel the request to close the document.
+         * The `BeforeDocumentCloseNotification` API is only supported in Excel.
+         *
+         * @remarks
+         * **Requirement set**: {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/shared-runtime-requirement-sets | SharedRuntime 1.2}
+         */
+        enable(): Promise<void>;
+
+        /**
+         * Prevents the notification dialog from appearing when the user attempts to close a document.
+         * The `BeforeDocumentCloseNotification` API is only supported in Excel.
+         *
+         * @remarks
+         * **Requirement set**: {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/shared-runtime-requirement-sets | SharedRuntime 1.2}
+         */
+        disable(): Promise<void>;
+
+        /**
+         * Adds an event handler that detects when the `BeforeDocumentCloseNotification` close operation is cancelled. 
+         * This event handler will be triggered if both of the following conditions are met.
+         *
+         * 1. The add-in calls the `enable` method on the `BeforeDocumentCloseNotification` object.
+         * 
+         * 2. When the notification dialog is open, the end user clicks the **Don't close** button within the dialog, clicks the Close button in the upper right corner of the dialog, or presses the Esc key.
+         *
+         * The `BeforeDocumentCloseNotification` API is only supported in Excel.
+         * @param handler The event handler that is called when the dialog is cancelled.
+         * @returns A promise that resolves when the event handler is added.
+         *
+         * @remarks
+         * **Requirement set**: {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/shared-runtime-requirement-sets | SharedRuntime 1.2}
+        */
+        onCloseActionCancelled(
+            handler: () => void
+        ): Promise<() => Promise<void>>;
     }
     /**
      * An interface that contains all the functionality provided to manage the state of the Office ribbon.
@@ -11512,7 +11567,9 @@ declare namespace Office {
          */
         getEntitiesByType(entityType: MailboxEnums.EntityType | string): (string | Contact | MeetingSuggestion | PhoneNumber | TaskSuggestion)[];
         /**
-         * Returns well-known entities in the selected item that pass the named filter defined in the manifest XML file.
+         * Returns well-known entities in the selected item that pass the named filter defined in an XML manifest file.
+         * 
+         * **Note**: This method is used with the {@link https://learn.microsoft.com/office/dev/add-ins/outlook/activation-rules | activation rules feature for Outlook add-ins}, which isn't supported by the {@link https://learn.microsoft.com/office/dev/add-ins/develop/json-manifest-overview | Teams manifest for Office Add-ins (preview)}.
          *
          * The `getFilteredEntitiesByName` method returns the entities that match the regular expression defined in the `ItemHasKnownEntity` rule element
          * in the manifest XML file with the specified `FilterName` element value.
@@ -11568,7 +11625,9 @@ declare namespace Office {
          */
         getInitializationContextAsync(callback: (asyncResult: Office.AsyncResult<string>) => void): void;
         /**
-         * Returns string values in the selected item that match the regular expressions defined in the manifest XML file.
+         * Returns string values in the selected item that match the regular expressions defined in an XML manifest file.
+         * 
+         * **Note**: This method is used with the {@link https://learn.microsoft.com/office/dev/add-ins/outlook/activation-rules | activation rules feature for Outlook add-ins}, which isn't supported by the {@link https://learn.microsoft.com/office/dev/add-ins/develop/json-manifest-overview | Teams manifest for Office Add-ins (preview)}.
          *
          * The `getRegExMatches` method returns the strings that match the regular expression defined in each `ItemHasRegularExpressionMatch` or
          * `ItemHasKnownEntity` rule element in the manifest XML file.
@@ -11595,7 +11654,9 @@ declare namespace Office {
          */
         getRegExMatches(): any;
         /**
-         * Returns string values in the selected item that match the named regular expression defined in the manifest XML file.
+         * Returns string values in the selected item that match the named regular expression defined in an XML manifest file.
+         * 
+         * **Note**: This method is used with the {@link https://learn.microsoft.com/office/dev/add-ins/outlook/activation-rules | activation rules feature for Outlook add-ins}, which isn't supported by the {@link https://learn.microsoft.com/office/dev/add-ins/develop/json-manifest-overview | Teams manifest for Office Add-ins (preview)}.
          *
          * The `getRegExMatchesByName` method returns the strings that match the regular expression defined in the `ItemHasRegularExpressionMatch` rule
          * element in the manifest XML file with the specified `RegExName` element value.
@@ -11620,6 +11681,8 @@ declare namespace Office {
         getRegExMatchesByName(name: string): string[];
         /**
          * Gets the entities found in a highlighted match a user has selected. Highlighted matches apply to contextual add-ins.
+         * 
+         * **Note**: This method is used with the {@link https://learn.microsoft.com/office/dev/add-ins/outlook/activation-rules | activation rules feature for Outlook add-ins}, which isn't supported by the {@link https://learn.microsoft.com/office/dev/add-ins/develop/json-manifest-overview | Teams manifest for Office Add-ins (preview)}.
          *
          * **Note**: This method is not supported in Outlook on iOS or Android.
          *
@@ -11634,8 +11697,10 @@ declare namespace Office {
          */
         getSelectedEntities(): Entities;
         /**
-         * Returns string values in a highlighted match that match the regular expressions defined in the manifest XML file.
+         * Returns string values in a highlighted match that match the regular expressions defined in an XML manifest file.
          * Highlighted matches apply to contextual add-ins.
+         * 
+         * **Note**: This method is used with the {@link https://learn.microsoft.com/office/dev/add-ins/outlook/activation-rules | activation rules feature for Outlook add-ins}, which isn't supported by the {@link https://learn.microsoft.com/office/dev/add-ins/develop/json-manifest-overview | Teams manifest for Office Add-ins (preview)}.
          *
          * The `getSelectedRegExMatches` method returns the strings that match the regular expression defined in each `ItemHasRegularExpressionMatch` or
          * `ItemHasKnownEntity` rule element in the manifest XML file.
@@ -16494,7 +16559,9 @@ declare namespace Office {
          */
         getEntitiesByType(entityType: MailboxEnums.EntityType | string): (string | Contact | MeetingSuggestion | PhoneNumber | TaskSuggestion)[];
         /**
-         * Returns well-known entities in the selected item that pass the named filter defined in the manifest XML file.
+         * Returns well-known entities in the selected item that pass the named filter defined in an XML manifest file.
+         * 
+         * **Note**: This method is used with the {@link https://learn.microsoft.com/office/dev/add-ins/outlook/activation-rules | activation rules feature for Outlook add-ins}, which isn't supported by the {@link https://learn.microsoft.com/office/dev/add-ins/develop/json-manifest-overview | Teams manifest for Office Add-ins (preview)}.
          *
          * The `getFilteredEntitiesByName` method returns the entities that match the regular expression defined in the `ItemHasKnownEntity` rule element
          * in the manifest XML file with the specified `FilterName` element value.
@@ -16550,7 +16617,9 @@ declare namespace Office {
          */
         getInitializationContextAsync(callback: (asyncResult: Office.AsyncResult<string>) => void): void;
         /**
-         * Returns string values in the selected item that match the regular expressions defined in the manifest XML file.
+         * Returns string values in the selected item that match the regular expressions defined in an XML manifest file.
+         * 
+         * **Note**: This method is used with the {@link https://learn.microsoft.com/office/dev/add-ins/outlook/activation-rules | activation rules feature for Outlook add-ins}, which isn't supported by the {@link https://learn.microsoft.com/office/dev/add-ins/develop/json-manifest-overview | Teams manifest for Office Add-ins (preview)}.
          *
          * The `getRegExMatches` method returns the strings that match the regular expression defined in each `ItemHasRegularExpressionMatch` or
          * `ItemHasKnownEntity` rule element in the manifest XML file.
@@ -16577,7 +16646,9 @@ declare namespace Office {
          */
         getRegExMatches(): any;
         /**
-         * Returns string values in the selected item that match the named regular expression defined in the manifest XML file.
+         * Returns string values in the selected item that match the named regular expression defined in an XML manifest file.
+         * 
+         * **Note**: This method is used with the {@link https://learn.microsoft.com/office/dev/add-ins/outlook/activation-rules | activation rules feature for Outlook add-ins}, which isn't supported by the {@link https://learn.microsoft.com/office/dev/add-ins/develop/json-manifest-overview | Teams manifest for Office Add-ins (preview)}.
          *
          * The `getRegExMatchesByName` method returns the strings that match the regular expression defined in the
          * `ItemHasRegularExpressionMatch` rule element in the manifest XML file with the specified `RegExName` element value.
@@ -16602,6 +16673,8 @@ declare namespace Office {
         getRegExMatchesByName(name: string): string[];
         /**
          * Gets the entities found in a highlighted match a user has selected. Highlighted matches apply to contextual add-ins.
+         * 
+         * **Note**: This method is used with the {@link https://learn.microsoft.com/office/dev/add-ins/outlook/activation-rules | activation rules feature for Outlook add-ins}, which isn't supported by the {@link https://learn.microsoft.com/office/dev/add-ins/develop/json-manifest-overview | Teams manifest for Office Add-ins (preview)}.
          *
          * **Note**: This method is not supported in Outlook on iOS or Android.
          *
@@ -16616,8 +16689,10 @@ declare namespace Office {
          */
         getSelectedEntities(): Entities;
         /**
-         * Returns string values in a highlighted match that match the regular expressions defined in the manifest XML file.
+         * Returns string values in a highlighted match that match the regular expressions defined in an XML manifest file.
          * Highlighted matches apply to contextual add-ins.
+         * 
+         * **Note**: This method is used with the {@link https://learn.microsoft.com/office/dev/add-ins/outlook/activation-rules | activation rules feature for Outlook add-ins}, which isn't supported by the {@link https://learn.microsoft.com/office/dev/add-ins/develop/json-manifest-overview | Teams manifest for Office Add-ins (preview)}.
          *
          * The `getSelectedRegExMatches` method returns the strings that match the regular expression defined in
          * each `ItemHasRegularExpressionMatch` or `ItemHasKnownEntity` rule element in the manifest XML file.

office-js/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@types/office-js",
-    "version": "1.0.304",
+    "version": "1.0.306",
     "description": "TypeScript definitions for Office.js",
     "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-js",
     "license": "MIT",
@@ -45,6 +45,6 @@
     },
     "scripts": {},
     "dependencies": {},
-    "typesPublisherContentHash": "a817c804c6da49f2a5bfca9ebc6952f0f080400a4afc37b8ed02657989e4e3be",
+    "typesPublisherContentHash": "9cd40f17dd505e2505b98cd7849e9fe331bc7a055eb2e2a202dc3a0f95146f69",
     "typeScriptVersion": "4.2"
 }