@types/office-js-preview 1.0.438 → 1.0.440

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.
@@ -8,7 +8,7 @@ This package contains type definitions for office-js-preview (https://github.com
8
8
  Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-js-preview.
9
9
 
10
10
  ### Additional Details
11
- * Last updated: Thu, 14 Dec 2023 23:35:42 GMT
11
+ * Last updated: Thu, 18 Jan 2024 19:35:50 GMT
12
12
  * Dependencies: none
13
13
 
14
14
  # Credits
@@ -8792,6 +8792,21 @@ declare namespace Office {
8792
8792
  * @remarks
8793
8793
  *
8794
8794
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read
8795
+ *
8796
+ * **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
8797
+ * entities in mail items to perform tasks on them. To help minimize potential disruptions, the following will still be supported after entity-based
8798
+ * contextual add-ins are retired.
8799
+ *
8800
+ * - An alternative implementation of the **Join Meeting** button, which is activated by online meeting add-ins, is being developed. Once support for
8801
+ * entity-based contextual add-ins ends, online meeting add-ins will automatically transition to the alternative implementation to activate the
8802
+ * **Join Meeting** button.
8803
+ *
8804
+ * - Regular expression rules will continue to be supported after entity-based contextual add-ins are retired. We recommend updating your contextual add-in
8805
+ * to use regular expression rules as an alternative solution. For guidance on how to implement these rules, see
8806
+ * {@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}.
8807
+ *
8808
+ * For more information, see
8809
+ * {@link https://devblogs.microsoft.com/microsoft365dev/retirement-of-entity-based-contextual-outlook-add-ins | Retirement of entity-based contextual Outlook add-ins}.
8795
8810
  */
8796
8811
  enum EntityType {
8797
8812
  /**
@@ -11792,7 +11807,23 @@ declare namespace Office {
11792
11807
  *
11793
11808
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee
11794
11809
  *
11795
- * **Important**: This method isn't supported in Outlook on Android or on iOS. For more information on supported APIs in Outlook mobile, see
11810
+ * **Important**:
11811
+ *
11812
+ * - 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
11813
+ * entities in mail items to perform tasks on them.
11814
+ *
11815
+ * An alternative implementation of the **Join Meeting** button, which is activated by online meeting add-ins, is being developed.
11816
+ * Once support for entity-based contextual add-ins ends, online meeting add-ins will automatically transition to the alternative implementation
11817
+ * to activate the **Join Meeting** button.
11818
+ *
11819
+ * Regular expression rules will continue to be supported after entity-based contextual add-ins are retired. We recommend updating your contextual add-in
11820
+ * to use regular expression rules as an alternative solution. For guidance on how to implement these rules, see
11821
+ * {@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}.
11822
+ *
11823
+ * For more information, see
11824
+ * {@link https://devblogs.microsoft.com/microsoft365dev/retirement-of-entity-based-contextual-outlook-add-ins | Retirement of entity-based contextual Outlook add-ins}.
11825
+ *
11826
+ * - This method isn't supported in Outlook on Android or on iOS. For more information on supported APIs in Outlook mobile, see
11796
11827
  * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
11797
11828
  */
11798
11829
  getEntities(): Entities;
@@ -11811,7 +11842,23 @@ declare namespace Office {
11811
11842
  *
11812
11843
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee
11813
11844
  *
11814
- * **Important**: This method isn't supported in Outlook on Android or on iOS. For more information on supported APIs in Outlook mobile, see
11845
+ * **Important**:
11846
+ *
11847
+ * - 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
11848
+ * entities in mail items to perform tasks on them.
11849
+ *
11850
+ * An alternative implementation of the **Join Meeting** button, which is activated by online meeting add-ins, is being developed.
11851
+ * Once support for entity-based contextual add-ins ends, online meeting add-ins will automatically transition to the alternative implementation
11852
+ * to activate the **Join Meeting** button.
11853
+ *
11854
+ * Regular expression rules will continue to be supported after entity-based contextual add-ins are retired. We recommend updating your contextual add-in
11855
+ * to use regular expression rules as an alternative solution. For guidance on how to implement these rules, see
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}.
11857
+ *
11858
+ * For more information, see
11859
+ * {@link https://devblogs.microsoft.com/microsoft365dev/retirement-of-entity-based-contextual-outlook-add-ins | Retirement of entity-based contextual Outlook add-ins}.
11860
+ *
11861
+ * - This method isn't supported in Outlook on Android or on iOS. For more information on supported APIs in Outlook mobile, see
11815
11862
  * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
11816
11863
  *
11817
11864
  * @param entityType - One of the `EntityType` enumeration values.
@@ -11880,8 +11927,22 @@ declare namespace Office {
11880
11927
  *
11881
11928
  * **Important**:
11882
11929
  *
11930
+ * - 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
11931
+ * entities in mail items to perform tasks on them.
11932
+ *
11933
+ * An alternative implementation of the **Join Meeting** button, which is activated by online meeting add-ins, is being developed.
11934
+ * Once support for entity-based contextual add-ins ends, online meeting add-ins will automatically transition to the alternative implementation
11935
+ * to activate the **Join Meeting** button.
11936
+ *
11937
+ * Regular expression rules will continue to be supported after entity-based contextual add-ins are retired. We recommend updating your contextual add-in
11938
+ * to use regular expression rules as an alternative solution. For guidance on how to implement these rules, see
11939
+ * {@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}.
11940
+ *
11941
+ * For more information, see
11942
+ * {@link https://devblogs.microsoft.com/microsoft365dev/retirement-of-entity-based-contextual-outlook-add-ins | Retirement of entity-based contextual Outlook add-ins}.
11943
+ *
11883
11944
  * - 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},
11884
- * 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)}.
11945
+ * 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)}.
11885
11946
  *
11886
11947
  * - This method isn't supported in Outlook on Android or on iOS. For more information on supported APIs in Outlook mobile, see
11887
11948
  * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
@@ -11941,8 +12002,22 @@ declare namespace Office {
11941
12002
  *
11942
12003
  * **Important**:
11943
12004
  *
12005
+ * - 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
12006
+ * entities in mail items to perform tasks on them.
12007
+ *
12008
+ * An alternative implementation of the **Join Meeting** button, which is activated by online meeting add-ins, is being developed.
12009
+ * Once support for entity-based contextual add-ins ends, online meeting add-ins will automatically transition to the alternative implementation
12010
+ * to activate the **Join Meeting** button.
12011
+ *
12012
+ * Regular expression rules will continue to be supported after entity-based contextual add-ins are retired. We recommend updating your contextual add-in
12013
+ * to use regular expression rules as an alternative solution. For guidance on how to implement these rules, see
12014
+ * {@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}.
12015
+ *
12016
+ * For more information, see
12017
+ * {@link https://devblogs.microsoft.com/microsoft365dev/retirement-of-entity-based-contextual-outlook-add-ins | Retirement of entity-based contextual Outlook add-ins}.
12018
+ *
11944
12019
  * - 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},
11945
- * 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)}.
12020
+ * 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)}.
11946
12021
  *
