@types/office-js-preview 1.0.359 → 1.0.361

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

office-js-preview/index.d.ts

@@ -11691,7 +11691,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.
@@ -11747,7 +11749,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.
@@ -11774,7 +11778,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.
@@ -11799,6 +11805,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.
          *
@@ -11813,8 +11821,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.
@@ -16839,7 +16849,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.
@@ -16895,7 +16907,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.
@@ -16922,7 +16936,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.
@@ -16947,6 +16963,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.
          *
@@ -16961,8 +16979,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.
@@ -87214,6 +87234,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.
          */
@@ -87402,56 +87472,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.
          */
@@ -88194,6 +88214,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.
          *
@@ -91231,6 +91291,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.
          */
@@ -91832,6 +91942,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.
          */
@@ -93744,35 +93894,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.359",
+    "version": "1.0.361",
     "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": "785e69178c7407d5c54261bcf70b20d4303d936a792f28f45d96e2e5b7c63a96",
+    "typesPublisherContentHash": "f2beca111504af9b2f903cc76d4f74740ca229d76b4cd7cc46510aa07ddba7a4",
     "typeScriptVersion": "4.2"
 }