@types/office-js 1.0.364 → 1.0.365

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.
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, 09 Jan 2024 20:35:37 GMT
11
+ * Last updated: Thu, 18 Jan 2024 19:35:50 GMT
12
12
  * Dependencies: none
13
13
 
14
14
  # Credits
office-js/index.d.ts CHANGED
@@ -8731,6 +8731,21 @@ declare namespace Office {
8731
8731
  * @remarks
8732
8732
  *
8733
8733
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read
8734
+ *
8735
+ * **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
8736
+ * entities in mail items to perform tasks on them. To help minimize potential disruptions, the following will still be supported after entity-based
8737
+ * contextual add-ins are retired.
8738
+ *
8739
+ * - An alternative implementation of the **Join Meeting** button, which is activated by online meeting add-ins, is being developed. Once support for
8740
+ * entity-based contextual add-ins ends, online meeting add-ins will automatically transition to the alternative implementation to activate the
8741
+ * **Join Meeting** button.
8742
+ *
8743
+ * - Regular expression rules will continue to be supported after entity-based contextual add-ins are retired. We recommend updating your contextual add-in
8744
+ * to use regular expression rules as an alternative solution. For guidance on how to implement these rules, see
8745
+ * {@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}.
8746
+ *
8747
+ * For more information, see
8748
+ * {@link https://devblogs.microsoft.com/microsoft365dev/retirement-of-entity-based-contextual-outlook-add-ins | Retirement of entity-based contextual Outlook add-ins}.
8734
8749
  */
8735
8750
  enum EntityType {
8736
8751
  /**
@@ -11597,7 +11612,23 @@ declare namespace Office {
11597
11612
  *
11598
11613
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee
11599
11614
  *
11600
- * **Important**: This method isn't supported in Outlook on Android or on iOS. For more information on supported APIs in Outlook mobile, see
11615
+ * **Important**:
11616
+ *
11617
+ * - 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
11618
+ * entities in mail items to perform tasks on them.
11619
+ *
11620
+ * An alternative implementation of the **Join Meeting** button, which is activated by online meeting add-ins, is being developed.
11621
+ * Once support for entity-based contextual add-ins ends, online meeting add-ins will automatically transition to the alternative implementation
11622
+ * to activate the **Join Meeting** button.
11623
+ *
11624
+ * Regular expression rules will continue to be supported after entity-based contextual add-ins are retired. We recommend updating your contextual add-in
11625
+ * to use regular expression rules as an alternative solution. For guidance on how to implement these rules, see
11626
+ * {@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}.
11627
+ *
11628
+ * For more information, see
11629
+ * {@link https://devblogs.microsoft.com/microsoft365dev/retirement-of-entity-based-contextual-outlook-add-ins | Retirement of entity-based contextual Outlook add-ins}.
11630
+ *
11631
+ * - This method isn't supported in Outlook on Android or on iOS. For more information on supported APIs in Outlook mobile, see
11601
11632
  * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
11602
11633
  */
11603
11634
  getEntities(): Entities;
@@ -11616,7 +11647,23 @@ declare namespace Office {
11616
11647
  *
11617
11648
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee
11618
11649
  *
11619
- * **Important**: This method isn't supported in Outlook on Android or on iOS. For more information on supported APIs in Outlook mobile, see
11650
+ * **Important**:
11651
+ *
11652
+ * - 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
11653
+ * entities in mail items to perform tasks on them.
11654
+ *
11655
+ * An alternative implementation of the **Join Meeting** button, which is activated by online meeting add-ins, is being developed.
11656
+ * Once support for entity-based contextual add-ins ends, online meeting add-ins will automatically transition to the alternative implementation
11657
+ * to activate the **Join Meeting** button.
11658
+ *
11659
+ * Regular expression rules will continue to be supported after entity-based contextual add-ins are retired. We recommend updating your contextual add-in
11660
+ * to use regular expression rules as an alternative solution. For guidance on how to implement these rules, see
11661
+ * {@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}.
11662
+ *
11663
+ * For more information, see
11664
+ * {@link https://devblogs.microsoft.com/microsoft365dev/retirement-of-entity-based-contextual-outlook-add-ins | Retirement of entity-based contextual Outlook add-ins}.
11665
+ *
11666
+ * - This method isn't supported in Outlook on Android or on iOS. For more information on supported APIs in Outlook mobile, see
11620
11667
  * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
11621
11668
  *
11622
11669
  * @param entityType - One of the `EntityType` enumeration values.
@@ -11685,8 +11732,22 @@ declare namespace Office {
11685
11732
  *
11686
11733
  * **Important**:
11687
11734
  *
11735
+ * - 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
11736
+ * entities in mail items to perform tasks on them.
11737
+ *
11738
+ * An alternative implementation of the **Join Meeting** button, which is activated by online meeting add-ins, is being developed.
11739
+ * Once support for entity-based contextual add-ins ends, online meeting add-ins will automatically transition to the alternative implementation
11740
+ * to activate the **Join Meeting** button.
11741
+ *
11742
+ * Regular expression rules will continue to be supported after entity-based contextual add-ins are retired. We recommend updating your contextual add-in
11743
+ * to use regular expression rules as an alternative solution. For guidance on how to implement these rules, see
11744
+ * {@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}.
11745
+ *
11746
+ * For more information, see
11747
+ * {@link https://devblogs.microsoft.com/microsoft365dev/retirement-of-entity-based-contextual-outlook-add-ins | Retirement of entity-based contextual Outlook add-ins}.
11748
+ *
11688
11749
  * - 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},
11689
- * 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)}.
11750
+ * 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)}.
11690
11751
  *
11691
11752
  * - This method isn't supported in Outlook on Android or on iOS. For more information on supported APIs in Outlook mobile, see
11692
11753
  * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
@@ -11746,8 +11807,22 @@ declare namespace Office {
11746
11807
  *
11747
11808
  * **Important**:
11748
11809
  *
11810
+ * - 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
11811
+ * entities in mail items to perform tasks on them.
11812
+ *
11813
+ * An alternative implementation of the **Join Meeting** button, which is activated by online meeting add-ins, is being developed.
11814
+ * Once support for entity-based contextual add-ins ends, online meeting add-ins will automatically transition to the alternative implementation
11815
+ * to activate the **Join Meeting** button.
11816
+ *
11817
+ * Regular expression rules will continue to be supported after entity-based contextual add-ins are retired. We recommend updating your contextual add-in
11818
+ * to use regular expression rules as an alternative solution. For guidance on how to implement these rules, see
11819
+ * {@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}.
11820
+ *
11821
+ * For more information, see
11822
+ * {@link https://devblogs.microsoft.com/microsoft365dev/retirement-of-entity-based-contextual-outlook-add-ins | Retirement of entity-based contextual Outlook add-ins}.
11823
+ *
11749
11824
  * - 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},
11750
- * 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)}.
11825
+ * 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)}.
11751
11826
  *
