@types/office-js-preview 1.0.360 → 1.0.362

office-js-preview/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-preview.
 
 ### Additional Details
- * Last updated: Tue, 06 Dec 2022 20:32:55 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-preview/index.d.ts

@@ -653,14 +653,12 @@ 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
-         * [Api set: SharedRuntime BETA (PREVIEW ONLY)]
-         * @beta
+         * **Requirement set**: {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/shared-runtime-requirement-sets | SharedRuntime 1.2}
         */
         beforeDocumentCloseNotification: BeforeDocumentCloseNotification;
     }
@@ -670,8 +668,7 @@ declare namespace Office {
      * This API is only supported in Excel.
      *
      * @remarks
-     * [Api set: SharedRuntime BETA (PREVIEW ONLY)]
-     * @beta
+     * **Requirement set**: {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/shared-runtime-requirement-sets | SharedRuntime 1.2}
      */
     interface BeforeDocumentCloseNotification {
         /**
@@ -680,8 +677,7 @@ declare namespace Office {
          * The `BeforeDocumentCloseNotification` API is only supported in Excel.
          *
          * @remarks
-         * [Api set: SharedRuntime BETA (PREVIEW ONLY)]
-         * @beta
+         * **Requirement set**: {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/shared-runtime-requirement-sets | SharedRuntime 1.2}
          */
         enable(): Promise<void>;
 
@@ -690,26 +686,24 @@ declare namespace Office {
          * The `BeforeDocumentCloseNotification` API is only supported in Excel.
          *
          * @remarks
-         * [Api set: SharedRuntime BETA (PREVIEW ONLY)]
-         * @beta
+         * **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 one of the following conditions is met.
-         *
-         * 1. 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.
+         * This event handler will be triggered if both of the following conditions are met.
          *
-         * 2. When the add-in calls the `enable` method on the `BeforeDocumentCloseNotification` object.
+         * 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
-         * [Api set: SharedRuntime BETA (PREVIEW ONLY)]
-         * @beta
+         * **Requirement set**: {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/shared-runtime-requirement-sets | SharedRuntime 1.2}
         */
         onCloseActionCancelled(
             handler: () => void
@@ -87234,6 +87228,56 @@ declare namespace Word {
             select?: string;
             expand?: string;
         }): Word.Body;
+        /**
+         * Occurs when new comments are added.
+         *
+         * @remarks
+         * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
+         *
+         * @eventproperty
+         * @beta
+         */
+        readonly onCommentAdded: OfficeExtension.EventHandlers<Word.CommentEventArgs>;
+        /**
+         * Occurs when a comment or its reply is changed.
+         *
+         * @remarks
+         * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
+         *
+         * @eventproperty
+         * @beta
+         */
+        readonly onCommentChanged: OfficeExtension.EventHandlers<Word.CommentEventArgs>;
+        /**
+         * Occurs when comments are deleted.
+         *
+         * @remarks
+         * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
+         *
+         * @eventproperty
+         * @beta
+         */
+        readonly onCommentDeleted: OfficeExtension.EventHandlers<Word.CommentEventArgs>;
+        /**
+         * Occurs when a comment is deselected.
+         *
+         * @remarks
+         * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
+         *
+         * @eventproperty
+         * @beta
+         */
+        readonly onCommentDeselected: OfficeExtension.EventHandlers<Word.CommentEventArgs>;
+        /**
+         * Occurs when a comment is selected.
+         *
+         * @remarks
+         * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
+         *
+         * @eventproperty
+         * @beta
+         */
+        readonly onCommentSelected: OfficeExtension.EventHandlers<Word.CommentEventArgs>;
         /**
          * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://docs.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you are using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection.
          */
@@ -87422,56 +87466,6 @@ declare namespace Word {
          * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load.
          */
         load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.CommentCollection;
-        /**
-         * Occurs when new comments are added.
-         *
-         * @remarks
-         * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
-         *
-         * @eventproperty
-         * @beta
-         */
-        readonly onCommentAdded: OfficeExtension.EventHandlers<Word.CommentEventArgs>;
-        /**
-         * Occurs when a comment or its reply is changed.
-         *
-         * @remarks
-         * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
-         *
-         * @eventproperty
-         * @beta
-         */
-        readonly onCommentChanged: OfficeExtension.EventHandlers<Word.CommentEventArgs>;
-        /**
-         * Occurs when comments are deleted.
-         *
-         * @remarks
-         * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
-         *
-         * @eventproperty
-         * @beta
-         */
-        readonly onCommentDeleted: OfficeExtension.EventHandlers<Word.CommentEventArgs>;
-        /**
-         * Occurs when a comment is deselected.
-         *
-         * @remarks
-         * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
-         *
-         * @eventproperty
-         * @beta
-         */
-        readonly onCommentDeselected: OfficeExtension.EventHandlers<Word.CommentEventArgs>;
-        /**
-         * Occurs when a comment is selected.
-         *
-         * @remarks
-         * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
-         *
-         * @eventproperty
-         * @beta
-         */
-        readonly onCommentSelected: OfficeExtension.EventHandlers<Word.CommentEventArgs>;
         /**
          * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://docs.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you are using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection.
          */
@@ -88214,6 +88208,46 @@ declare namespace Word {
             select?: string;
             expand?: string;
         }): Word.ContentControl;
+        /**
+         * Occurs when new comments are added.
+         *
+         * @remarks
+         * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
+         *
+         * @eventproperty
+         * @beta
+         */
+        readonly onCommentAdded: OfficeExtension.EventHandlers<Word.CommentEventArgs>;
+        /**
+         * Occurs when a comment or its reply is changed.
+         *
+         * @remarks
+         * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
+         *
+         * @eventproperty
+         * @beta
+         */
+        readonly onCommentChanged: OfficeExtension.EventHandlers<Word.CommentEventArgs>;
+        /**
+         * Occurs when a comment is deselected.
+         *
+         * @remarks
+         * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
+         *
+         * @eventproperty
+         * @beta
+         */
+        readonly onCommentDeselected: OfficeExtension.EventHandlers<Word.CommentEventArgs>;
+        /**
+         * Occurs when a comment is selected.
+         *
+         * @remarks
+         * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
+         *
+         * @eventproperty
+         * @beta
+         */
+        readonly onCommentSelected: OfficeExtension.EventHandlers<Word.CommentEventArgs>;
         /**
          * Occurs when data within the content control are changed. To get the new text, load this content control in the handler. To get the old text, do not load it.
          *
@@ -91251,6 +91285,56 @@ declare namespace Word {
             select?: string;
             expand?: string;
         }): Word.Paragraph;
+        /**
+         * Occurs when new comments are added.
+         *
+         * @remarks
+         * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
+         *
+         * @eventproperty
+         * @beta
+         */
+        readonly onCommentAdded: OfficeExtension.EventHandlers<Word.CommentEventArgs>;
+        /**
+         * Occurs when a comment or its reply is changed.
+         *
+         * @remarks
+         * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
+         *
+         * @eventproperty
+         * @beta
+         */
+        readonly onCommentChanged: OfficeExtension.EventHandlers<Word.CommentEventArgs>;
+        /**
+         * Occurs when comments are deleted.
+         *
+         * @remarks
+         * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
+         *
+         * @eventproperty
+         * @beta
+         */
+        readonly onCommentDeleted: OfficeExtension.EventHandlers<Word.CommentEventArgs>;
+        /**
+         * Occurs when a comment is deselected.
+         *
+         * @remarks
+         * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
+         *
+         * @eventproperty
+         * @beta
+         */
+        readonly onCommentDeselected: OfficeExtension.EventHandlers<Word.CommentEventArgs>;
+        /**
+         * Occurs when a comment is selected.
+         *
+         * @remarks
+         * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
+         *
+         * @eventproperty
+         * @beta
+         */
+        readonly onCommentSelected: OfficeExtension.EventHandlers<Word.CommentEventArgs>;
         /**
          * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://docs.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you are using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection.
          */
@@ -91852,6 +91936,46 @@ declare namespace Word {
             select?: string;
             expand?: string;
         }): Word.Range;
+        /**
+         * Occurs when new comments are added.
+         *
+         * @remarks
+         * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
+         *
+         * @eventproperty
+         * @beta
+         */
+        readonly onCommentAdded: OfficeExtension.EventHandlers<Word.CommentEventArgs>;
+        /**
+         * Occurs when a comment or its reply is changed.
+         *
+         * @remarks
+         * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
+         *
+         * @eventproperty
+         * @beta
+         */
+        readonly onCommentChanged: OfficeExtension.EventHandlers<Word.CommentEventArgs>;
+        /**
+         * Occurs when a comment is deselected.
+         *
+         * @remarks
+         * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
+         *
+         * @eventproperty
+         * @beta
+         */
+        readonly onCommentDeselected: OfficeExtension.EventHandlers<Word.CommentEventArgs>;
+        /**
+         * Occurs when a comment is selected.
+         *
+         * @remarks
+         * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
+         *
+         * @eventproperty
+         * @beta
+         */
+        readonly onCommentSelected: OfficeExtension.EventHandlers<Word.CommentEventArgs>;
         /**
          * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://docs.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you are using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection.
          */
@@ -93764,35 +93888,35 @@ declare namespace Word {
          */
         contentControlAdded = "ContentControlAdded",
         /**
-         * Represents that one or more comments were deleted from the comment collection.
+         * Represents that one or more comments were deleted.
          * @remarks
          * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
          * @beta
          */
         commentDeleted = "CommentDeleted",
         /**
-         * Represents that a comment was selected in the comment collection.
+         * Represents that a comment was selected.
          * @remarks
          * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
          * @beta
          */
         commentSelected = "CommentSelected",
         /**
-         * Represents that a comment was deselected in the comment collection.
+         * Represents that a comment was deselected.
          * @remarks
          * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
          * @beta
          */
         commentDeselected = "CommentDeselected",
         /**
-         * Represents that a comment or its reply was changed in the comment collection.
+         * Represents that a comment or its reply was changed.
          * @remarks
          * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
          * @beta
          */
         commentChanged = "CommentChanged",
         /**
-         * Represents that one or more new comments were added to the comment collection.
+         * Represents that one or more new comments were added.
          * @remarks
          * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
          * @beta

office-js-preview/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@types/office-js-preview",
-    "version": "1.0.360",
+    "version": "1.0.362",
     "description": "TypeScript definitions for Office.js",
     "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-js-preview",
     "license": "MIT",
@@ -45,6 +45,6 @@
     },
     "scripts": {},
     "dependencies": {},
-    "typesPublisherContentHash": "7a00fbeca65bd280ca493b8d05b8c325c400107715c662f5adb7cb7f56ec68d9",
+    "typesPublisherContentHash": "cc9dc189049fc9c07434e7a14814b03c534686e2f0e8f2a9b355c53c656e31ed",
     "typeScriptVersion": "4.2"
 }