@types/office-js 1.0.374 → 1.0.375

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. office-js/README.md +1 -1
  2. office-js/index.d.ts +107 -152
  3. office-js/package.json +2 -2
office-js/README.md CHANGED
@@ -8,7 +8,7 @@ This package contains type definitions for office-js (https://github.com/OfficeD
8
8
  Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-js.
9
9
 
10
10
  ### Additional Details
11
- * Last updated: Tue, 13 Feb 2024 22:07:06 GMT
11
+ * Last updated: Thu, 15 Feb 2024 19:35:54 GMT
12
12
  * Dependencies: none
13
13
 
14
14
  # Credits
office-js/index.d.ts CHANGED
@@ -8719,9 +8719,16 @@ declare namespace Office {
8719
8719
  *
8720
8720
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read
8721
8721
  *
8722
- * **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
8723
- * entities in mail items to perform tasks on them. To help minimize potential disruptions, the following will still be supported after entity-based
8724
- * contextual add-ins are retired.
8722
+ * **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
8723
+ * 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.
8724
+ * The following APIs will also be retired.
8725
+ *
8726
+ * - `Office.context.mailbox.item.getEntities`
8727
+ * - `Office.context.mailbox.item.getEntitiesByType`
8728
+ * - `Office.context.mailbox.item.getFilteredEntitiesByName`
8729
+ * - `Office.context.mailbox.item.getSelectedEntities`
8730
+ *
8731
+ * To help minimize potential disruptions, the following will still be supported after entity-based contextual add-ins are retired.
8725
8732
  *
8726
8733
  * - An alternative implementation of the **Join Meeting** button, which is activated by online meeting add-ins, is being developed. Once support for
8727
8734
  * entity-based contextual add-ins ends, online meeting add-ins will automatically transition to the alternative implementation to activate the
@@ -11599,20 +11606,14 @@ declare namespace Office {
11599
11606
  *
11600
11607
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee
11601
11608
  *
11602
- * **Important**:
11603
- *
11604
- * - 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
11605
- * entities in mail items to perform tasks on them.
11606
- *
11607
- * An alternative implementation of the **Join Meeting** button, which is activated by online meeting add-ins, is being developed.
11608
- * Once support for entity-based contextual add-ins ends, online meeting add-ins will automatically transition to the alternative implementation
11609
- * to activate the **Join Meeting** button.
11609
+ * **Important**:
11610
11610
  *
11611
+ * - Entity-based contextual Outlook add-ins, including the `getEntities` method, will be retired in Q2 of 2024. The work to retire this method will
11612
+ * 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.
11611
11613
  * Regular expression rules will continue to be supported after entity-based contextual add-ins are retired. We recommend updating your contextual add-in
11612
11614
  * to use regular expression rules as an alternative solution. For guidance on how to implement these rules, see
11613
11615
  * {@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}.
11614
- *
11615
- * For more information, see
11616
+ * To learn more about the retirement of entity-based contextual Outlook add-ins, see
11616
11617
  * {@link https://devblogs.microsoft.com/microsoft365dev/retirement-of-entity-based-contextual-outlook-add-ins | Retirement of entity-based contextual Outlook add-ins}.
11617
11618
  *
11618
11619
  * - This method isn't supported in Outlook on Android or on iOS. For more information on supported APIs in Outlook mobile, see
@@ -11636,18 +11637,12 @@ declare namespace Office {
11636
11637
  *
11637
11638
  * **Important**:
11638
11639
  *
11639
- * - 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
11640
- * entities in mail items to perform tasks on them.
11641
- *
11642
- * An alternative implementation of the **Join Meeting** button, which is activated by online meeting add-ins, is being developed.
11643
- * Once support for entity-based contextual add-ins ends, online meeting add-ins will automatically transition to the alternative implementation
11644
- * to activate the **Join Meeting** button.
11645
- *
11640
+ * - Entity-based contextual Outlook add-ins, including the `getEntitiesByType` method, will be retired in Q2 of 2024. The work to retire this method will
11641
+ * 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.
11646
11642
  * Regular expression rules will continue to be supported after entity-based contextual add-ins are retired. We recommend updating your contextual add-in
11647
11643
  * to use regular expression rules as an alternative solution. For guidance on how to implement these rules, see
11648
11644
  * {@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}.
11649
- *
11650
- * For more information, see
11645
+ * To learn more about the retirement of entity-based contextual Outlook add-ins, see
11651
11646
  * {@link https://devblogs.microsoft.com/microsoft365dev/retirement-of-entity-based-contextual-outlook-add-ins | Retirement of entity-based contextual Outlook add-ins}.
11652
11647
  *
11653
11648
  * - This method isn't supported in Outlook on Android or on iOS. For more information on supported APIs in Outlook mobile, see
@@ -11719,18 +11714,12 @@ declare namespace Office {
11719
11714
  *
11720
11715
  * **Important**:
11721
11716
  *
11722
- * - 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
11723
- * entities in mail items to perform tasks on them.
11724
- *
11725
- * An alternative implementation of the **Join Meeting** button, which is activated by online meeting add-ins, is being developed.
11726
- * Once support for entity-based contextual add-ins ends, online meeting add-ins will automatically transition to the alternative implementation
11727
- * to activate the **Join Meeting** button.
11728
- *
11717
+ * - Entity-based contextual Outlook add-ins, including the `getFilteredEntitiesByName` method, will be retired in Q2 of 2024. The work to retire this method will
11718
+ * 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.
11729
11719
  * Regular expression rules will continue to be supported after entity-based contextual add-ins are retired. We recommend updating your contextual add-in
11730
11720
  * to use regular expression rules as an alternative solution. For guidance on how to implement these rules, see
11731
11721
  * {@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}.
11732
- *
11733
- * For more information, see
11722
+ * To learn more about the retirement of entity-based contextual Outlook add-ins, see
11734
11723
  * {@link https://devblogs.microsoft.com/microsoft365dev/retirement-of-entity-based-contextual-outlook-add-ins | Retirement of entity-based contextual Outlook add-ins}.
11735
11724
  *
11736
11725
  * - 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},
@@ -11795,17 +11784,10 @@ declare namespace Office {
11795
11784
  * **Important**:
11796
11785
  *
11797
11786
  * - 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
11798
- * entities in mail items to perform tasks on them.
11799
- *
11800
- * An alternative implementation of the **Join Meeting** button, which is activated by online meeting add-ins, is being developed.
11801
- * Once support for entity-based contextual add-ins ends, online meeting add-ins will automatically transition to the alternative implementation
11802
- * to activate the **Join Meeting** button.
11803
- *
11804
- * Regular expression rules will continue to be supported after entity-based contextual add-ins are retired. We recommend updating your contextual add-in
11805
- * to use regular expression rules as an alternative solution. For guidance on how to implement these rules, see
11787
+ * 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.
11788
+ * 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
11806
11789
  * {@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}.
11807
- *
11808
- * For more information, see
11790
+ * To learn more about the retirement of entity-based contextual add-ins, see
11809
11791
  * {@link https://devblogs.microsoft.com/microsoft365dev/retirement-of-entity-based-contextual-outlook-add-ins | Retirement of entity-based contextual Outlook add-ins}.
11810
11792
  *
11811
11793
  * - 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},
@@ -11836,17 +11818,10 @@ declare namespace Office {
11836
11818
  * **Important**:
11837
11819
  *
11838
11820
  * - 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
11839
- * entities in mail items to perform tasks on them.
11840
- *
11841
- * An alternative implementation of the **Join Meeting** button, which is activated by online meeting add-ins, is being developed.
11842
- * Once support for entity-based contextual add-ins ends, online meeting add-ins will automatically transition to the alternative implementation
11843
- * to activate the **Join Meeting** button.
11844
- *
11845
- * Regular expression rules will continue to be supported after entity-based contextual add-ins are retired. We recommend updating your contextual add-in
11846
- * to use regular expression rules as an alternative solution. For guidance on how to implement these rules, see
11821
+ * 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.
11822
+ * 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
11847
11823
  * {@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}.
11848
- *
11849
- * For more information, see
11824
+ * To learn more about the retirement of entity-based contextual add-ins, see
11850
11825
  * {@link https://devblogs.microsoft.com/microsoft365dev/retirement-of-entity-based-contextual-outlook-add-ins | Retirement of entity-based contextual Outlook add-ins}.
11851
11826
  *
11852
11827
  * - 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},
@@ -11874,24 +11849,19 @@ declare namespace Office {
11874
11849
  *
11875
11850
  * **Important**:
11876
11851
  *
11877
- * - 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
11878
- * entities in mail items to perform tasks on them.
11879
- *
11880
- * An alternative implementation of the **Join Meeting** button, which is activated by online meeting add-ins, is being developed.
11881
- * Once support for entity-based contextual add-ins ends, online meeting add-ins will automatically transition to the alternative implementation
11882
- * to activate the **Join Meeting** button.
11883
- *
11852
+ * - Entity-based contextual Outlook add-ins, including the `getSelectedEntities` method, will be retired in Q2 of 2024. The work to retire this method will
11853
+ * 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.
11884
11854
  * Regular expression rules will continue to be supported after entity-based contextual add-ins are retired. We recommend updating your contextual add-in
11885
11855
  * to use regular expression rules as an alternative solution. For guidance on how to implement these rules, see
11886
11856
  * {@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}.
11887
- *
11888
- * For more information, see
11857
+ * To learn more about the retirement of entity-based contextual Outlook add-ins, see
11889
11858
  * {@link https://devblogs.microsoft.com/microsoft365dev/retirement-of-entity-based-contextual-outlook-add-ins | Retirement of entity-based contextual Outlook add-ins}.
11890
11859
  *
11891
11860
  * - 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},
11892
11861
  * 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)}.
11893
11862
  *
11894
- * - This method isn't supported in Outlook on iOS or Android.
11863
+ * - This method isn't supported in Outlook on iOS or Android. For more information on supported APIs in Outlook mobile, see
11864
+ * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
11895
11865
  *
11896
11866
  * @param name - The name of the `ItemHasRegularExpressionMatch` rule element that defines the filter to match.
11897
11867
  */
@@ -11916,23 +11886,17 @@ declare namespace Office {
11916
11886
  * **Important**:
11917
11887
  *
11918
11888
  * - 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
11919
- * entities in mail items to perform tasks on them.
11920
- *
11921
- * An alternative implementation of the **Join Meeting** button, which is activated by online meeting add-ins, is being developed.
11922
- * Once support for entity-based contextual add-ins ends, online meeting add-ins will automatically transition to the alternative implementation
11923
- * to activate the **Join Meeting** button.
11924
- *
11925
- * Regular expression rules will continue to be supported after entity-based contextual add-ins are retired. We recommend updating your contextual add-in
11926
- * to use regular expression rules as an alternative solution. For guidance on how to implement these rules, see
11889
+ * 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.
11890
+ * 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
11927
11891
  * {@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}.
11928
- *
11929
- * For more information, see
11892
+ * To learn more about the retirement of entity-based contextual add-ins, see
11930
11893
  * {@link https://devblogs.microsoft.com/microsoft365dev/retirement-of-entity-based-contextual-outlook-add-ins | Retirement of entity-based contextual Outlook add-ins}.
11931
11894
  *
11932
11895
  * - 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},
11933
11896
  * 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)}.
11934
11897
  *
11935
- * - This method isn't supported in Outlook on iOS or Android.
11898
+ * - This method isn't supported in Outlook on iOS or Android. For more information on supported APIs in Outlook mobile, see
11899
+ * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
11936
11900
  *
11937
11901
  * - If you specify an `ItemHasRegularExpressionMatch` rule on the body property of an item, the regular expression should further filter the body
11938
11902
  * 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
@@ -12969,9 +12933,16 @@ declare namespace Office {
12969
12933
  *
12970
12934
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Read
12971
12935
  *
12972
- * **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
12973
- * entities in mail items to perform tasks on them. To help minimize potential disruptions, the following will still be supported after entity-based
12974
- * contextual add-ins are retired.
12936
+ * **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
12937
+ * 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.
12938
+ * The following APIs will also be retired.
12939
+ *
12940
+ * - `Office.context.mailbox.item.getEntities`
12941
+ * - `Office.context.mailbox.item.getEntitiesByType`
12942
+ * - `Office.context.mailbox.item.getFilteredEntitiesByName`
12943
+ * - `Office.context.mailbox.item.getSelectedEntities`
12944
+ *
12945
+ * To help minimize potential disruptions, the following will still be supported after entity-based contextual add-ins are retired.
12975
12946
  *
12976
12947
  * - An alternative implementation of the **Join Meeting** button, which is activated by online meeting add-ins, is being developed. Once support for
12977
12948
  * entity-based contextual add-ins ends, online meeting add-ins will automatically transition to the alternative implementation to activate the
@@ -13562,9 +13533,16 @@ declare namespace Office {
13562
13533
  *
13563
13534
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Read
13564
13535
  *
13565
- * **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
13566
- * entities in mail items to perform tasks on them. To help minimize potential disruptions, the following will still be supported after entity-based
13567
- * contextual add-ins are retired.
13536
+ * **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
13537
+ * 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.
13538
+ * The following APIs will also be retired.
13539
+ *
13540
+ * - `Office.context.mailbox.item.getEntities`
13541
+ * - `Office.context.mailbox.item.getEntitiesByType`
13542
+ * - `Office.context.mailbox.item.getFilteredEntitiesByName`
13543
+ * - `Office.context.mailbox.item.getSelectedEntities`
13544
+ *
13545
+ * To help minimize potential disruptions, the following will still be supported after entity-based contextual add-ins are retired.
13568
13546
  *
13569
13547
  * - An alternative implementation of the **Join Meeting** button, which is activated by online meeting add-ins, is being developed. Once support for
13570
13548
  * entity-based contextual add-ins ends, online meeting add-ins will automatically transition to the alternative implementation to activate the
@@ -15258,9 +15236,16 @@ declare namespace Office {
15258
15236
  *
15259
15237
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Read
15260
15238
  *
15261
- * **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
15262
- * entities in mail items to perform tasks on them. To help minimize potential disruptions, the following will still be supported after entity-based
15263
- * contextual add-ins are retired.
15239
+ * **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
15240
+ * 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.
15241
+ * The following APIs will also be retired.
15242
+ *
15243
+ * - `Office.context.mailbox.item.getEntities`
15244
+ * - `Office.context.mailbox.item.getEntitiesByType`
15245
+ * - `Office.context.mailbox.item.getFilteredEntitiesByName`
15246
+ * - `Office.context.mailbox.item.getSelectedEntities`
15247
+ *
15248
+ * To help minimize potential disruptions, the following will still be supported after entity-based contextual add-ins are retired.
15264
15249
  *
15265
15250
  * - An alternative implementation of the **Join Meeting** button, which is activated by online meeting add-ins, is being developed. Once support for
15266
15251
  * entity-based contextual add-ins ends, online meeting add-ins will automatically transition to the alternative implementation to activate the
@@ -17230,18 +17215,12 @@ declare namespace Office {
17230
17215
  *
17231
17216
  * **Important**:
17232
17217
  *
17233
- * - 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
17234
- * entities in mail items to perform tasks on them.
17235
- *
17236
- * An alternative implementation of the **Join Meeting** button, which is activated by online meeting add-ins, is being developed.
17237
- * Once support for entity-based contextual add-ins ends, online meeting add-ins will automatically transition to the alternative implementation
17238
- * to activate the **Join Meeting** button.
17239
- *
17218
+ * - Entity-based contextual Outlook add-ins, including the `getEntities` method, will be retired in Q2 of 2024. The work to retire this method will
17219
+ * 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.
17240
17220
  * Regular expression rules will continue to be supported after entity-based contextual add-ins are retired. We recommend updating your contextual add-in
17241
17221
  * to use regular expression rules as an alternative solution. For guidance on how to implement these rules, see
17242
17222
  * {@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}.
17243
- *
17244
- * For more information, see
17223
+ * To learn more about the retirement of entity-based contextual Outlook add-ins, see
17245
17224
  * {@link https://devblogs.microsoft.com/microsoft365dev/retirement-of-entity-based-contextual-outlook-add-ins | Retirement of entity-based contextual Outlook add-ins}.
17246
17225
  *
17247
17226
  * - This method isn't supported in Outlook on Android or on iOS. For more information on supported APIs in Outlook mobile, see
@@ -17265,18 +17244,12 @@ declare namespace Office {
17265
17244
  *
17266
17245
  * **Important**:
17267
17246
  *
17268
- * - 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
17269
- * entities in mail items to perform tasks on them.
17270
- *
17271
- * An alternative implementation of the **Join Meeting** button, which is activated by online meeting add-ins, is being developed.
17272
- * Once support for entity-based contextual add-ins ends, online meeting add-ins will automatically transition to the alternative implementation
17273
- * to activate the **Join Meeting** button.
17274
- *
17247
+ * - Entity-based contextual Outlook add-ins, including the `getEntitiesByType` method, will be retired in Q2 of 2024. The work to retire this method will
17248
+ * 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.
17275
17249
  * Regular expression rules will continue to be supported after entity-based contextual add-ins are retired. We recommend updating your contextual add-in
17276
17250
  * to use regular expression rules as an alternative solution. For guidance on how to implement these rules, see
17277
17251
  * {@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}.
17278
- *
17279
- * For more information, see
17252
+ * To learn more about the retirement of entity-based contextual Outlook add-ins, see
17280
17253
  * {@link https://devblogs.microsoft.com/microsoft365dev/retirement-of-entity-based-contextual-outlook-add-ins | Retirement of entity-based contextual Outlook add-ins}.
17281
17254
  *
17282
17255
  * - This method isn't supported in Outlook on Android or on iOS. For more information on supported APIs in Outlook mobile, see
@@ -17349,18 +17322,12 @@ declare namespace Office {
17349
17322
  *
17350
17323
  * **Important**:
17351
17324
  *
17352
- * - 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
17353
- * entities in mail items to perform tasks on them.
17354
- *
17355
- * An alternative implementation of the **Join Meeting** button, which is activated by online meeting add-ins, is being developed.
17356
- * Once support for entity-based contextual add-ins ends, online meeting add-ins will automatically transition to the alternative implementation
17357
- * to activate the **Join Meeting** button.
17358
- *
17325
+ * - Entity-based contextual Outlook add-ins, including the `getFilteredEntitiesByName` method, will be retired in Q2 of 2024. The work to retire this method will
17326
+ * 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.
17359
17327
  * Regular expression rules will continue to be supported after entity-based contextual add-ins are retired. We recommend updating your contextual add-in
17360
17328
  * to use regular expression rules as an alternative solution. For guidance on how to implement these rules, see
17361
17329
  * {@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}.
17362
- *
17363
- * For more information, see
17330
+ * To learn more about the retirement of entity-based contextual Outlook add-ins, see
17364
17331
  * {@link https://devblogs.microsoft.com/microsoft365dev/retirement-of-entity-based-contextual-outlook-add-ins | Retirement of entity-based contextual Outlook add-ins}.
17365
17332
  *
17366
17333
  * - 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},
@@ -17425,17 +17392,10 @@ declare namespace Office {
17425
17392
  * **Important**:
17426
17393
  *
17427
17394
  * - 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
17428
- * entities in mail items to perform tasks on them.
17429
- *
17430
- * An alternative implementation of the **Join Meeting** button, which is activated by online meeting add-ins, is being developed.
17431
- * Once support for entity-based contextual add-ins ends, online meeting add-ins will automatically transition to the alternative implementation
17432
- * to activate the **Join Meeting** button.
17433
- *
17434
- * Regular expression rules will continue to be supported after entity-based contextual add-ins are retired. We recommend updating your contextual add-in
17435
- * to use regular expression rules as an alternative solution. For guidance on how to implement these rules, see
17395
+ * 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.
17396
+ * 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
17436
17397
  * {@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}.
17437
- *
17438
- * For more information, see
17398
+ * To learn more about the retirement of entity-based contextual add-ins, see
17439
17399
  * {@link https://devblogs.microsoft.com/microsoft365dev/retirement-of-entity-based-contextual-outlook-add-ins | Retirement of entity-based contextual Outlook add-ins}.
17440
17400
  *
17441
17401
  * - 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},
@@ -17466,17 +17426,10 @@ declare namespace Office {
17466
17426
  * **Important**:
17467
17427
  *
17468
17428
  * - 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
17469
- * entities in mail items to perform tasks on them.
17470
- *
17471
- * An alternative implementation of the **Join Meeting** button, which is activated by online meeting add-ins, is being developed.
17472
- * Once support for entity-based contextual add-ins ends, online meeting add-ins will automatically transition to the alternative implementation
17473
- * to activate the **Join Meeting** button.
17474
- *
17475
- * Regular expression rules will continue to be supported after entity-based contextual add-ins are retired. We recommend updating your contextual add-in
17476
- * to use regular expression rules as an alternative solution. For guidance on how to implement these rules, see
17429
+ * 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.
17430
+ * 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
17477
17431
  * {@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}.
17478
- *
17479
- * For more information, see
17432
+ * To learn more about the retirement of entity-based contextual add-ins, see
17480
17433
  * {@link https://devblogs.microsoft.com/microsoft365dev/retirement-of-entity-based-contextual-outlook-add-ins | Retirement of entity-based contextual Outlook add-ins}.
17481
17434
  *
17482
17435
  * - 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},
@@ -17506,21 +17459,22 @@ declare namespace Office {
17506
17459
  *
17507
17460
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read
17508
17461
  *
17509
- * **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
17510
- * entities in mail items to perform tasks on them. To help minimize potential disruptions, the following will still be supported after entity-based
17511
- * contextual add-ins are retired.
17512
- *
17513
- * - An alternative implementation of the **Join Meeting** button, which is activated by online meeting add-ins, is being developed. Once support for
17514
- * entity-based contextual add-ins ends, online meeting add-ins will automatically transition to the alternative implementation to activate the
17515
- * **Join Meeting** button.
17462
+ * **Important**:
17516
17463
  *
17517
- * - Regular expression rules will continue to be supported after entity-based contextual add-ins are retired. We recommend updating your contextual add-in
17464
+ * - Entity-based contextual Outlook add-ins, including the `getSelectedEntities` method, will be retired in Q2 of 2024. The work to retire this method will
17465
+ * 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.
17466
+ * Regular expression rules will continue to be supported after entity-based contextual add-ins are retired. We recommend updating your contextual add-in
17518
17467
  * to use regular expression rules as an alternative solution. For guidance on how to implement these rules, see
17519
17468
  * {@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}.
17520
- *
17521
- * For more information, see
17469
+ * To learn more about the retirement of entity-based contextual Outlook add-ins, see
17522
17470
  * {@link https://devblogs.microsoft.com/microsoft365dev/retirement-of-entity-based-contextual-outlook-add-ins | Retirement of entity-based contextual Outlook add-ins}.
17523
17471
  *
17472
+ * - 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},
17473
+ * 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)}.
17474
+ *
17475
+ * - This method isn't supported in Outlook on iOS or Android. For more information on supported APIs in Outlook mobile, see
17476
+ * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
17477
+ *
17524
17478
  * @param name - The name of the `ItemHasRegularExpressionMatch` rule element that defines the filter to match.
17525
17479
  */
17526
17480
  getSelectedEntities(): Entities;
@@ -17544,23 +17498,17 @@ declare namespace Office {
17544
17498
  * **Important**:
17545
17499
  *
17546
17500
  * - 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
17547
- * entities in mail items to perform tasks on them.
17548
- *
17549
- * An alternative implementation of the **Join Meeting** button, which is activated by online meeting add-ins, is being developed.
17550
- * Once support for entity-based contextual add-ins ends, online meeting add-ins will automatically transition to the alternative implementation
17551
- * to activate the **Join Meeting** button.
17552
- *
17553
- * Regular expression rules will continue to be supported after entity-based contextual add-ins are retired. We recommend updating your contextual add-in
17554
- * to use regular expression rules as an alternative solution. For guidance on how to implement these rules, see
17501
+ * 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.
17502
+ * 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
17555
17503
  * {@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}.
17556
- *
17557
- * For more information, see
17504
+ * To learn more about the retirement of entity-based contextual add-ins, see
17558
17505
  * {@link https://devblogs.microsoft.com/microsoft365dev/retirement-of-entity-based-contextual-outlook-add-ins | Retirement of entity-based contextual Outlook add-ins}.
17559
17506
  *
17560
17507
  * - 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},
17561
17508
  * 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)}.
17562
17509
  *
17563
- * - This method isn't supported in Outlook on iOS or Android.
17510
+ * - This method isn't supported in Outlook on iOS or Android. For more information on supported APIs in Outlook mobile, see
17511
+ * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
17564
17512
  *
17565
17513
  * - If you specify an `ItemHasRegularExpressionMatch` rule on the body property of an item, the regular expression should further filter the body
17566
17514
  * 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
@@ -18014,9 +17962,16 @@ declare namespace Office {
18014
17962
  *
18015
17963
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Read
18016
17964
  *
18017
- * **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
18018
- * entities in mail items to perform tasks on them. To help minimize potential disruptions, the following will still be supported after entity-based
18019
- * contextual add-ins are retired.
17965
+ * **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
17966
+ * 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.
17967
+ * The following APIs will also be retired.
17968
+ *
17969
+ * - `Office.context.mailbox.item.getEntities`
17970
+ * - `Office.context.mailbox.item.getEntitiesByType`
17971
+ * - `Office.context.mailbox.item.getFilteredEntitiesByName`
17972
+ * - `Office.context.mailbox.item.getSelectedEntities`
17973
+ *
17974
+ * To help minimize potential disruptions, the following will still be supported after entity-based contextual add-ins are retired.
18020
17975
  *
18021
17976
  * - An alternative implementation of the **Join Meeting** button, which is activated by online meeting add-ins, is being developed. Once support for
18022
17977
  * entity-based contextual add-ins ends, online meeting add-ins will automatically transition to the alternative implementation to activate the
office-js/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@types/office-js",
3
- "version": "1.0.374",
3
+ "version": "1.0.375",
4
4
  "description": "TypeScript definitions for office-js",
5
5
  "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-js",
6
6
  "license": "MIT",
@@ -45,6 +45,6 @@
45
45
  },
46
46
  "scripts": {},
47
47
  "dependencies": {},
48
- "typesPublisherContentHash": "c655b0e6bb4de4d245cddb4ffbd97aae000c8ab7d8856a31e030a6f5f47e1a19",
48
+ "typesPublisherContentHash": "d4aa84c21e8298f1ad9ddc7f9a9f0443dc44458fbd2343d0dd262651e8227cbf",
49
49
  "typeScriptVersion": "4.6"
50
50
  }