@types/office-js-preview 1.0.452 → 1.0.454

office-js-preview/README.md

@@ -8,7 +8,7 @@ This package contains type definitions for office-js-preview (https://github.com
 Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-js-preview.
 
 ### Additional Details
- * Last updated: Fri, 09 Feb 2024 17:35:52 GMT
+ * Last updated: Thu, 15 Feb 2024 19:35:54 GMT
  * Dependencies: none
 
 # Credits

office-js-preview/index.d.ts

@@ -948,11 +948,11 @@ declare namespace Office {
          */
         officeTheme: OfficeTheme;
         /**
-         * Gets a partition key for local storage. Add-ins should use this key as the location to securely store data.
+         * Gets a partition key for local storage. Add-ins should use this partition key as part of the storage key to securely store data. The partition key is `undefined` in environments without partitioning, such as the browser controls for Windows applications.
          *
          * @remarks
          *
-         * The hashed value of the UserPrincipalName (UPN) for the add-in's current partition.
+         * See the article {@link https://learn.microsoft.com/office/dev/add-ins/develop/persisting-add-in-state-and-settings | Persist add-in state and settings} for more information.
          */
         partitionKey: string;
         /**
@@ -2376,18 +2376,10 @@ declare namespace Office {
      *
      * Only task pane add-ins for Outlook support Mailbox API set event types.
      *
-     * @remarks
-     *
-     * **`BindingDataChanged` and `BindingSelectionChanged` applications**: Excel, Word.
-     *
      */
     enum EventType {
         /**
-         * A Document.ActiveViewChanged event was raised in PowerPoint.
-         *
-         * @remarks
-         *
-         * **Applications**: PowerPoint
+         * A `Document.ActiveViewChanged` event was raised in PowerPoint.
          */
         ActiveViewChanged,
         /**
@@ -2412,22 +2404,17 @@ declare namespace Office {
          */
         AttachmentsChanged,
         /**
-         * Occurs when data within the binding is changed.
+         * Occurs when data within the binding is changed in Excel or Word.
+         * 
          * To add an event handler for the BindingDataChanged event of a binding, use the addHandlerAsync method of the Binding object.
          * The event handler receives an argument of type {@link Office.BindingDataChangedEventArgs}.
-         *
-         * @remarks
-         *
-         * **Applications**: Excel, Word
          */
         BindingDataChanged,
         /**
-         * Occurs when the selection is changed within the binding. To add an event handler for the BindingSelectionChanged event of a binding, use
-         * the addHandlerAsync method of the Binding object. The event handler receives an argument of type {@link Office.BindingSelectionChangedEventArgs}.
-         *
-         * @remarks
-         *
-         * **Applications**: Excel, Word
+         * Occurs when the selection is changed within the binding in Excel or Word. 
+         * 
+         * To add an event handler for the `BindingSelectionChanged` event of a binding, use
+         * the `addHandlerAsync` method of the `Binding` object. The event handler receives an argument of type {@link Office.BindingSelectionChangedEventArgs}.
          */
         BindingSelectionChanged,
         /**
@@ -2443,11 +2430,7 @@ declare namespace Office {
          */
         DialogParentMessageReceived,
         /**
-         * Triggers when a document-level selection happens.
-         *
-         * @remarks
-         *
-         * **Applications**: Excel, Word
+         * Triggers when a document-level selection happens in Excel or Word.
          */
         DocumentSelectionChanged,
         /**
@@ -2484,15 +2467,15 @@ declare namespace Office {
          */
         ItemChanged,
         /**
-         * Triggers when a customXmlPart node is deleted.
+         * Triggers when a `customXmlPart` node is deleted.
          */
         NodeDeleted,
         /**
-         * Triggers when a customXmlPart node is inserted.
+         * Triggers when a `customXmlPart` node is inserted.
          */
         NodeInserted,
         /**
-         * Triggers when a customXmlPart node is replaced.
+         * Triggers when a `customXmlPart` node is replaced.
          */
         NodeReplaced,
         /**
@@ -2509,7 +2492,7 @@ declare namespace Office {
         OfficeThemeChanged,
         /**
          * Occurs when the recipient list of the selected item or the appointment location is changed in Outlook.
-         * **Important**: This event can only be handled in a task pane. It isn't supported by function commands.
+         * **Important**: Only available with task pane implementation.
          *
          * To add an event handler for the `RecipientsChanged` event, use the `addHandlerAsync` method of the `Item` object.
          * The event handler receives an argument of type
@@ -2520,7 +2503,7 @@ declare namespace Office {
         RecipientsChanged,
         /**
          * Occurs when the recurrence pattern of the selected series is changed in Outlook.
-         * **Important**: This event can only be handled in a task pane. It isn't supported by function commands.
+         * **Important**: Only available with task pane implementation.
          *
          * To add an event handler for the `RecurrenceChanged` event, use the `addHandlerAsync` method of the `Item` object.
          * The event handler receives an argument of type
@@ -2554,11 +2537,7 @@ declare namespace Office {
          */
         SensitivityLabelChanged,
         /**
-         * A Settings.settingsChanged event was raised.
-         *
-         * @remarks
-         *
-         * **Applications**: Excel, PowerPoint, Word
+         * A `Settings.settingsChanged` event was raised in Excel, PowerPoint, or Word.
          */
         SettingsChanged,
         /**
@@ -8865,9 +8844,16 @@ declare namespace Office {
          *
          * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read
          *
-         * **Important**: Entity-based contextual Outlook add-ins will be retired in Q2 of 2024. Once retired, contextual add-ins will no longer be able to detect
-         * entities in mail items to perform tasks on them. To help minimize potential disruptions, the following will still be supported after entity-based
-         * contextual add-ins are retired.
+         * **Important**: Entity-based contextual Outlook add-ins will be retired in Q2 of 2024. The work to retire this feature will start in May and continue
+         * until the end of June. After June, contextual add-ins will no longer be able to detect entities in mail items to perform tasks on them.
+         * The following APIs will also be retired.
+         *
+         * - `Office.context.mailbox.item.getEntities`
+         * - `Office.context.mailbox.item.getEntitiesByType`
+         * - `Office.context.mailbox.item.getFilteredEntitiesByName`
+         * - `Office.context.mailbox.item.getSelectedEntities`
+         *
+         * To help minimize potential disruptions, the following will still be supported after entity-based contextual add-ins are retired.
          *
          * - An alternative implementation of the **Join Meeting** button, which is activated by online meeting add-ins, is being developed. Once support for
          * entity-based contextual add-ins ends, online meeting add-ins will automatically transition to the alternative implementation to activate the
@@ -11885,18 +11871,12 @@ declare namespace Office {
          *
          * **Important**:
          *
-         * - Entity-based contextual Outlook add-ins will be retired in Q2 of 2024. Once retired, contextual add-ins will no longer be able to detect
-         * entities in mail items to perform tasks on them.
-         *
-         * An alternative implementation of the **Join Meeting** button, which is activated by online meeting add-ins, is being developed.
-         * Once support for entity-based contextual add-ins ends, online meeting add-ins will automatically transition to the alternative implementation
-         * to activate the **Join Meeting** button.
-         *
+         * - Entity-based contextual Outlook add-ins, including the `getEntities` method, will be retired in Q2 of 2024. The work to retire this method will
+         * start in May and continue until the end of June. After June, contextual add-ins will no longer be able to detect entities in mail items to perform tasks on them.
          * Regular expression rules will continue to be supported after entity-based contextual add-ins are retired. We recommend updating your contextual add-in
          * to use regular expression rules as an alternative solution. For guidance on how to implement these rules, see
          * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/use-regular-expressions-to-show-an-outlook-add-in | Use regular expression activation rules to show an Outlook add-in}.
-         *
-         * For more information, see
+         * To learn more about the retirement of entity-based contextual Outlook add-ins, see
          * {@link https://devblogs.microsoft.com/microsoft365dev/retirement-of-entity-based-contextual-outlook-add-ins | Retirement of entity-based contextual Outlook add-ins}.
          *
          * - This method isn't supported in Outlook on Android or on iOS. For more information on supported APIs in Outlook mobile, see
@@ -11920,18 +11900,12 @@ declare namespace Office {
          * 
          * **Important**:
          *
-         * - Entity-based contextual Outlook add-ins will be retired in Q2 of 2024. Once retired, contextual add-ins will no longer be able to detect
-         * entities in mail items to perform tasks on them.
-         *
-         * An alternative implementation of the **Join Meeting** button, which is activated by online meeting add-ins, is being developed.
-         * Once support for entity-based contextual add-ins ends, online meeting add-ins will automatically transition to the alternative implementation
-         * to activate the **Join Meeting** button.
-         *
+         * - Entity-based contextual Outlook add-ins, including the `getEntitiesByType` method, will be retired in Q2 of 2024. The work to retire this method will
+         * start in May and continue until the end of June. After June, contextual add-ins will no longer be able to detect entities in mail items to perform tasks on them.
          * Regular expression rules will continue to be supported after entity-based contextual add-ins are retired. We recommend updating your contextual add-in
          * to use regular expression rules as an alternative solution. For guidance on how to implement these rules, see
          * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/use-regular-expressions-to-show-an-outlook-add-in | Use regular expression activation rules to show an Outlook add-in}.
-         *
-         * For more information, see
+         * To learn more about the retirement of entity-based contextual Outlook add-ins, see
          * {@link https://devblogs.microsoft.com/microsoft365dev/retirement-of-entity-based-contextual-outlook-add-ins | Retirement of entity-based contextual Outlook add-ins}.
          *
          * - This method isn't supported in Outlook on Android or on iOS. For more information on supported APIs in Outlook mobile, see
@@ -12003,18 +11977,12 @@ declare namespace Office {
          *
          * **Important**:
          *
-         * - Entity-based contextual Outlook add-ins will be retired in Q2 of 2024. Once retired, contextual add-ins will no longer be able to detect
-         * entities in mail items to perform tasks on them.
-         *
-         * An alternative implementation of the **Join Meeting** button, which is activated by online meeting add-ins, is being developed.
-         * Once support for entity-based contextual add-ins ends, online meeting add-ins will automatically transition to the alternative implementation
-         * to activate the **Join Meeting** button.
-         *
+         * - Entity-based contextual Outlook add-ins, including the `getFilteredEntitiesByName` method, will be retired in Q2 of 2024. The work to retire this method will
+         * start in May and continue until the end of June. After June, contextual add-ins will no longer be able to detect entities in mail items to perform tasks on them.
          * Regular expression rules will continue to be supported after entity-based contextual add-ins are retired. We recommend updating your contextual add-in
          * to use regular expression rules as an alternative solution. For guidance on how to implement these rules, see
          * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/use-regular-expressions-to-show-an-outlook-add-in | Use regular expression activation rules to show an Outlook add-in}.
-         *
-         * For more information, see
+         * To learn more about the retirement of entity-based contextual Outlook add-ins, see
          * {@link https://devblogs.microsoft.com/microsoft365dev/retirement-of-entity-based-contextual-outlook-add-ins | Retirement of entity-based contextual Outlook add-ins}.
          *
          * - 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},
@@ -12079,17 +12047,10 @@ declare namespace Office {
          * **Important**:
          *
          * - Entity-based contextual Outlook add-ins will be retired in Q2 of 2024. Once retired, contextual add-ins will no longer be able to detect
-         * entities in mail items to perform tasks on them.
-         *
-         * An alternative implementation of the **Join Meeting** button, which is activated by online meeting add-ins, is being developed.
-         * Once support for entity-based contextual add-ins ends, online meeting add-ins will automatically transition to the alternative implementation
-         * to activate the **Join Meeting** button.
-         *
-         * Regular expression rules will continue to be supported after entity-based contextual add-ins are retired. We recommend updating your contextual add-in
-         * to use regular expression rules as an alternative solution. For guidance on how to implement these rules, see
+         * entities in mail items to perform tasks on them. Regular expression rules will continue to be supported after entity-based contextual add-ins are retired.
+         * We recommend updating your contextual add-in to use regular expression rules as an alternative solution. For guidance on how to implement these rules, see
          * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/use-regular-expressions-to-show-an-outlook-add-in | Use regular expression activation rules to show an Outlook add-in}.
-         *
-         * For more information, see
+         * To learn more about the retirement of entity-based contextual add-ins, see
          * {@link https://devblogs.microsoft.com/microsoft365dev/retirement-of-entity-based-contextual-outlook-add-ins | Retirement of entity-based contextual Outlook add-ins}.
          *
          * - 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},
@@ -12120,17 +12081,10 @@ declare namespace Office {
          * **Important**:
          *
          * - Entity-based contextual Outlook add-ins will be retired in Q2 of 2024. Once retired, contextual add-ins will no longer be able to detect
-         * entities in mail items to perform tasks on them.
-         *
-         * An alternative implementation of the **Join Meeting** button, which is activated by online meeting add-ins, is being developed.
-         * Once support for entity-based contextual add-ins ends, online meeting add-ins will automatically transition to the alternative implementation
-         * to activate the **Join Meeting** button.
-         *
-         * Regular expression rules will continue to be supported after entity-based contextual add-ins are retired. We recommend updating your contextual add-in
-         * to use regular expression rules as an alternative solution. For guidance on how to implement these rules, see
+         * entities in mail items to perform tasks on them. Regular expression rules will continue to be supported after entity-based contextual add-ins are retired.
+         * We recommend updating your contextual add-in to use regular expression rules as an alternative solution. For guidance on how to implement these rules, see
          * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/use-regular-expressions-to-show-an-outlook-add-in | Use regular expression activation rules to show an Outlook add-in}.
-         *
-         * For more information, see
+         * To learn more about the retirement of entity-based contextual add-ins, see
          * {@link https://devblogs.microsoft.com/microsoft365dev/retirement-of-entity-based-contextual-outlook-add-ins | Retirement of entity-based contextual Outlook add-ins}.
          *
          * - 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},
@@ -12158,24 +12112,19 @@ declare namespace Office {
          *
          * **Important**:
          *
-         * - Entity-based contextual Outlook add-ins will be retired in Q2 of 2024. Once retired, contextual add-ins will no longer be able to detect
-         * entities in mail items to perform tasks on them.
-         *
-         * An alternative implementation of the **Join Meeting** button, which is activated by online meeting add-ins, is being developed.
-         * Once support for entity-based contextual add-ins ends, online meeting add-ins will automatically transition to the alternative implementation
-         * to activate the **Join Meeting** button.
-         *
+         * - Entity-based contextual Outlook add-ins, including the `getSelectedEntities` method, will be retired in Q2 of 2024. The work to retire this method will
+         * start in May and continue until the end of June. After June, contextual add-ins will no longer be able to detect entities in mail items to perform tasks on them.
          * Regular expression rules will continue to be supported after entity-based contextual add-ins are retired. We recommend updating your contextual add-in
          * to use regular expression rules as an alternative solution. For guidance on how to implement these rules, see
          * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/use-regular-expressions-to-show-an-outlook-add-in | Use regular expression activation rules to show an Outlook add-in}.
-         *
-         * For more information, see
+         * To learn more about the retirement of entity-based contextual Outlook add-ins, see
          * {@link https://devblogs.microsoft.com/microsoft365dev/retirement-of-entity-based-contextual-outlook-add-ins | Retirement of entity-based contextual Outlook add-ins}.
          *
          * - 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 | unified manifest for Microsoft 365 (preview)}.
          *
-         * - This method isn't supported in Outlook on iOS or Android.
+         * - This method isn't supported in Outlook on iOS or Android. For more information on supported APIs in Outlook mobile, see
+         * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
          *
          * @param name - The name of the `ItemHasRegularExpressionMatch` rule element that defines the filter to match.
          */
@@ -12200,23 +12149,17 @@ declare namespace Office {
          * **Important**:
          *
          * - Entity-based contextual Outlook add-ins will be retired in Q2 of 2024. Once retired, contextual add-ins will no longer be able to detect
-         * entities in mail items to perform tasks on them.
-         *
-         * An alternative implementation of the **Join Meeting** button, which is activated by online meeting add-ins, is being developed.
-         * Once support for entity-based contextual add-ins ends, online meeting add-ins will automatically transition to the alternative implementation
-         * to activate the **Join Meeting** button.
-         *
-         * Regular expression rules will continue to be supported after entity-based contextual add-ins are retired. We recommend updating your contextual add-in
-         * to use regular expression rules as an alternative solution. For guidance on how to implement these rules, see
+         * entities in mail items to perform tasks on them. Regular expression rules will continue to be supported after entity-based contextual add-ins are retired.
+         * We recommend updating your contextual add-in to use regular expression rules as an alternative solution. For guidance on how to implement these rules, see
          * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/use-regular-expressions-to-show-an-outlook-add-in | Use regular expression activation rules to show an Outlook add-in}.
-         *
-         * For more information, see
+         * To learn more about the retirement of entity-based contextual add-ins, see
          * {@link https://devblogs.microsoft.com/microsoft365dev/retirement-of-entity-based-contextual-outlook-add-ins | Retirement of entity-based contextual Outlook add-ins}.
          *
          * - 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 | unified manifest for Microsoft 365 (preview)}.
          *
-         * - This method isn't supported in Outlook on iOS or Android.
+         * - This method isn't supported in Outlook on iOS or Android. For more information on supported APIs in Outlook mobile, see
+         * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
          *
          * - If you specify an `ItemHasRegularExpressionMatch` rule on the body property of an item, the regular expression should further filter the body
          * and shouldn't attempt to return the entire body of the item. Using a regular expression such as .* to obtain the entire body of an item doesn't always return the
@@ -13253,9 +13196,16 @@ declare namespace Office {
      *
      * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Read
      *
-     * **Important**: Entity-based contextual Outlook add-ins will be retired in Q2 of 2024. Once retired, contextual add-ins will no longer be able to detect
-     * entities in mail items to perform tasks on them. To help minimize potential disruptions, the following will still be supported after entity-based
-     * contextual add-ins are retired.
+     * **Important**: Entity-based contextual Outlook add-ins will be retired in Q2 of 2024. The work to retire this feature will start in May and continue
+     * until the end of June. After June, contextual add-ins will no longer be able to detect entities in mail items to perform tasks on them.
+     * The following APIs will also be retired.
+     *
+     * - `Office.context.mailbox.item.getEntities`
+     * - `Office.context.mailbox.item.getEntitiesByType`
+     * - `Office.context.mailbox.item.getFilteredEntitiesByName`
+     * - `Office.context.mailbox.item.getSelectedEntities`
+     *
+     * To help minimize potential disruptions, the following will still be supported after entity-based contextual add-ins are retired.
      *
      * - An alternative implementation of the **Join Meeting** button, which is activated by online meeting add-ins, is being developed. Once support for
      * entity-based contextual add-ins ends, online meeting add-ins will automatically transition to the alternative implementation to activate the
@@ -14041,9 +13991,16 @@ declare namespace Office {
      *
      * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Read
      *
-     * **Important**: Entity-based contextual Outlook add-ins will be retired in Q2 of 2024. Once retired, contextual add-ins will no longer be able to detect
-     * entities in mail items to perform tasks on them. To help minimize potential disruptions, the following will still be supported after entity-based
-     * contextual add-ins are retired.
+     * **Important**: Entity-based contextual Outlook add-ins will be retired in Q2 of 2024. The work to retire this feature will start in May and continue
+     * until the end of June. After June, contextual add-ins will no longer be able to detect entities in mail items to perform tasks on them.
+     * The following APIs will also be retired.
+     *
+     * - `Office.context.mailbox.item.getEntities`
+     * - `Office.context.mailbox.item.getEntitiesByType`
+     * - `Office.context.mailbox.item.getFilteredEntitiesByName`
+     * - `Office.context.mailbox.item.getSelectedEntities`
+     *
+     * To help minimize potential disruptions, the following will still be supported after entity-based contextual add-ins are retired.
      *
      * - An alternative implementation of the **Join Meeting** button, which is activated by online meeting add-ins, is being developed. Once support for
      * entity-based contextual add-ins ends, online meeting add-ins will automatically transition to the alternative implementation to activate the
@@ -15737,9 +15694,16 @@ declare namespace Office {
      *
      * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Read
      *
-     * **Important**: Entity-based contextual Outlook add-ins will be retired in Q2 of 2024. Once retired, contextual add-ins will no longer be able to detect
-     * entities in mail items to perform tasks on them. To help minimize potential disruptions, the following will still be supported after entity-based
-     * contextual add-ins are retired.
+     * **Important**: Entity-based contextual Outlook add-ins will be retired in Q2 of 2024. The work to retire this feature will start in May and continue
+     * until the end of June. After June, contextual add-ins will no longer be able to detect entities in mail items to perform tasks on them.
+     * The following APIs will also be retired.
+     *
+     * - `Office.context.mailbox.item.getEntities`
+     * - `Office.context.mailbox.item.getEntitiesByType`
+     * - `Office.context.mailbox.item.getFilteredEntitiesByName`
+     * - `Office.context.mailbox.item.getSelectedEntities`
+     *
+     * To help minimize potential disruptions, the following will still be supported after entity-based contextual add-ins are retired.
      *
      * - An alternative implementation of the **Join Meeting** button, which is activated by online meeting add-ins, is being developed. Once support for
      * entity-based contextual add-ins ends, online meeting add-ins will automatically transition to the alternative implementation to activate the
@@ -17830,18 +17794,12 @@ declare namespace Office {
          *
          * **Important**:
          *
-         * - Entity-based contextual Outlook add-ins will be retired in Q2 of 2024. Once retired, contextual add-ins will no longer be able to detect
-         * entities in mail items to perform tasks on them.
-         *
-         * An alternative implementation of the **Join Meeting** button, which is activated by online meeting add-ins, is being developed.
-         * Once support for entity-based contextual add-ins ends, online meeting add-ins will automatically transition to the alternative implementation
-         * to activate the **Join Meeting** button.
-         *
+         * - Entity-based contextual Outlook add-ins, including the `getEntities` method, will be retired in Q2 of 2024. The work to retire this method will
+         * start in May and continue until the end of June. After June, contextual add-ins will no longer be able to detect entities in mail items to perform tasks on them.
          * Regular expression rules will continue to be supported after entity-based contextual add-ins are retired. We recommend updating your contextual add-in
          * to use regular expression rules as an alternative solution. For guidance on how to implement these rules, see
          * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/use-regular-expressions-to-show-an-outlook-add-in | Use regular expression activation rules to show an Outlook add-in}.
-         *
-         * For more information, see
+         * To learn more about the retirement of entity-based contextual Outlook add-ins, see
          * {@link https://devblogs.microsoft.com/microsoft365dev/retirement-of-entity-based-contextual-outlook-add-ins | Retirement of entity-based contextual Outlook add-ins}.
          *
          * - This method isn't supported in Outlook on Android or on iOS. For more information on supported APIs in Outlook mobile, see
@@ -17865,18 +17823,12 @@ declare namespace Office {
          *
          * **Important**:
          *
-         * - Entity-based contextual Outlook add-ins will be retired in Q2 of 2024. Once retired, contextual add-ins will no longer be able to detect
-         * entities in mail items to perform tasks on them.
-         *
-         * An alternative implementation of the **Join Meeting** button, which is activated by online meeting add-ins, is being developed.
-         * Once support for entity-based contextual add-ins ends, online meeting add-ins will automatically transition to the alternative implementation
-         * to activate the **Join Meeting** button.
-         *
+         * - Entity-based contextual Outlook add-ins, including the `getEntitiesByType` method, will be retired in Q2 of 2024. The work to retire this method will
+         * start in May and continue until the end of June. After June, contextual add-ins will no longer be able to detect entities in mail items to perform tasks on them.
          * Regular expression rules will continue to be supported after entity-based contextual add-ins are retired. We recommend updating your contextual add-in
          * to use regular expression rules as an alternative solution. For guidance on how to implement these rules, see
          * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/use-regular-expressions-to-show-an-outlook-add-in | Use regular expression activation rules to show an Outlook add-in}.
-         *
-         * For more information, see
+         * To learn more about the retirement of entity-based contextual Outlook add-ins, see
          * {@link https://devblogs.microsoft.com/microsoft365dev/retirement-of-entity-based-contextual-outlook-add-ins | Retirement of entity-based contextual Outlook add-ins}.
          *
          * - This method isn't supported in Outlook on Android or on iOS. For more information on supported APIs in Outlook mobile, see
@@ -17949,18 +17901,12 @@ declare namespace Office {
          *
          * **Important**:
          *
-         * - Entity-based contextual Outlook add-ins will be retired in Q2 of 2024. Once retired, contextual add-ins will no longer be able to detect
-         * entities in mail items to perform tasks on them.
-         *
-         * An alternative implementation of the **Join Meeting** button, which is activated by online meeting add-ins, is being developed.
-         * Once support for entity-based contextual add-ins ends, online meeting add-ins will automatically transition to the alternative implementation
-         * to activate the **Join Meeting** button.
-         *
+         * - Entity-based contextual Outlook add-ins, including the `getFilteredEntitiesByName` method, will be retired in Q2 of 2024. The work to retire this method will
+         * start in May and continue until the end of June. After June, contextual add-ins will no longer be able to detect entities in mail items to perform tasks on them.
          * Regular expression rules will continue to be supported after entity-based contextual add-ins are retired. We recommend updating your contextual add-in
          * to use regular expression rules as an alternative solution. For guidance on how to implement these rules, see
          * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/use-regular-expressions-to-show-an-outlook-add-in | Use regular expression activation rules to show an Outlook add-in}.
-         *
-         * For more information, see
+         * To learn more about the retirement of entity-based contextual Outlook add-ins, see
          * {@link https://devblogs.microsoft.com/microsoft365dev/retirement-of-entity-based-contextual-outlook-add-ins | Retirement of entity-based contextual Outlook add-ins}.
          *
          * - 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},
@@ -18025,17 +17971,10 @@ declare namespace Office {
          * **Important**:
          *
          * - Entity-based contextual Outlook add-ins will be retired in Q2 of 2024. Once retired, contextual add-ins will no longer be able to detect
-         * entities in mail items to perform tasks on them.
-         *
-         * An alternative implementation of the **Join Meeting** button, which is activated by online meeting add-ins, is being developed.
-         * Once support for entity-based contextual add-ins ends, online meeting add-ins will automatically transition to the alternative implementation
-         * to activate the **Join Meeting** button.
-         *
-         * Regular expression rules will continue to be supported after entity-based contextual add-ins are retired. We recommend updating your contextual add-in
-         * to use regular expression rules as an alternative solution. For guidance on how to implement these rules, see
+         * entities in mail items to perform tasks on them. Regular expression rules will continue to be supported after entity-based contextual add-ins are retired.
+         * We recommend updating your contextual add-in to use regular expression rules as an alternative solution. For guidance on how to implement these rules, see
          * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/use-regular-expressions-to-show-an-outlook-add-in | Use regular expression activation rules to show an Outlook add-in}.
-         *
-         * For more information, see
+         * To learn more about the retirement of entity-based contextual add-ins, see
          * {@link https://devblogs.microsoft.com/microsoft365dev/retirement-of-entity-based-contextual-outlook-add-ins | Retirement of entity-based contextual Outlook add-ins}.
          *
          * - 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},
@@ -18066,17 +18005,10 @@ declare namespace Office {
          * **Important**:
          *
          * - Entity-based contextual Outlook add-ins will be retired in Q2 of 2024. Once retired, contextual add-ins will no longer be able to detect
-         * entities in mail items to perform tasks on them.
-         *
-         * An alternative implementation of the **Join Meeting** button, which is activated by online meeting add-ins, is being developed.
-         * Once support for entity-based contextual add-ins ends, online meeting add-ins will automatically transition to the alternative implementation
-         * to activate the **Join Meeting** button.
-         *
-         * Regular expression rules will continue to be supported after entity-based contextual add-ins are retired. We recommend updating your contextual add-in
-         * to use regular expression rules as an alternative solution. For guidance on how to implement these rules, see
+         * entities in mail items to perform tasks on them. Regular expression rules will continue to be supported after entity-based contextual add-ins are retired.
+         * We recommend updating your contextual add-in to use regular expression rules as an alternative solution. For guidance on how to implement these rules, see
          * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/use-regular-expressions-to-show-an-outlook-add-in | Use regular expression activation rules to show an Outlook add-in}.
-         *
-         * For more information, see
+         * To learn more about the retirement of entity-based contextual add-ins, see
          * {@link https://devblogs.microsoft.com/microsoft365dev/retirement-of-entity-based-contextual-outlook-add-ins | Retirement of entity-based contextual Outlook add-ins}.
          *
          * - 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},
@@ -18106,21 +18038,22 @@ declare namespace Office {
          *
          * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read
          *
-         * **Important**: Entity-based contextual Outlook add-ins will be retired in Q2 of 2024. Once retired, contextual add-ins will no longer be able to detect
-         * entities in mail items to perform tasks on them. To help minimize potential disruptions, the following will still be supported after entity-based
-         * contextual add-ins are retired.
-         *
-         * - An alternative implementation of the **Join Meeting** button, which is activated by online meeting add-ins, is being developed. Once support for
-         * entity-based contextual add-ins ends, online meeting add-ins will automatically transition to the alternative implementation to activate the
-         * **Join Meeting** button.
+         * **Important**:
          *
-         * - Regular expression rules will continue to be supported after entity-based contextual add-ins are retired. We recommend updating your contextual add-in
+         * - Entity-based contextual Outlook add-ins, including the `getSelectedEntities` method, will be retired in Q2 of 2024. The work to retire this method will
+         * start in May and continue until the end of June. After June, contextual add-ins will no longer be able to detect entities in mail items to perform tasks on them.
+         * Regular expression rules will continue to be supported after entity-based contextual add-ins are retired. We recommend updating your contextual add-in
          * to use regular expression rules as an alternative solution. For guidance on how to implement these rules, see
          * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/use-regular-expressions-to-show-an-outlook-add-in | Use regular expression activation rules to show an Outlook add-in}.
-         *
-         * For more information, see
+         * To learn more about the retirement of entity-based contextual Outlook add-ins, see
          * {@link https://devblogs.microsoft.com/microsoft365dev/retirement-of-entity-based-contextual-outlook-add-ins | Retirement of entity-based contextual Outlook add-ins}.
          *
+         * - 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 | unified manifest for Microsoft 365 (preview)}.
+         *
+         * - This method isn't supported in Outlook on iOS or Android. For more information on supported APIs in Outlook mobile, see
+         * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
+         *
          * @param name - The name of the `ItemHasRegularExpressionMatch` rule element that defines the filter to match.
          */
         getSelectedEntities(): Entities;
@@ -18144,23 +18077,17 @@ declare namespace Office {
          * **Important**:
          *
          * - Entity-based contextual Outlook add-ins will be retired in Q2 of 2024. Once retired, contextual add-ins will no longer be able to detect
-         * entities in mail items to perform tasks on them.
-         *
-         * An alternative implementation of the **Join Meeting** button, which is activated by online meeting add-ins, is being developed.
-         * Once support for entity-based contextual add-ins ends, online meeting add-ins will automatically transition to the alternative implementation
-         * to activate the **Join Meeting** button.
-         *
-         * Regular expression rules will continue to be supported after entity-based contextual add-ins are retired. We recommend updating your contextual add-in
-         * to use regular expression rules as an alternative solution. For guidance on how to implement these rules, see
+         * entities in mail items to perform tasks on them. Regular expression rules will continue to be supported after entity-based contextual add-ins are retired.
+         * We recommend updating your contextual add-in to use regular expression rules as an alternative solution. For guidance on how to implement these rules, see
          * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/use-regular-expressions-to-show-an-outlook-add-in | Use regular expression activation rules to show an Outlook add-in}.
-         *
-         * For more information, see
+         * To learn more about the retirement of entity-based contextual add-ins, see
          * {@link https://devblogs.microsoft.com/microsoft365dev/retirement-of-entity-based-contextual-outlook-add-ins | Retirement of entity-based contextual Outlook add-ins}.
          *
          * - 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 | unified manifest for Microsoft 365 (preview)}.
          *
-         * - This method isn't supported in Outlook on iOS or Android.
+         * - This method isn't supported in Outlook on iOS or Android. For more information on supported APIs in Outlook mobile, see
+         * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
          *
          * - If you specify an `ItemHasRegularExpressionMatch` rule on the body property of an item, the regular expression should further filter the body
          * and shouldn't attempt to return the entire body of the item. Using a regular expression such as .* to obtain the entire body of an item doesn't always return the
@@ -18732,9 +18659,16 @@ declare namespace Office {
      *
      * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Read
      *
-     * **Important**: Entity-based contextual Outlook add-ins will be retired in Q2 of 2024. Once retired, contextual add-ins will no longer be able to detect
-     * entities in mail items to perform tasks on them. To help minimize potential disruptions, the following will still be supported after entity-based
-     * contextual add-ins are retired.
+     * **Important**: Entity-based contextual Outlook add-ins will be retired in Q2 of 2024. The work to retire this feature will start in May and continue
+     * until the end of June. After June, contextual add-ins will no longer be able to detect entities in mail items to perform tasks on them.
+     * The following APIs will also be retired.
+     *
+     * - `Office.context.mailbox.item.getEntities`
+     * - `Office.context.mailbox.item.getEntitiesByType`
+     * - `Office.context.mailbox.item.getFilteredEntitiesByName`
+     * - `Office.context.mailbox.item.getSelectedEntities`
+     *
+     * To help minimize potential disruptions, the following will still be supported after entity-based contextual add-ins are retired.
      *
      * - An alternative implementation of the **Join Meeting** button, which is activated by online meeting add-ins, is being developed. Once support for
      * entity-based contextual add-ins ends, online meeting add-ins will automatically transition to the alternative implementation to activate the

office-js-preview/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@types/office-js-preview",
-    "version": "1.0.452",
+    "version": "1.0.454",
     "description": "TypeScript definitions for office-js-preview",
     "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-js-preview",
     "license": "MIT",
@@ -45,7 +45,7 @@
     },
     "scripts": {},
     "dependencies": {},
-    "typesPublisherContentHash": "9a725aac6969fcf22bb5900250be600501c37b8d493d4c06e1d1e5053d38494d",
+    "typesPublisherContentHash": "ae0055035ad1532604cb046c100f9b3015c5535d6737ffa235343cadbb72e742",
     "typeScriptVersion": "4.6",
     "nonNpm": true
 }