11947
12022
  * - If you specify an `ItemHasRegularExpressionMatch` rule on the body property of an item, the regular expression should further filter the body
11948
12023
  * 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.
@@ -11968,8 +12043,22 @@ declare namespace Office {
11968
12043
  *
11969
12044
  * **Important**:
11970
12045
  *
12046
+ * - 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
12047
+ * entities in mail items to perform tasks on them.
12048
+ *
12049
+ * An alternative implementation of the **Join Meeting** button, which is activated by online meeting add-ins, is being developed.
12050
+ * Once support for entity-based contextual add-ins ends, online meeting add-ins will automatically transition to the alternative implementation
12051
+ * to activate the **Join Meeting** button.
12052
+ *
12053
+ * Regular expression rules will continue to be supported after entity-based contextual add-ins are retired. We recommend updating your contextual add-in
12054
+ * to use regular expression rules as an alternative solution. For guidance on how to implement these rules, see
12055
+ * {@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}.
12056
+ *
12057
+ * For more information, see
12058
+ * {@link https://devblogs.microsoft.com/microsoft365dev/retirement-of-entity-based-contextual-outlook-add-ins | Retirement of entity-based contextual Outlook add-ins}.
12059
+ *
11971
12060
  * - 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},
11972
- * 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)}.
12061
+ * 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)}.
11973
12062
  *