11752
11827
  * - If you specify an `ItemHasRegularExpressionMatch` rule on the body property of an item, the regular expression should further filter the body
11753
11828
  * 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 expected results.
@@ -11773,8 +11848,22 @@ declare namespace Office {
11773
11848
  *
11774
11849
  * **Important**:
11775
11850
  *
11851
+ * - 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
11852
+ * entities in mail items to perform tasks on them.
11853
+ *
11854
+ * An alternative implementation of the **Join Meeting** button, which is activated by online meeting add-ins, is being developed.
11855
+ * Once support for entity-based contextual add-ins ends, online meeting add-ins will automatically transition to the alternative implementation
11856
+ * to activate the **Join Meeting** button.
11857
+ *
11858
+ * Regular expression rules will continue to be supported after entity-based contextual add-ins are retired. We recommend updating your contextual add-in
11859
+ * to use regular expression rules as an alternative solution. For guidance on how to implement these rules, see
11860
+ * {@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}.
11861
+ *
11862
+ * For more information, see
11863
+ * {@link https://devblogs.microsoft.com/microsoft365dev/retirement-of-entity-based-contextual-outlook-add-ins | Retirement of entity-based contextual Outlook add-ins}.
11864
+ *
11776
11865
  * - 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},
11777
- * 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)}.
11866
+ * 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)}.
11778
11867
  *