11974
12063
  * - If you specify an `ItemHasRegularExpressionMatch` rule on the body property of an item, the regular expression should further filter the body
11975
12064
  * 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.
@@ -11983,10 +12072,6 @@ declare namespace Office {
11983
12072
  getRegExMatchesByName(name: string): string[];
11984
12073
  /**
11985
12074
  * Gets the entities found in a highlighted match a user has selected. Highlighted matches apply to contextual add-ins.
11986
- *
11987
- * **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)}.
11988
- *
11989
- * **Note**: This method is not supported in Outlook on iOS or Android.
11990
12075
  *
11991
12076
  * @remarks
11992
12077
  * [Api set: Mailbox 1.6]
@@ -11995,31 +12080,39 @@ declare namespace Office {
11995
12080
  *
11996
12081
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee
11997
12082
  *
12083
+ * **Important**:
12084
+ *
12085
+ * - 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
12086
+ * entities in mail items to perform tasks on them.
12087
+ *
12088
+ * An alternative implementation of the **Join Meeting** button, which is activated by online meeting add-ins, is being developed.
12089
+ * Once support for entity-based contextual add-ins ends, online meeting add-ins will automatically transition to the alternative implementation
12090
+ * to activate the **Join Meeting** button.
12091
+ *
12092
+ * Regular expression rules will continue to be supported after entity-based contextual add-ins are retired. We recommend updating your contextual add-in
12093
+ * to use regular expression rules as an alternative solution. For guidance on how to implement these rules, see
12094
+ * {@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}.
12095
+ *
12096
+ * For more information, see
12097
+ * {@link https://devblogs.microsoft.com/microsoft365dev/retirement-of-entity-based-contextual-outlook-add-ins | Retirement of entity-based contextual Outlook add-ins}.
12098
+ *
12099
+ * - 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},
12100
+ * 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)}.
12101
+ *
12102
+ * - This method isn't supported in Outlook on iOS or Android.
12103
+ *
11998
12104
  * @param name - The name of the `ItemHasRegularExpressionMatch` rule element that defines the filter to match.
11999
12105
  */
12000
12106
  getSelectedEntities(): Entities;
12001
12107
  /**
12002
12108
  * Returns string values in a highlighted match that match the regular expressions defined in an XML manifest file.
12003
12109
  * Highlighted matches apply to contextual add-ins.
12004
- *
12005
- * **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)}.
12006
- *
12007
- * The `getSelectedRegExMatches` method returns the strings that match the regular expression defined in each `ItemHasRegularExpressionMatch` or
12008
- * `ItemHasKnownEntity` rule element in the manifest XML file.
12009
- * For an `ItemHasRegularExpressionMatch` rule, a matching string has to occur in the property of the item that is specified by that rule.
12010
- * The `PropertyName` simple type defines the supported properties.
12011
- *
12012
- * If you specify an `ItemHasRegularExpressionMatch` rule on the body property of an item, the regular expression should further filter the body
12013
- * and should not attempt to return the entire body of the item.
12014
- * Using a regular expression such as .* to obtain the entire body of an item does not always return the expected results.
12015
- * Instead, use the `Body.getAsync` method to retrieve the entire body.
12016
- *
12017
- * **Note**: This method is not supported in Outlook on iOS or Android.
12018
12110
  *
12019
12111
  * @returns
12020
12112
  * An object that contains arrays of strings that match the regular expressions defined in the manifest XML file.
12021
- * The name of each array is equal to the corresponding value of the `RegExName` attribute of the matching `ItemHasRegularExpressionMatch` rule
12022
- * or the `FilterName` attribute of the matching `ItemHasKnownEntity` rule.
12113
+ * The name of each array is equal to the corresponding value of the `RegExName` attribute of the matching `ItemHasRegularExpressionMatch` rule or
12114
+ * the `FilterName` attribute of the matching `ItemHasKnownEntity` rule. For an `ItemHasRegularExpressionMatch` rule, a matching string has to occur
12115
+ * in the property of the item that is specified by that rule. The `PropertyName` simple type defines the supported properties.
12023
12116
  *
12024
12117
  * @remarks
12025
12118
  * [Api set: Mailbox 1.6]
@@ -12027,6 +12120,31 @@ declare namespace Office {
12027
12120
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
12028
12121
  *
12029
12122
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee
12123
+ *
12124
+ * **Important**:
12125
+ *
12126
+ * - 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
12127
+ * entities in mail items to perform tasks on them.
12128
+ *
12129
+ * An alternative implementation of the **Join Meeting** button, which is activated by online meeting add-ins, is being developed.
12130
+ * Once support for entity-based contextual add-ins ends, online meeting add-ins will automatically transition to the alternative implementation
12131
+ * to activate the **Join Meeting** button.
12132
+ *
12133
+ * Regular expression rules will continue to be supported after entity-based contextual add-ins are retired. We recommend updating your contextual add-in
12134
+ * to use regular expression rules as an alternative solution. For guidance on how to implement these rules, see
12135
+ * {@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}.
12136
+ *
12137
+ * For more information, see
12138
+ * {@link https://devblogs.microsoft.com/microsoft365dev/retirement-of-entity-based-contextual-outlook-add-ins | Retirement of entity-based contextual Outlook add-ins}.
12139
+ *
12140
+ * - 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},
12141
+ * 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)}.
12142
+ *
12143
+ * - This method isn't supported in Outlook on iOS or Android.
12144
+ *
12145
+ * - If you specify an `ItemHasRegularExpressionMatch` rule on the body property of an item, the regular expression should further filter the body
12146
+ * 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
12147
+ * expected results. Instead, use the `Body.getAsync` method to retrieve the entire body.
12030
12148
  */
12031
12149
  getSelectedRegExMatches(): any;
12032
12150
  /**
@@ -13056,6 +13174,21 @@ declare namespace Office {
13056
13174
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **restricted**
13057
13175
  *
13058
13176
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Read
13177
+ *
13178
+ * **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
13179
+ * entities in mail items to perform tasks on them. To help minimize potential disruptions, the following will still be supported after entity-based
13180
+ * contextual add-ins are retired.
13181
+ *
13182
+ * - An alternative implementation of the **Join Meeting** button, which is activated by online meeting add-ins, is being developed. Once support for
13183
+ * entity-based contextual add-ins ends, online meeting add-ins will automatically transition to the alternative implementation to activate the
13184
+ * **Join Meeting** button.
13185
+ *
13186
+ * - Regular expression rules will continue to be supported after entity-based contextual add-ins are retired. We recommend updating your contextual add-in
13187
+ * to use regular expression rules as an alternative solution. For guidance on how to implement these rules, see
13188
+ * {@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}.
13189
+ *
13190
+ * For more information, see
13191
+ * {@link https://devblogs.microsoft.com/microsoft365dev/retirement-of-entity-based-contextual-outlook-add-ins | Retirement of entity-based contextual Outlook add-ins}.
13059
13192
  */
13060
13193
  interface Contact {
13061
13194
  /**
@@ -13283,6 +13416,12 @@ declare namespace Office {
13283
13416
  *
13284
13417
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
13285
13418
  *
13419
+ * **Important**: When `item.delayDeliveryTime.setAsync` is used to schedule the delivery of a message, the delay is processed on the server.
13420
+ * This allows the message to be sent even if the Outlook client isn't running. However, because of this, the message doesn't appear in the
13421
+ * **Outbox** folder, so you won't be able to edit the message or cancel its delivery after selecting **Send**. You'll only be able to review
13422
+ * the mesasge from the **Sent Items** folder once the message is sent. To learn more, see
13423
+ * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/delay-delivery | Manage the delivery date and time of a message}.
13424
+ *
13286
13425
  * **Errors**:
13287
13426
  *
13288
13427
  * - `InvalidFormatError` - The format of the specified data object is not valid.
@@ -13304,6 +13443,12 @@ declare namespace Office {
13304
13443
  *
13305
13444
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
13306
13445
  *
13446
+ * **Important**: When `item.delayDeliveryTime.setAsync` is used to schedule the delivery of a message, the delay is processed on the server.
13447
+ * This allows the message to be sent even if the Outlook client isn't running. However, because of this, the message doesn't appear in the
13448
+ * **Outbox** folder, so you won't be able to edit the message or cancel its delivery after selecting **Send**. You'll only be able to review
13449
+ * the mesasge from the **Sent Items** folder once the message is sent. To learn more, see
13450
+ * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/delay-delivery | Manage the delivery date and time of a message}.
13451
+ *
13307
13452
  * **Errors**:
13308
13453
  *
13309
13454
  * - `InvalidFormatError` - The format of the specified data object is not valid.
@@ -13767,6 +13912,21 @@ declare namespace Office {
13767
13912
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
13768
13913
  *
13769
13914
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Read
13915
+ *
13916
+ * **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
13917
+ * entities in mail items to perform tasks on them. To help minimize potential disruptions, the following will still be supported after entity-based
13918
+ * contextual add-ins are retired.
13919
+ *
13920
+ * - An alternative implementation of the **Join Meeting** button, which is activated by online meeting add-ins, is being developed. Once support for
13921
+ * entity-based contextual add-ins ends, online meeting add-ins will automatically transition to the alternative implementation to activate the
13922
+ * **Join Meeting** button.
13923
+ *
13924
+ * - Regular expression rules will continue to be supported after entity-based contextual add-ins are retired. We recommend updating your contextual add-in
13925
+ * to use regular expression rules as an alternative solution. For guidance on how to implement these rules, see
13926
+ * {@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}.
13927
+ *
13928
+ * For more information, see
13929
+ * {@link https://devblogs.microsoft.com/microsoft365dev/retirement-of-entity-based-contextual-outlook-add-ins | Retirement of entity-based contextual Outlook add-ins}.
13770
13930
  */
13771
13931
  interface Entities {
13772
13932
  /**
@@ -15448,6 +15608,21 @@ declare namespace Office {
15448
15608
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
15449
15609
  *
15450
15610
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Read
15611
+ *
15612
+ * **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
15613
+ * entities in mail items to perform tasks on them. To help minimize potential disruptions, the following will still be supported after entity-based
15614
+ * contextual add-ins are retired.
15615
+ *
15616
+ * - An alternative implementation of the **Join Meeting** button, which is activated by online meeting add-ins, is being developed. Once support for
15617
+ * entity-based contextual add-ins ends, online meeting add-ins will automatically transition to the alternative implementation to activate the
15618
+ * **Join Meeting** button.
15619
+ *
15620
+ * - Regular expression rules will continue to be supported after entity-based contextual add-ins are retired. We recommend updating your contextual add-in
15621
+ * to use regular expression rules as an alternative solution. For guidance on how to implement these rules, see
15622
+ * {@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}.
15623
+ *
15624
+ * For more information, see
15625
+ * {@link https://devblogs.microsoft.com/microsoft365dev/retirement-of-entity-based-contextual-outlook-add-ins | Retirement of entity-based contextual Outlook add-ins}.
15451
15626
  */
15452
15627
  interface MeetingSuggestion {
15453
15628
  /**
@@ -17525,7 +17700,23 @@ declare namespace Office {
17525
17700
  *
17526
17701
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee
17527
17702
  *
17528
- * **Important**: This method isn't supported in Outlook on Android or on iOS. For more information on supported APIs in Outlook mobile, see
17703
+ * **Important**:
17704
+ *
17705
+ * - 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
17706
+ * entities in mail items to perform tasks on them.
17707
+ *
17708
+ * An alternative implementation of the **Join Meeting** button, which is activated by online meeting add-ins, is being developed.
17709
+ * Once support for entity-based contextual add-ins ends, online meeting add-ins will automatically transition to the alternative implementation
17710
+ * to activate the **Join Meeting** button.
17711
+ *
17712
+ * Regular expression rules will continue to be supported after entity-based contextual add-ins are retired. We recommend updating your contextual add-in
17713
+ * to use regular expression rules as an alternative solution. For guidance on how to implement these rules, see
17714
+ * {@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}.
17715
+ *
17716
+ * For more information, see
17717
+ * {@link https://devblogs.microsoft.com/microsoft365dev/retirement-of-entity-based-contextual-outlook-add-ins | Retirement of entity-based contextual Outlook add-ins}.
17718
+ *
17719
+ * - This method isn't supported in Outlook on Android or on iOS. For more information on supported APIs in Outlook mobile, see
17529
17720
  * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
17530
17721
  */
17531
17722
  getEntities(): Entities;
@@ -17544,7 +17735,23 @@ declare namespace Office {
17544
17735
  *
17545
17736
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read
17546
17737
  *
17547
- * **Important**: This method isn't supported in Outlook on Android or on iOS. For more information on supported APIs in Outlook mobile, see
17738
+ * **Important**:
17739
+ *
17740
+ * - 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
17741
+ * entities in mail items to perform tasks on them.
17742
+ *
17743
+ * An alternative implementation of the **Join Meeting** button, which is activated by online meeting add-ins, is being developed.
17744
+ * Once support for entity-based contextual add-ins ends, online meeting add-ins will automatically transition to the alternative implementation
17745
+ * to activate the **Join Meeting** button.
17746
+ *
17747
+ * Regular expression rules will continue to be supported after entity-based contextual add-ins are retired. We recommend updating your contextual add-in
17748
+ * to use regular expression rules as an alternative solution. For guidance on how to implement these rules, see
17749
+ * {@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}.
17750
+ *
17751
+ * For more information, see
17752
+ * {@link https://devblogs.microsoft.com/microsoft365dev/retirement-of-entity-based-contextual-outlook-add-ins | Retirement of entity-based contextual Outlook add-ins}.
17753
+ *
17754
+ * - This method isn't supported in Outlook on Android or on iOS. For more information on supported APIs in Outlook mobile, see
17548
17755
  * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
17549
17756
  *
17550
17757
  * @param entityType - One of the `EntityType` enumeration values.
@@ -17614,8 +17821,22 @@ declare namespace Office {
17614
17821
  *
17615
17822
  * **Important**:
17616
17823
  *
17824
+ * - 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
17825
+ * entities in mail items to perform tasks on them.
17826
+ *
17827
+ * An alternative implementation of the **Join Meeting** button, which is activated by online meeting add-ins, is being developed.
17828
+ * Once support for entity-based contextual add-ins ends, online meeting add-ins will automatically transition to the alternative implementation
17829
+ * to activate the **Join Meeting** button.
17830
+ *
17831
+ * Regular expression rules will continue to be supported after entity-based contextual add-ins are retired. We recommend updating your contextual add-in
17832
+ * to use regular expression rules as an alternative solution. For guidance on how to implement these rules, see
17833
+ * {@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}.
17834
+ *
17835
+ * For more information, see
17836
+ * {@link https://devblogs.microsoft.com/microsoft365dev/retirement-of-entity-based-contextual-outlook-add-ins | Retirement of entity-based contextual Outlook add-ins}.
17837
+ *
17617
17838
  * - 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},
17618
- * 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)}.
17839
+ * 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)}.
17619
17840
  *
17620
17841
  * - This method isn't supported in Outlook on Android or on iOS. For more information on supported APIs in Outlook mobile, see
17621
17842
  * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
@@ -17675,8 +17896,22 @@ declare namespace Office {
17675
17896
  *
17676
17897
  * **Important**:
17677
17898
  *
17899
+ * - 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
17900
+ * entities in mail items to perform tasks on them.
17901
+ *
17902
+ * An alternative implementation of the **Join Meeting** button, which is activated by online meeting add-ins, is being developed.
17903
+ * Once support for entity-based contextual add-ins ends, online meeting add-ins will automatically transition to the alternative implementation
17904
+ * to activate the **Join Meeting** button.
17905
+ *
17906
+ * Regular expression rules will continue to be supported after entity-based contextual add-ins are retired. We recommend updating your contextual add-in
17907
+ * to use regular expression rules as an alternative solution. For guidance on how to implement these rules, see
17908
+ * {@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}.
17909
+ *
17910
+ * For more information, see
17911
+ * {@link https://devblogs.microsoft.com/microsoft365dev/retirement-of-entity-based-contextual-outlook-add-ins | Retirement of entity-based contextual Outlook add-ins}.
17912
+ *
17678
17913
  * - 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},
17679
- * 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)}.
17914
+ * 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)}.
17680
17915
  *