11779
11868
  * - If you specify an `ItemHasRegularExpressionMatch` rule on the body property of an item, the regular expression should further filter the body
11780
11869
  * 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 expected results.
@@ -11788,10 +11877,6 @@ declare namespace Office {
11788
11877
  getRegExMatchesByName(name: string): string[];
11789
11878
  /**
11790
11879
  * Gets the entities found in a highlighted match a user has selected. Highlighted matches apply to contextual add-ins.
11791
- *
11792
- * **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)}.
11793
- *
11794
- * **Note**: This method is not supported in Outlook on iOS or Android.
11795
11880
  *
11796
11881
  * @remarks
11797
11882
  * [Api set: Mailbox 1.6]
@@ -11800,31 +11885,39 @@ declare namespace Office {
11800
11885
  *
11801
11886
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee
11802
11887
  *
11888
+ * **Important**:
11889
+ *
11890
+ * - 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
11891
+ * entities in mail items to perform tasks on them.
11892
+ *
11893
+ * An alternative implementation of the **Join Meeting** button, which is activated by online meeting add-ins, is being developed.
11894
+ * Once support for entity-based contextual add-ins ends, online meeting add-ins will automatically transition to the alternative implementation
11895
+ * to activate the **Join Meeting** button.
11896
+ *
11897
+ * Regular expression rules will continue to be supported after entity-based contextual add-ins are retired. We recommend updating your contextual add-in
11898
+ * to use regular expression rules as an alternative solution. For guidance on how to implement these rules, see
11899
+ * {@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}.
11900
+ *
11901
+ * For more information, see
11902
+ * {@link https://devblogs.microsoft.com/microsoft365dev/retirement-of-entity-based-contextual-outlook-add-ins | Retirement of entity-based contextual Outlook add-ins}.
11903
+ *
11904
+ * - 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},
11905
+ * 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)}.
11906
+ *
11907
+ * - This method isn't supported in Outlook on iOS or Android.
11908
+ *
11803
11909
  * @param name - The name of the `ItemHasRegularExpressionMatch` rule element that defines the filter to match.
11804
11910
  */
11805
11911
  getSelectedEntities(): Entities;
11806
11912
  /**
11807
11913
  * Returns string values in a highlighted match that match the regular expressions defined in an XML manifest file.
11808
11914
  * Highlighted matches apply to contextual add-ins.
11809
- *
11810
- * **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)}.
11811
- *
11812
- * The `getSelectedRegExMatches` method returns the strings that match the regular expression defined in each `ItemHasRegularExpressionMatch` or
11813
- * `ItemHasKnownEntity` rule element in the manifest XML file.
11814
- * For an `ItemHasRegularExpressionMatch` rule, a matching string has to occur in the property of the item that is specified by that rule.
11815
- * The `PropertyName` simple type defines the supported properties.
11816
- *
11817
- * If you specify an `ItemHasRegularExpressionMatch` rule on the body property of an item, the regular expression should further filter the body
11818
- * and should not attempt to return the entire body of the item.
11819
- * Using a regular expression such as .* to obtain the entire body of an item does not always return the expected results.
11820
- * Instead, use the `Body.getAsync` method to retrieve the entire body.
11821
- *
11822
- * **Note**: This method is not supported in Outlook on iOS or Android.
11823
11915
  *
11824
11916
  * @returns
11825
11917
  * An object that contains arrays of strings that match the regular expressions defined in the manifest XML file.
11826
- * The name of each array is equal to the corresponding value of the `RegExName` attribute of the matching `ItemHasRegularExpressionMatch` rule
11827
- * or the `FilterName` attribute of the matching `ItemHasKnownEntity` rule.
11918
+ * The name of each array is equal to the corresponding value of the `RegExName` attribute of the matching `ItemHasRegularExpressionMatch` rule or
11919
+ * the `FilterName` attribute of the matching `ItemHasKnownEntity` rule. For an `ItemHasRegularExpressionMatch` rule, a matching string has to occur
11920
+ * in the property of the item that is specified by that rule. The `PropertyName` simple type defines the supported properties.
11828
11921
  *
11829
11922
  * @remarks
11830
11923
  * [Api set: Mailbox 1.6]
@@ -11832,6 +11925,31 @@ declare namespace Office {
11832
11925
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
11833
11926
  *
11834
11927
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee
11928
+ *
11929
+ * **Important**:
11930
+ *
11931
+ * - 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
11932
+ * entities in mail items to perform tasks on them.
11933
+ *
11934
+ * An alternative implementation of the **Join Meeting** button, which is activated by online meeting add-ins, is being developed.
11935
+ * Once support for entity-based contextual add-ins ends, online meeting add-ins will automatically transition to the alternative implementation
11936
+ * to activate the **Join Meeting** button.
11937
+ *
11938
+ * Regular expression rules will continue to be supported after entity-based contextual add-ins are retired. We recommend updating your contextual add-in
11939
+ * to use regular expression rules as an alternative solution. For guidance on how to implement these rules, see
11940
+ * {@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}.
11941
+ *
11942
+ * For more information, see
11943
+ * {@link https://devblogs.microsoft.com/microsoft365dev/retirement-of-entity-based-contextual-outlook-add-ins | Retirement of entity-based contextual Outlook add-ins}.
11944
+ *
11945
+ * - 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},
11946
+ * 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)}.
11947
+ *
11948
+ * - This method isn't supported in Outlook on iOS or Android.
11949
+ *
11950
+ * - If you specify an `ItemHasRegularExpressionMatch` rule on the body property of an item, the regular expression should further filter the body
11951
+ * 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
11952
+ * expected results. Instead, use the `Body.getAsync` method to retrieve the entire body.
11835
11953
  */
11836
11954
  getSelectedRegExMatches(): any;
11837
11955
  /**
@@ -12861,6 +12979,21 @@ declare namespace Office {
12861
12979
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **restricted**
12862
12980
  *
12863
12981
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Read
12982
+ *
12983
+ * **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
12984
+ * entities in mail items to perform tasks on them. To help minimize potential disruptions, the following will still be supported after entity-based
12985
+ * contextual add-ins are retired.
12986
+ *
12987
+ * - An alternative implementation of the **Join Meeting** button, which is activated by online meeting add-ins, is being developed. Once support for
12988
+ * entity-based contextual add-ins ends, online meeting add-ins will automatically transition to the alternative implementation to activate the
12989
+ * **Join Meeting** button.
12990
+ *
12991
+ * - Regular expression rules will continue to be supported after entity-based contextual add-ins are retired. We recommend updating your contextual add-in
12992
+ * to use regular expression rules as an alternative solution. For guidance on how to implement these rules, see
12993
+ * {@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}.
12994
+ *
12995
+ * For more information, see
12996
+ * {@link https://devblogs.microsoft.com/microsoft365dev/retirement-of-entity-based-contextual-outlook-add-ins | Retirement of entity-based contextual Outlook add-ins}.
12864
12997
  */
12865
12998
  interface Contact {
12866
12999
  /**
@@ -13439,6 +13572,21 @@ declare namespace Office {
13439
13572
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
13440
13573
  *
13441
13574
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Read
13575
+ *
13576
+ * **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
13577
+ * entities in mail items to perform tasks on them. To help minimize potential disruptions, the following will still be supported after entity-based
13578
+ * contextual add-ins are retired.
13579
+ *
13580
+ * - An alternative implementation of the **Join Meeting** button, which is activated by online meeting add-ins, is being developed. Once support for
13581
+ * entity-based contextual add-ins ends, online meeting add-ins will automatically transition to the alternative implementation to activate the
13582
+ * **Join Meeting** button.
13583
+ *
13584
+ * - Regular expression rules will continue to be supported after entity-based contextual add-ins are retired. We recommend updating your contextual add-in
13585
+ * to use regular expression rules as an alternative solution. For guidance on how to implement these rules, see
13586
+ * {@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}.
13587
+ *
13588
+ * For more information, see
13589
+ * {@link https://devblogs.microsoft.com/microsoft365dev/retirement-of-entity-based-contextual-outlook-add-ins | Retirement of entity-based contextual Outlook add-ins}.
13442
13590
  */
13443
13591
  interface Entities {
13444
13592
  /**
@@ -15120,6 +15268,21 @@ declare namespace Office {
15120
15268
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
15121
15269
  *
15122
15270
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Read
15271
+ *
15272
+ * **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
15273
+ * entities in mail items to perform tasks on them. To help minimize potential disruptions, the following will still be supported after entity-based
15274
+ * contextual add-ins are retired.
15275
+ *
15276
+ * - An alternative implementation of the **Join Meeting** button, which is activated by online meeting add-ins, is being developed. Once support for
15277
+ * entity-based contextual add-ins ends, online meeting add-ins will automatically transition to the alternative implementation to activate the
15278
+ * **Join Meeting** button.
15279
+ *
15280
+ * - Regular expression rules will continue to be supported after entity-based contextual add-ins are retired. We recommend updating your contextual add-in
15281
+ * to use regular expression rules as an alternative solution. For guidance on how to implement these rules, see
15282
+ * {@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}.
15283
+ *
15284
+ * For more information, see
15285
+ * {@link https://devblogs.microsoft.com/microsoft365dev/retirement-of-entity-based-contextual-outlook-add-ins | Retirement of entity-based contextual Outlook add-ins}.
15123
15286
  */
15124
15287
  interface MeetingSuggestion {
15125
15288
  /**
@@ -17076,7 +17239,23 @@ declare namespace Office {
17076
17239
  *
17077
17240
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee
17078
17241
  *
17079
- * **Important**: This method isn't supported in Outlook on Android or on iOS. For more information on supported APIs in Outlook mobile, see
17242
+ * **Important**:
17243
+ *
17244
+ * - 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
17245
+ * entities in mail items to perform tasks on them.
17246
+ *
17247
+ * An alternative implementation of the **Join Meeting** button, which is activated by online meeting add-ins, is being developed.
17248
+ * Once support for entity-based contextual add-ins ends, online meeting add-ins will automatically transition to the alternative implementation
17249
+ * to activate the **Join Meeting** button.
17250
+ *
17251
+ * Regular expression rules will continue to be supported after entity-based contextual add-ins are retired. We recommend updating your contextual add-in
17252
+ * to use regular expression rules as an alternative solution. For guidance on how to implement these rules, see
17253
+ * {@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}.
17254
+ *
17255
+ * For more information, see
17256
+ * {@link https://devblogs.microsoft.com/microsoft365dev/retirement-of-entity-based-contextual-outlook-add-ins | Retirement of entity-based contextual Outlook add-ins}.
17257
+ *
17258
+ * - This method isn't supported in Outlook on Android or on iOS. For more information on supported APIs in Outlook mobile, see
17080
17259
  * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
17081
17260
  */
17082
17261
  getEntities(): Entities;
@@ -17095,7 +17274,23 @@ declare namespace Office {
17095
17274
  *
17096
17275
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read
17097
17276
  *
17098
- * **Important**: This method isn't supported in Outlook on Android or on iOS. For more information on supported APIs in Outlook mobile, see
17277
+ * **Important**:
17278
+ *
17279
+ * - 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
17280
+ * entities in mail items to perform tasks on them.
17281
+ *
17282
+ * An alternative implementation of the **Join Meeting** button, which is activated by online meeting add-ins, is being developed.
17283
+ * Once support for entity-based contextual add-ins ends, online meeting add-ins will automatically transition to the alternative implementation
17284
+ * to activate the **Join Meeting** button.
17285
+ *
17286
+ * Regular expression rules will continue to be supported after entity-based contextual add-ins are retired. We recommend updating your contextual add-in
17287
+ * to use regular expression rules as an alternative solution. For guidance on how to implement these rules, see
17288
+ * {@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}.
17289
+ *
17290
+ * For more information, see
17291
+ * {@link https://devblogs.microsoft.com/microsoft365dev/retirement-of-entity-based-contextual-outlook-add-ins | Retirement of entity-based contextual Outlook add-ins}.
17292
+ *
17293
+ * - This method isn't supported in Outlook on Android or on iOS. For more information on supported APIs in Outlook mobile, see
17099
17294
  * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
17100
17295
  *
17101
17296
  * @param entityType - One of the `EntityType` enumeration values.
@@ -17165,8 +17360,22 @@ declare namespace Office {
17165
17360
  *
17166
17361
  * **Important**:
17167
17362
  *
17363
+ * - 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
17364
+ * entities in mail items to perform tasks on them.
17365
+ *
17366
+ * An alternative implementation of the **Join Meeting** button, which is activated by online meeting add-ins, is being developed.
17367
+ * Once support for entity-based contextual add-ins ends, online meeting add-ins will automatically transition to the alternative implementation
17368
+ * to activate the **Join Meeting** button.
17369
+ *
17370
+ * Regular expression rules will continue to be supported after entity-based contextual add-ins are retired. We recommend updating your contextual add-in
17371
+ * to use regular expression rules as an alternative solution. For guidance on how to implement these rules, see
17372
+ * {@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}.
17373
+ *
17374
+ * For more information, see
17375
+ * {@link https://devblogs.microsoft.com/microsoft365dev/retirement-of-entity-based-contextual-outlook-add-ins | Retirement of entity-based contextual Outlook add-ins}.
17376
+ *
17168
17377
  * - 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},
17169
- * 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)}.
17378
+ * 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)}.
17170
17379
  *
17171
17380
  * - This method isn't supported in Outlook on Android or on iOS. For more information on supported APIs in Outlook mobile, see
17172
17381
  * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
@@ -17226,8 +17435,22 @@ declare namespace Office {
17226
17435
  *
17227
17436
  * **Important**:
17228
17437
  *
17438
+ * - 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
17439
+ * entities in mail items to perform tasks on them.
17440
+ *
17441
+ * An alternative implementation of the **Join Meeting** button, which is activated by online meeting add-ins, is being developed.
17442
+ * Once support for entity-based contextual add-ins ends, online meeting add-ins will automatically transition to the alternative implementation
17443
+ * to activate the **Join Meeting** button.
17444
+ *
17445
+ * Regular expression rules will continue to be supported after entity-based contextual add-ins are retired. We recommend updating your contextual add-in
17446
+ * to use regular expression rules as an alternative solution. For guidance on how to implement these rules, see
17447
+ * {@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}.
17448
+ *
17449
+ * For more information, see
17450
+ * {@link https://devblogs.microsoft.com/microsoft365dev/retirement-of-entity-based-contextual-outlook-add-ins | Retirement of entity-based contextual Outlook add-ins}.
17451
+ *
17229
17452
  * - 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},
17230
- * 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)}.
17453
+ * 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)}.
17231
17454
  *