17681
17916
  * - If you specify an `ItemHasRegularExpressionMatch` rule on the body property of an item, the regular expression should further filter the body
17682
17917
  * 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.
@@ -17702,8 +17937,22 @@ declare namespace Office {
17702
17937
  *
17703
17938
  * **Important**:
17704
17939
  *
17940
+ * - 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
17941
+ * entities in mail items to perform tasks on them.
17942
+ *
17943
+ * An alternative implementation of the **Join Meeting** button, which is activated by online meeting add-ins, is being developed.
17944
+ * Once support for entity-based contextual add-ins ends, online meeting add-ins will automatically transition to the alternative implementation
17945
+ * to activate the **Join Meeting** button.
17946
+ *
17947
+ * Regular expression rules will continue to be supported after entity-based contextual add-ins are retired. We recommend updating your contextual add-in
17948
+ * to use regular expression rules as an alternative solution. For guidance on how to implement these rules, see
17949
+ * {@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}.
17950
+ *
17951
+ * For more information, see
17952
+ * {@link https://devblogs.microsoft.com/microsoft365dev/retirement-of-entity-based-contextual-outlook-add-ins | Retirement of entity-based contextual Outlook add-ins}.
17953
+ *
17705
17954
  * - 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},
17706
- * 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)}.
17955
+ * 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)}.
17707
17956
  *
17708
17957
  * - If you specify an `ItemHasRegularExpressionMatch` rule on the body property of an item, the regular expression should further filter the body
17709
17958
  * 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.
@@ -17729,31 +17978,33 @@ declare namespace Office {
17729
17978
  *
17730
17979
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read
17731
17980
  *
17981
+ * **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
17982
+ * entities in mail items to perform tasks on them. To help minimize potential disruptions, the following will still be supported after entity-based
17983
+ * contextual add-ins are retired.
17984
+ *
17985
+ * - An alternative implementation of the **Join Meeting** button, which is activated by online meeting add-ins, is being developed. Once support for
17986
+ * entity-based contextual add-ins ends, online meeting add-ins will automatically transition to the alternative implementation to activate the
17987
+ * **Join Meeting** button.
17988
+ *
17989
+ * - Regular expression rules will continue to be supported after entity-based contextual add-ins are retired. We recommend updating your contextual add-in
17990
+ * to use regular expression rules as an alternative solution. For guidance on how to implement these rules, see
17991
+ * {@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}.
17992
+ *
17993
+ * For more information, see
17994
+ * {@link https://devblogs.microsoft.com/microsoft365dev/retirement-of-entity-based-contextual-outlook-add-ins | Retirement of entity-based contextual Outlook add-ins}.
17995
+ *
17732
17996
  * @param name - The name of the `ItemHasRegularExpressionMatch` rule element that defines the filter to match.
17733
17997
  */
17734
17998
  getSelectedEntities(): Entities;
17735
17999
  /**
17736
18000
  * Returns string values in a highlighted match that match the regular expressions defined in an XML manifest file.
17737
18001
  * Highlighted matches apply to contextual add-ins.
17738
- *
17739
- * **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)}.
17740
- *
17741
- * The `getSelectedRegExMatches` method returns the strings that match the regular expression defined in
17742
- * each `ItemHasRegularExpressionMatch` or `ItemHasKnownEntity` rule element in the manifest XML file.
17743
- * For an `ItemHasRegularExpressionMatch` rule, a matching string has to occur in the property of the item that is specified by that rule.
17744
- * The `PropertyName` simple type defines the supported properties.
17745
- *
17746
- * If you specify an `ItemHasRegularExpressionMatch` rule on the body property of an item, the regular expression should further filter the body
17747
- * and should not attempt to return the entire body of the item.
17748
- * Using a regular expression such as .* to obtain the entire body of an item does not always return the expected results.
17749
- * Instead, use the `Body.getAsync` method to retrieve the entire body.
17750
- *
17751
- * **Note**: This method is not supported in Outlook on iOS or Android.
17752
18002
  *
17753
18003
  * @returns
17754
18004
  * An object that contains arrays of strings that match the regular expressions defined in the manifest XML file.
17755
18005
  * The name of each array is equal to the corresponding value of the `RegExName` attribute of the matching `ItemHasRegularExpressionMatch` rule or
17756
- * the `FilterName` attribute of the matching `ItemHasKnownEntity` rule.
18006
+ * the `FilterName` attribute of the matching `ItemHasKnownEntity` rule. For an `ItemHasRegularExpressionMatch` rule, a matching string has to occur
18007
+ * in the property of the item that is specified by that rule. The `PropertyName` simple type defines the supported properties.
17757
18008
  *
17758
18009
  * @remarks
17759
18010
  * [Api set: Mailbox 1.6]
@@ -17761,6 +18012,31 @@ declare namespace Office {
17761
18012
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
17762
18013
  *
17763
18014
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read
18015
+ *
18016
+ * **Important**:
18017
+ *
18018
+ * - 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
18019
+ * entities in mail items to perform tasks on them.
18020
+ *
18021
+ * An alternative implementation of the **Join Meeting** button, which is activated by online meeting add-ins, is being developed.
18022
+ * Once support for entity-based contextual add-ins ends, online meeting add-ins will automatically transition to the alternative implementation
18023
+ * to activate the **Join Meeting** button.
18024
+ *
18025
+ * Regular expression rules will continue to be supported after entity-based contextual add-ins are retired. We recommend updating your contextual add-in
18026
+ * to use regular expression rules as an alternative solution. For guidance on how to implement these rules, see
18027
+ * {@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}.
18028
+ *
18029
+ * For more information, see
18030
+ * {@link https://devblogs.microsoft.com/microsoft365dev/retirement-of-entity-based-contextual-outlook-add-ins | Retirement of entity-based contextual Outlook add-ins}.
18031
+ *
18032
+ * - 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},
18033
+ * 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)}.
18034
+ *
18035
+ * - This method isn't supported in Outlook on iOS or Android.
18036
+ *
18037
+ * - If you specify an `ItemHasRegularExpressionMatch` rule on the body property of an item, the regular expression should further filter the body
18038
+ * 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
18039
+ * expected results. Instead, use the `Body.getAsync` method to retrieve the entire body.
17764
18040
  */
17765
18041
  getSelectedRegExMatches(): any;
17766
18042
  /**
@@ -18318,6 +18594,21 @@ declare namespace Office {
18318
18594
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
18319
18595
  *
18320
18596
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Read
18597
+ *
18598
+ * **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
18599
+ * entities in mail items to perform tasks on them. To help minimize potential disruptions, the following will still be supported after entity-based
18600
+ * contextual add-ins are retired.
18601
+ *
18602
+ * - An alternative implementation of the **Join Meeting** button, which is activated by online meeting add-ins, is being developed. Once support for
18603
+ * entity-based contextual add-ins ends, online meeting add-ins will automatically transition to the alternative implementation to activate the
18604
+ * **Join Meeting** button.
18605
+ *
18606
+ * - Regular expression rules will continue to be supported after entity-based contextual add-ins are retired. We recommend updating your contextual add-in
18607
+ * to use regular expression rules as an alternative solution. For guidance on how to implement these rules, see
18608
+ * {@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}.
18609
+ *
18610
+ * For more information, see
18611
+ * {@link https://devblogs.microsoft.com/microsoft365dev/retirement-of-entity-based-contextual-outlook-add-ins | Retirement of entity-based contextual Outlook add-ins}.
18321
18612
  */
18322
18613
  interface PhoneNumber {
18323
18614
  /**
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@types/office-js-preview",
3
- "version": "1.0.438",
3
+ "version": "1.0.440",
4
4
  "description": "TypeScript definitions for office-js-preview",
5
5
  "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-js-preview",
6
6
  "license": "MIT",
@@ -45,6 +45,6 @@
45
45
  },
46
46
  "scripts": {},
47
47
  "dependencies": {},
48
- "typesPublisherContentHash": "7c92aa7d4cd4e56f956d79dce5c93e7598111f0675b203880fd67e012144faf1",
48
+ "typesPublisherContentHash": "41c4798c5e2d83517de56834a5b186f8270b0b5e87ede1c9623af02db4e37383",
49
49
  "typeScriptVersion": "4.6"
50
50
  }