17232
17455
  * - If you specify an `ItemHasRegularExpressionMatch` rule on the body property of an item, the regular expression should further filter the body
17233
17456
  * 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 expected results.
@@ -17253,8 +17476,22 @@ declare namespace Office {
17253
17476
  *
17254
17477
  * **Important**:
17255
17478
  *
17479
+ * - 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
17480
+ * entities in mail items to perform tasks on them.
17481
+ *
17482
+ * An alternative implementation of the **Join Meeting** button, which is activated by online meeting add-ins, is being developed.
17483
+ * Once support for entity-based contextual add-ins ends, online meeting add-ins will automatically transition to the alternative implementation
17484
+ * to activate the **Join Meeting** button.
17485
+ *
17486
+ * Regular expression rules will continue to be supported after entity-based contextual add-ins are retired. We recommend updating your contextual add-in
17487
+ * to use regular expression rules as an alternative solution. For guidance on how to implement these rules, see
17488
+ * {@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}.
17489
+ *
17490
+ * For more information, see
17491
+ * {@link https://devblogs.microsoft.com/microsoft365dev/retirement-of-entity-based-contextual-outlook-add-ins | Retirement of entity-based contextual Outlook add-ins}.
17492
+ *
17256
17493
  * - 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},
17257
- * 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)}.
17494
+ * 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)}.
17258
17495
  *
17259
17496
  * - If you specify an `ItemHasRegularExpressionMatch` rule on the body property of an item, the regular expression should further filter the body
17260
17497
  * 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 expected results.
@@ -17280,31 +17517,33 @@ declare namespace Office {
17280
17517
  *
17281
17518
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read
17282
17519
  *
17520
+ * **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
17521
+ * entities in mail items to perform tasks on them. To help minimize potential disruptions, the following will still be supported after entity-based
17522
+ * contextual add-ins are retired.
17523
+ *
17524
+ * - An alternative implementation of the **Join Meeting** button, which is activated by online meeting add-ins, is being developed. Once support for
17525
+ * entity-based contextual add-ins ends, online meeting add-ins will automatically transition to the alternative implementation to activate the
17526
+ * **Join Meeting** button.
17527
+ *
17528
+ * - Regular expression rules will continue to be supported after entity-based contextual add-ins are retired. We recommend updating your contextual add-in
17529
+ * to use regular expression rules as an alternative solution. For guidance on how to implement these rules, see
17530
+ * {@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}.
17531
+ *
17532
+ * For more information, see
17533
+ * {@link https://devblogs.microsoft.com/microsoft365dev/retirement-of-entity-based-contextual-outlook-add-ins | Retirement of entity-based contextual Outlook add-ins}.
17534
+ *
17283
17535
  * @param name - The name of the `ItemHasRegularExpressionMatch` rule element that defines the filter to match.
17284
17536
  */
17285
17537
  getSelectedEntities(): Entities;
17286
17538
  /**
17287
17539
  * Returns string values in a highlighted match that match the regular expressions defined in an XML manifest file.
17288
17540
  * Highlighted matches apply to contextual add-ins.
17289
- *
17290
- * **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)}.
17291
- *
17292
- * The `getSelectedRegExMatches` method returns the strings that match the regular expression defined in
17293
- * each `ItemHasRegularExpressionMatch` or `ItemHasKnownEntity` rule element in the manifest XML file.
17294
- * For an `ItemHasRegularExpressionMatch` rule, a matching string has to occur in the property of the item that is specified by that rule.
17295
- * The `PropertyName` simple type defines the supported properties.
17296
- *
17297
- * If you specify an `ItemHasRegularExpressionMatch` rule on the body property of an item, the regular expression should further filter the body
17298
- * and should not attempt to return the entire body of the item.
17299
- * Using a regular expression such as .* to obtain the entire body of an item does not always return the expected results.
17300
- * Instead, use the `Body.getAsync` method to retrieve the entire body.
17301
- *
17302
- * **Note**: This method is not supported in Outlook on iOS or Android.
17303
17541
  *
17304
17542
  * @returns
17305
17543
  * An object that contains arrays of strings that match the regular expressions defined in the manifest XML file.
17306
17544
  * The name of each array is equal to the corresponding value of the `RegExName` attribute of the matching `ItemHasRegularExpressionMatch` rule or
17307
- * the `FilterName` attribute of the matching `ItemHasKnownEntity` rule.
17545
+ * the `FilterName` attribute of the matching `ItemHasKnownEntity` rule. For an `ItemHasRegularExpressionMatch` rule, a matching string has to occur
17546
+ * in the property of the item that is specified by that rule. The `PropertyName` simple type defines the supported properties.
17308
17547
  *
17309
17548
  * @remarks
17310
17549
  * [Api set: Mailbox 1.6]
@@ -17312,6 +17551,31 @@ declare namespace Office {
17312
17551
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
17313
17552
  *
17314
17553
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read
17554
+ *
17555
+ * **Important**:
17556
+ *
17557
+ * - 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
17558
+ * entities in mail items to perform tasks on them.
17559
+ *
17560
+ * An alternative implementation of the **Join Meeting** button, which is activated by online meeting add-ins, is being developed.
17561
+ * Once support for entity-based contextual add-ins ends, online meeting add-ins will automatically transition to the alternative implementation
17562
+ * to activate the **Join Meeting** button.
17563
+ *
17564
+ * Regular expression rules will continue to be supported after entity-based contextual add-ins are retired. We recommend updating your contextual add-in
17565
+ * to use regular expression rules as an alternative solution. For guidance on how to implement these rules, see
17566
+ * {@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}.
17567
+ *
17568
+ * For more information, see
17569
+ * {@link https://devblogs.microsoft.com/microsoft365dev/retirement-of-entity-based-contextual-outlook-add-ins | Retirement of entity-based contextual Outlook add-ins}.
17570
+ *
17571
+ * - 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},
17572
+ * 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)}.
17573
+ *
17574
+ * - This method isn't supported in Outlook on iOS or Android.
17575
+ *
17576
+ * - If you specify an `ItemHasRegularExpressionMatch` rule on the body property of an item, the regular expression should further filter the body
17577
+ * 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
17578
+ * expected results. Instead, use the `Body.getAsync` method to retrieve the entire body.
17315
17579
  */
17316
17580
  getSelectedRegExMatches(): any;
17317
17581
  /**
@@ -17751,6 +18015,21 @@ declare namespace Office {
17751
18015
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
17752
18016
  *
17753
18017
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Read
18018
+ *
18019
+ * **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
18020
+ * entities in mail items to perform tasks on them. To help minimize potential disruptions, the following will still be supported after entity-based
18021
+ * contextual add-ins are retired.
18022
+ *
18023
+ * - An alternative implementation of the **Join Meeting** button, which is activated by online meeting add-ins, is being developed. Once support for
18024
+ * entity-based contextual add-ins ends, online meeting add-ins will automatically transition to the alternative implementation to activate the
18025
+ * **Join Meeting** button.
18026
+ *
18027
+ * - Regular expression rules will continue to be supported after entity-based contextual add-ins are retired. We recommend updating your contextual add-in
18028
+ * to use regular expression rules as an alternative solution. For guidance on how to implement these rules, see
18029
+ * {@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}.
18030
+ *
18031
+ * For more information, see
18032
+ * {@link https://devblogs.microsoft.com/microsoft365dev/retirement-of-entity-based-contextual-outlook-add-ins | Retirement of entity-based contextual Outlook add-ins}.
17754
18033
  */
17755
18034
  interface PhoneNumber {
17756
18035
  /**
office-js/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@types/office-js",
3
- "version": "1.0.364",
3
+ "version": "1.0.365",
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": "4e3dc1cec740c89db10d23bc7f5b7e1a053b59681c4737d4c8e892e233955d5b",
48
+ "typesPublisherContentHash": "dee2d5eb59a4f5150c09d1f61a75d098d94386cf36c31dfabef6e53b640c771f",
49
49
  "typeScriptVersion": "4.6"
50
50
  }