@types/office-js-preview 1.0.485 → 1.0.486

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, 11 Jul 2024 15:07:15 GMT
11
+ * Last updated: Wed, 17 Jul 2024 22:36:40 GMT
12
12
  * Dependencies: none
13
13
 
14
14
  # Credits
@@ -9097,31 +9097,16 @@ declare namespace Office {
9097
9097
  /**
9098
9098
  * Specifies an entity's type.
9099
9099
  *
9100
- * @remarks
9101
- *
9102
- * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read
9103
- *
9104
- * **Important**: Entity-based contextual Outlook add-ins will be retired in Q2 of 2024. The work to retire this feature will start in May and continue
9105
- * until the end of June. After June, contextual add-ins will no longer be able to detect entities in mail items to perform tasks on them.
9106
- * The following APIs will also be retired.
9100
+ * **Warning**: Entity-based contextual Outlook add-ins are now retired. However, regular expression rules are still supported.
9101
+ * We recommend updating your contextual add-in to use regular expression rules as an alternative solution.
9102
+ * For guidance on how to implement these rules, see
9103
+ * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins | Contextual Outlook add-ins}.
9107
9104
  *
9108
- * - `Office.context.mailbox.item.getEntities`
9109
- * - `Office.context.mailbox.item.getEntitiesByType`
9110
- * - `Office.context.mailbox.item.getFilteredEntitiesByName`
9111
- * - `Office.context.mailbox.item.getSelectedEntities`
9105
+ * @deprecated Use {@link https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins | regular expression rules} instead.
9112
9106
  *
9113
- * To help minimize potential disruptions, the following will still be supported after entity-based contextual add-ins are retired.
9114
- *
9115
- * - An alternative implementation of the **Join Meeting** button, which is activated by online meeting add-ins, is being developed. Once support for
9116
- * entity-based contextual add-ins ends, online meeting add-ins will automatically transition to the alternative implementation to activate the
9117
- * **Join Meeting** button.
9118
- *
9119
- * - Regular expression rules will continue to be supported after entity-based contextual add-ins are retired. We recommend updating your contextual add-in
9120
- * to use regular expression rules as an alternative solution. For guidance on how to implement these rules, see
9121
- * {@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}.
9107
+ * @remarks
9122
9108
  *
9123
- * For more information, see
9124
- * {@link https://devblogs.microsoft.com/microsoft365dev/retirement-of-entity-based-contextual-outlook-add-ins | Retirement of entity-based contextual Outlook add-ins}.
9109
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read
9125
9110
  */
9126
9111
  enum EntityType {
9127
9112
  /**
@@ -12097,30 +12082,31 @@ declare namespace Office {
12097
12082
  /**
12098
12083
  * Gets the entities found in the selected item's body.
12099
12084
  *
12085
+ * **Warning**: Entity-based contextual Outlook add-ins are now retired. However, regular expression rules are still supported.
12086
+ * We recommend updating your contextual add-in to use regular expression rules as an alternative solution.
12087
+ * For guidance on how to implement these rules, see
12088
+ * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins | Contextual Outlook add-ins}.
12089
+ *
12090
+ * @deprecated Use {@link https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins | regular expression rules} instead.
12091
+ *
12100
12092
  * @remarks
12101
12093
  * [Api set: Mailbox 1.1]
12102
12094
  *
12103
12095
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
12104
12096
  *
12105
12097
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee
12106
- *
12107
- * **Important**:
12108
- *
12109
- * - Entity-based contextual Outlook add-ins, including the `getEntities` method, will be retired in Q2 of 2024. The work to retire this method will
12110
- * start in May and continue until the end of June. After June, contextual add-ins will no longer be able to detect entities in mail items to perform tasks on them.
12111
- * Regular expression rules will continue to be supported after entity-based contextual add-ins are retired. We recommend updating your contextual add-in
12112
- * to use regular expression rules as an alternative solution. For guidance on how to implement these rules, see
12113
- * {@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}.
12114
- * To learn more about the retirement of entity-based contextual Outlook add-ins, see
12115
- * {@link https://devblogs.microsoft.com/microsoft365dev/retirement-of-entity-based-contextual-outlook-add-ins | Retirement of entity-based contextual Outlook add-ins}.
12116
- *
12117
- * - This method isn't supported in Outlook on Android or on iOS. For more information on supported APIs in Outlook mobile, see
12118
- * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
12119
12098
  */
12120
12099
  getEntities(): Entities;
12121
12100
  /**
12122
12101
  * Gets an array of all the entities of the specified entity type found in the selected item's body.
12123
12102
  *
12103
+ * **Warning**: Entity-based contextual Outlook add-ins are now retired. However, regular expression rules are still supported.
12104
+ * We recommend updating your contextual add-in to use regular expression rules as an alternative solution.
12105
+ * For guidance on how to implement these rules, see
12106
+ * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins | Contextual Outlook add-ins}.
12107
+ *
12108
+ * @deprecated Use {@link https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins | regular expression rules} instead.
12109
+ *
12124
12110
  * @returns
12125
12111
  * If the value passed in `entityType` is not a valid member of the `EntityType` enumeration, the method returns null.
12126
12112
  * If no entities of the specified type are present in the item's body, the method returns an empty array.
@@ -12132,71 +12118,20 @@ declare namespace Office {
12132
12118
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **restricted**
12133
12119
  *
12134
12120
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee
12135
- *
12136
- * **Important**:
12137
- *
12138
- * - Entity-based contextual Outlook add-ins, including the `getEntitiesByType` method, will be retired in Q2 of 2024. The work to retire this method will
12139
- * start in May and continue until the end of June. After June, contextual add-ins will no longer be able to detect entities in mail items to perform tasks on them.
12140
- * Regular expression rules will continue to be supported after entity-based contextual add-ins are retired. We recommend updating your contextual add-in
12141
- * to use regular expression rules as an alternative solution. For guidance on how to implement these rules, see
12142
- * {@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}.
12143
- * To learn more about the retirement of entity-based contextual Outlook add-ins, see
12144
- * {@link https://devblogs.microsoft.com/microsoft365dev/retirement-of-entity-based-contextual-outlook-add-ins | Retirement of entity-based contextual Outlook add-ins}.
12145
- *
12146
- * - This method isn't supported in Outlook on Android or on iOS. For more information on supported APIs in Outlook mobile, see
12147
- * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
12148
12121
  *
12149
12122
  * @param entityType - One of the `EntityType` enumeration values.
12150
- *
12151
- * While the minimum permission level to use this method is **restricted**, some entity types require **read item** to access, as specified in the following table.
12152
- *
12153
- * <table>
12154
- * <tr>
12155
- * <th>Value of entityType</th>
12156
- * <th>Type of objects in returned array</th>
12157
- * <th>Required permission level</th>
12158
- * </tr>
12159
- * <tr>
12160
- * <td>Address</td>
12161
- * <td>String</td>
12162
- * <td>Restricted</td>
12163
- * </tr>
12164
- * <tr>
12165
- * <td>Contact</td>
12166
- * <td>Contact</td>
12167
- * <td>ReadItem</td>
12168
- * </tr>
12169
- * <tr>
12170
- * <td>EmailAddress</td>
12171
- * <td>String</td>
12172
- * <td>ReadItem</td>
12173
- * </tr>
12174
- * <tr>
12175
- * <td>MeetingSuggestion</td>
12176
- * <td>MeetingSuggestion</td>
12177
- * <td>ReadItem</td>
12178
- * </tr>
12179
- * <tr>
12180
- * <td>PhoneNumber</td>
12181
- * <td>PhoneNumber</td>
12182
- * <td>Restricted</td>
12183
- * </tr>
12184
- * <tr>
12185
- * <td>TaskSuggestion</td>
12186
- * <td>TaskSuggestion</td>
12187
- * <td>ReadItem</td>
12188
- * </tr>
12189
- * <tr>
12190
- * <td>URL</td>
12191
- * <td>String</td>
12192
- * <td>Restricted</td>
12193
- * </tr>
12194
- * </table>
12195
12123
  */
12196
12124
  getEntitiesByType(entityType: MailboxEnums.EntityType | string): Array<string | Contact | MeetingSuggestion | PhoneNumber | TaskSuggestion>;
12197
12125
  /**
12198
12126
  * Returns well-known entities in the selected item that pass the named filter defined in an XML manifest file.
12199
12127
  *
12128
+ * **Warning**: Entity-based contextual Outlook add-ins are now retired. However, regular expression rules are still supported.
12129
+ * We recommend updating your contextual add-in to use regular expression rules as an alternative solution.
12130
+ * For guidance on how to implement these rules, see
12131
+ * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins | Contextual Outlook add-ins}.
12132
+ *
12133
+ * @deprecated Use {@link https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins | regular expression rules} instead.
12134
+ *
12200
12135
  * @returns
12201
12136
  * The entities that match the regular expression defined in the `ItemHasKnownEntity` rule element in the
12202
12137
  * manifest XML file with the specified `FilterName` element value. If there's no `ItemHasKnownEntity` element in the manifest with a
@@ -12210,22 +12145,6 @@ declare namespace Office {
12210
12145
  *
12211
12146
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee
12212
12147
  *
12213
- * **Important**:
12214
- *
12215
- * - Entity-based contextual Outlook add-ins, including the `getFilteredEntitiesByName` method, will be retired in Q2 of 2024. The work to retire this method will
12216
- * start in May and continue until the end of June. After June, contextual add-ins will no longer be able to detect entities in mail items to perform tasks on them.
12217
- * Regular expression rules will continue to be supported after entity-based contextual add-ins are retired. We recommend updating your contextual add-in
12218
- * to use regular expression rules as an alternative solution. For guidance on how to implement these rules, see
12219
- * {@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}.
12220
- * To learn more about the retirement of entity-based contextual Outlook add-ins, see
12221
- * {@link https://devblogs.microsoft.com/microsoft365dev/retirement-of-entity-based-contextual-outlook-add-ins | Retirement of entity-based contextual Outlook add-ins}.
12222
- *
12223
- * - 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},
12224
- * which isn't supported by the {@link https://learn.microsoft.com/office/dev/add-ins/develop/json-manifest-overview | unified manifest for Microsoft 365}.
12225
- *
12226
- * - This method isn't supported in Outlook on Android or on iOS. For more information on supported APIs in Outlook mobile, see
12227
- * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
12228
- *
12229
12148
  * @param name - The name of the `ItemHasKnownEntity` rule element that defines the filter to match.
12230
12149
  */
12231
12150
  getFilteredEntitiesByName(name: string): Array<string | Contact | MeetingSuggestion | PhoneNumber | TaskSuggestion>;
@@ -12268,8 +12187,8 @@ declare namespace Office {
12268
12187
  *
12269
12188
  * @returns
12270
12189
  * An object that contains arrays of strings that match the regular expressions defined in the manifest XML file.
12271
- * The name of each array is equal to the corresponding value of the RegExName attribute of the matching `ItemHasRegularExpressionMatch` rule
12272
- * or the `FilterName` attribute of the matching `ItemHasKnownEntity` rule. For an `ItemHasRegularExpressionMatch` rule, a matching string has to occur in the property
12190
+ * The name of each array is equal to the corresponding value of the RegExName attribute of the matching `ItemHasRegularExpressionMatch` rule.
12191
+ * For an `ItemHasRegularExpressionMatch` rule, a matching string has to occur in the property
12273
12192
  * of the item that's specified by that rule. The `PropertyName` simple type defines the supported properties.
12274
12193
  *
12275
12194
  * @remarks
@@ -12281,12 +12200,10 @@ declare namespace Office {
12281
12200
  *
12282
12201
  * **Important**:
12283
12202
  *
12284
- * - 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
12285
- * entities in mail items to perform tasks on them. Regular expression rules will continue to be supported after entity-based contextual add-ins are retired.
12286
- * We recommend updating your contextual add-in to use regular expression rules as an alternative solution. For guidance on how to implement these rules, see
12287
- * {@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}.
12288
- * To learn more about the retirement of entity-based contextual add-ins, see
12289
- * {@link https://devblogs.microsoft.com/microsoft365dev/retirement-of-entity-based-contextual-outlook-add-ins | Retirement of entity-based contextual Outlook add-ins}.
12203
+ * - Entity-based contextual Outlook add-ins are now retired. However, regular expression rules are still supported.
12204
+ * We recommend updating your contextual add-in to use regular expression rules as an alternative solution.
12205
+ * For guidance on how to implement these rules, see
12206
+ * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins | Contextual Outlook add-ins}.
12290
12207
  *
12291
12208
  * - 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},
12292
12209
  * which isn't supported by the {@link https://learn.microsoft.com/office/dev/add-ins/develop/json-manifest-overview | unified manifest for Microsoft 365}.
@@ -12315,12 +12232,10 @@ declare namespace Office {
12315
12232
  *
12316
12233
  * **Important**:
12317
12234
  *
12318
- * - 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
12319
- * entities in mail items to perform tasks on them. Regular expression rules will continue to be supported after entity-based contextual add-ins are retired.
12320
- * We recommend updating your contextual add-in to use regular expression rules as an alternative solution. For guidance on how to implement these rules, see
12321
- * {@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}.
12322
- * To learn more about the retirement of entity-based contextual add-ins, see
12323
- * {@link https://devblogs.microsoft.com/microsoft365dev/retirement-of-entity-based-contextual-outlook-add-ins | Retirement of entity-based contextual Outlook add-ins}.
12235
+ * - Entity-based contextual Outlook add-ins are now retired. However, regular expression rules are still supported.
12236
+ * We recommend updating your contextual add-in to use regular expression rules as an alternative solution.
12237
+ * For guidance on how to implement these rules, see
12238
+ * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins | Contextual Outlook add-ins}.
12324
12239
  *
12325
12240
  * - 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},
12326
12241
  * which isn't supported by the {@link https://learn.microsoft.com/office/dev/add-ins/develop/json-manifest-overview | unified manifest for Microsoft 365}.
@@ -12338,6 +12253,13 @@ declare namespace Office {
12338
12253
  /**
12339
12254
  * Gets the entities found in a highlighted match a user has selected. Highlighted matches apply to contextual add-ins.
12340
12255
  *
12256
+ * **Warning**: Entity-based contextual Outlook add-ins are now retired. However, regular expression rules are still supported.
12257
+ * We recommend updating your contextual add-in to use regular expression rules as an alternative solution.
12258
+ * For guidance on how to implement these rules, see
12259
+ * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins | Contextual Outlook add-ins}.
12260
+ *
12261
+ * @deprecated Use {@link https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins | regular expression rules} instead.
12262
+ *
12341
12263
  * @remarks
12342
12264
  * [Api set: Mailbox 1.6]
12343
12265
  *
@@ -12345,22 +12267,6 @@ declare namespace Office {
12345
12267
  *
12346
12268
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee
12347
12269
  *
12348
- * **Important**:
12349
- *
12350
- * - Entity-based contextual Outlook add-ins, including the `getSelectedEntities` method, will be retired in Q2 of 2024. The work to retire this method will
12351
- * start in May and continue until the end of June. After June, contextual add-ins will no longer be able to detect entities in mail items to perform tasks on them.
12352
- * Regular expression rules will continue to be supported after entity-based contextual add-ins are retired. We recommend updating your contextual add-in
12353
- * to use regular expression rules as an alternative solution. For guidance on how to implement these rules, see
12354
- * {@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}.
12355
- * To learn more about the retirement of entity-based contextual Outlook add-ins, see
12356
- * {@link https://devblogs.microsoft.com/microsoft365dev/retirement-of-entity-based-contextual-outlook-add-ins | Retirement of entity-based contextual Outlook add-ins}.
12357
- *
12358
- * - 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},
12359
- * which isn't supported by the {@link https://learn.microsoft.com/office/dev/add-ins/develop/json-manifest-overview | unified manifest for Microsoft 365}.
12360
- *
12361
- * - This method isn't supported in Outlook on iOS or Android. For more information on supported APIs in Outlook mobile, see
12362
- * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
12363
- *
12364
12270
  * @param name - The name of the `ItemHasRegularExpressionMatch` rule element that defines the filter to match.
12365
12271
  */
12366
12272
  getSelectedEntities(): Entities;
@@ -12370,9 +12276,9 @@ declare namespace Office {
12370
12276
  *
12371
12277
  * @returns
12372
12278
  * An object that contains arrays of strings that match the regular expressions defined in the manifest XML file.
12373
- * The name of each array is equal to the corresponding value of the `RegExName` attribute of the matching `ItemHasRegularExpressionMatch` rule or
12374
- * the `FilterName` attribute of the matching `ItemHasKnownEntity` rule. For an `ItemHasRegularExpressionMatch` rule, a matching string has to occur
12375
- * in the property of the item that is specified by that rule. The `PropertyName` simple type defines the supported properties.
12279
+ * The name of each array is equal to the corresponding value of the `RegExName` attribute of the matching `ItemHasRegularExpressionMatch` rule.
12280
+ * For an `ItemHasRegularExpressionMatch` rule, a matching string has to occur in the property of the item that's specified by that rule.
12281
+ * The `PropertyName` simple type defines the supported properties.
12376
12282
  *
12377
12283
  * @remarks
12378
12284
  * [Api set: Mailbox 1.6]
@@ -12383,12 +12289,10 @@ declare namespace Office {
12383
12289
  *
12384
12290
  * **Important**:
12385
12291
  *
12386
- * - 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
12387
- * entities in mail items to perform tasks on them. Regular expression rules will continue to be supported after entity-based contextual add-ins are retired.
12388
- * We recommend updating your contextual add-in to use regular expression rules as an alternative solution. For guidance on how to implement these rules, see
12389
- * {@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}.
12390
- * To learn more about the retirement of entity-based contextual add-ins, see
12391
- * {@link https://devblogs.microsoft.com/microsoft365dev/retirement-of-entity-based-contextual-outlook-add-ins | Retirement of entity-based contextual Outlook add-ins}.
12292
+ * - Entity-based contextual Outlook add-ins are now retired. However, regular expression rules are still supported.
12293
+ * We recommend updating your contextual add-in to use regular expression rules as an alternative solution.
12294
+ * For guidance on how to implement these rules, see
12295
+ * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins | Contextual Outlook add-ins}.
12392
12296
  *
12393
12297
  * - 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},
12394
12298
  * which isn't supported by the {@link https://learn.microsoft.com/office/dev/add-ins/develop/json-manifest-overview | unified manifest for Microsoft 365}.
@@ -13425,57 +13329,84 @@ declare namespace Office {
13425
13329
  * The list of contacts extracted from the body of an email message or appointment is returned in the `contacts` property of the
13426
13330
  * {@link Office.Entities | Entities} object returned by the `getEntities` or `getEntitiesByType` method of the current item.
13427
13331
  *
13332
+ * **Warning**: Entity-based contextual Outlook add-ins are now retired. However, regular expression rules are still supported.
13333
+ * We recommend updating your contextual add-in to use regular expression rules as an alternative solution.
13334
+ * For guidance on how to implement these rules, see
13335
+ * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins | Contextual Outlook add-ins}.
13336
+ *
13337
+ * @deprecated Use {@link https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins | regular expression rules} instead.
13338
+ *
13428
13339
  * @remarks
13429
13340
  *
13430
13341
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **restricted**
13431
13342
  *
13432
13343
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Read
13433
- *
13434
- * **Important**: Entity-based contextual Outlook add-ins will be retired in Q2 of 2024. The work to retire this feature will start in May and continue
13435
- * until the end of June. After June, contextual add-ins will no longer be able to detect entities in mail items to perform tasks on them.
13436
- * The following APIs will also be retired.
13437
- *
13438
- * - `Office.context.mailbox.item.getEntities`
13439
- * - `Office.context.mailbox.item.getEntitiesByType`
13440
- * - `Office.context.mailbox.item.getFilteredEntitiesByName`
13441
- * - `Office.context.mailbox.item.getSelectedEntities`
13442
- *
13443
- * To help minimize potential disruptions, the following will still be supported after entity-based contextual add-ins are retired.
13444
- *
13445
- * - An alternative implementation of the **Join Meeting** button, which is activated by online meeting add-ins, is being developed. Once support for
13446
- * entity-based contextual add-ins ends, online meeting add-ins will automatically transition to the alternative implementation to activate the
13447
- * **Join Meeting** button.
13448
- *
13449
- * - Regular expression rules will continue to be supported after entity-based contextual add-ins are retired. We recommend updating your contextual add-in
13450
- * to use regular expression rules as an alternative solution. For guidance on how to implement these rules, see
13451
- * {@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}.
13452
- *
13453
- * For more information, see
13454
- * {@link https://devblogs.microsoft.com/microsoft365dev/retirement-of-entity-based-contextual-outlook-add-ins | Retirement of entity-based contextual Outlook add-ins}.
13455
13344
  */
13456
13345
  interface Contact {
13457
13346
  /**
13458
13347
  * An array of strings containing the mailing and street addresses associated with the contact. Nullable.
13348
+ *
13349
+ * **Warning**: Entity-based contextual Outlook add-ins are now retired. However, regular expression rules are still supported.
13350
+ * We recommend updating your contextual add-in to use regular expression rules as an alternative solution.
13351
+ * For guidance on how to implement these rules, see
13352
+ * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins | Contextual Outlook add-ins}.
13353
+ *
13354
+ * @deprecated Use {@link https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins | regular expression rules} instead.
13459
13355
  */
13460
13356
  addresses: string[];
13461
13357
  /**
13462
13358
  * A string containing the name of the business associated with the contact. Nullable.
13359
+ *
13360
+ * **Warning**: Entity-based contextual Outlook add-ins are now retired. However, regular expression rules are still supported.
13361
+ * We recommend updating your contextual add-in to use regular expression rules as an alternative solution.
13362
+ * For guidance on how to implement these rules, see
13363
+ * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins | Contextual Outlook add-ins}.
13364
+ *
13365
+ * @deprecated Use {@link https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins | regular expression rules} instead.
13463
13366
  */
13464
13367
  businessName: string;
13465
13368
  /**
13466
13369
  * An array of strings containing the SMTP email addresses associated with the contact. Nullable.
13370
+ *
13371
+ * **Warning**: Entity-based contextual Outlook add-ins are now retired. However, regular expression rules are still supported.
13372
+ * We recommend updating your contextual add-in to use regular expression rules as an alternative solution.
13373
+ * For guidance on how to implement these rules, see
13374
+ * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins | Contextual Outlook add-ins}.
13375
+ *
13376
+ * @deprecated Use {@link https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins | regular expression rules} instead.
13467
13377
  */
13468
13378
  emailAddresses: string[];
13469
13379
  /**
13470
13380
  * A string containing the name of the person associated with the contact. Nullable.
13381
+ *
13382
+ * **Warning**: Entity-based contextual Outlook add-ins are now retired. However, regular expression rules are still supported.
13383
+ * We recommend updating your contextual add-in to use regular expression rules as an alternative solution.
13384
+ * For guidance on how to implement these rules, see
13385
+ * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins | Contextual Outlook add-ins}.
13386
+ *
13387
+ * @deprecated Use {@link https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins | regular expression rules} instead.
13471
13388
  */
13472
13389
  personName: string;
13473
13390
  /**
13474
13391
  * An array containing a `PhoneNumber` object for each phone number associated with the contact. Nullable.
13392
+ *
13393
+ * **Warning**: Entity-based contextual Outlook add-ins are now retired. However, regular expression rules are still supported.
13394
+ * We recommend updating your contextual add-in to use regular expression rules as an alternative solution.
13395
+ * For guidance on how to implement these rules, see
13396
+ * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins | Contextual Outlook add-ins}.
13397
+ *
13398
+ * @deprecated Use {@link https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins | regular expression rules} instead.
13475
13399
  */
13476
13400
  phoneNumbers: PhoneNumber[];
13477
13401
  /**
13478
13402
  * An array of strings containing the Internet URLs associated with the contact. Nullable.
13403
+ *
13404
+ * **Warning**: Entity-based contextual Outlook add-ins are now retired. However, regular expression rules are still supported.
13405
+ * We recommend updating your contextual add-in to use regular expression rules as an alternative solution.
13406
+ * For guidance on how to implement these rules, see
13407
+ * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins | Contextual Outlook add-ins}.
13408
+ *
13409
+ * @deprecated Use {@link https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins | regular expression rules} instead.
13479
13410
  */
13480
13411
  urls: string[];
13481
13412
  }
@@ -14220,61 +14151,95 @@ declare namespace Office {
14220
14151
  * When the property arrays are returned by the `getEntitiesByType` method, only the property for the specified entity contains data;
14221
14152
  * all other properties are null.
14222
14153
  *
14154
+ * **Warning**: Entity-based contextual Outlook add-ins are now retired. However, regular expression rules are still supported.
14155
+ * We recommend updating your contextual add-in to use regular expression rules as an alternative solution.
14156
+ * For guidance on how to implement these rules, see
14157
+ * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins | Contextual Outlook add-ins}.
14158
+ *
14159
+ * @deprecated Use {@link https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins | regular expression rules} instead.
14160
+ *
14223
14161
  * @remarks
14224
14162
  *
14225
14163
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
14226
14164
  *
14227
14165
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Read
14228
- *
14229
- * **Important**: Entity-based contextual Outlook add-ins will be retired in Q2 of 2024. The work to retire this feature will start in May and continue
14230
- * until the end of June. After June, contextual add-ins will no longer be able to detect entities in mail items to perform tasks on them.
14231
- * The following APIs will also be retired.
14232
- *
14233
- * - `Office.context.mailbox.item.getEntities`
14234
- * - `Office.context.mailbox.item.getEntitiesByType`
14235
- * - `Office.context.mailbox.item.getFilteredEntitiesByName`
14236
- * - `Office.context.mailbox.item.getSelectedEntities`
14237
- *
14238
- * To help minimize potential disruptions, the following will still be supported after entity-based contextual add-ins are retired.
14239
- *
14240
- * - An alternative implementation of the **Join Meeting** button, which is activated by online meeting add-ins, is being developed. Once support for
14241
- * entity-based contextual add-ins ends, online meeting add-ins will automatically transition to the alternative implementation to activate the
14242
- * **Join Meeting** button.
14243
- *
14244
- * - Regular expression rules will continue to be supported after entity-based contextual add-ins are retired. We recommend updating your contextual add-in
14245
- * to use regular expression rules as an alternative solution. For guidance on how to implement these rules, see
14246
- * {@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}.
14247
- *
14248
- * For more information, see
14249
- * {@link https://devblogs.microsoft.com/microsoft365dev/retirement-of-entity-based-contextual-outlook-add-ins | Retirement of entity-based contextual Outlook add-ins}.
14250
14166
  */
14251
14167
  interface Entities {
14252
14168
  /**
14253
14169
  * Gets the physical addresses (street or mailing addresses) found in an email message or appointment.
14170
+ *
14171
+ * **Warning**: Entity-based contextual Outlook add-ins are now retired. However, regular expression rules are still supported.
14172
+ * We recommend updating your contextual add-in to use regular expression rules as an alternative solution.
14173
+ * For guidance on how to implement these rules, see
14174
+ * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins | Contextual Outlook add-ins}.
14175
+ *
14176
+ * @deprecated Use {@link https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins | regular expression rules} instead.
14254
14177
  */
14255
14178
  addresses: string[];
14256
14179
  /**
14257
14180
  * Gets the contacts found in an email address or appointment.
14181
+ *
14182
+ * **Warning**: Entity-based contextual Outlook add-ins are now retired. However, regular expression rules are still supported.
14183
+ * We recommend updating your contextual add-in to use regular expression rules as an alternative solution.
14184
+ * For guidance on how to implement these rules, see
14185
+ * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins | Contextual Outlook add-ins}.
14186
+ *
14187
+ * @deprecated Use {@link https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins | regular expression rules} instead.
14258
14188
  */
14259
14189
  contacts: Contact[];
14260
14190
  /**
14261
14191
  * Gets the email addresses found in an email message or appointment.
14192
+ *
14193
+ * **Warning**: Entity-based contextual Outlook add-ins are now retired. However, regular expression rules are still supported.
14194
+ * We recommend updating your contextual add-in to use regular expression rules as an alternative solution.
14195
+ * For guidance on how to implement these rules, see
14196
+ * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins | Contextual Outlook add-ins}.
14197
+ *
14198
+ * @deprecated Use {@link https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins | regular expression rules} instead.
14262
14199
  */
14263
14200
  emailAddresses: string[];
14264
14201
  /**
14265
14202
  * Gets the meeting suggestions found in an email message.
14203
+ *
14204
+ * **Warning**: Entity-based contextual Outlook add-ins are now retired. However, regular expression rules are still supported.
14205
+ * We recommend updating your contextual add-in to use regular expression rules as an alternative solution.
14206
+ * For guidance on how to implement these rules, see
14207
+ * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins | Contextual Outlook add-ins}.
14208
+ *
14209
+ * @deprecated Use {@link https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins | regular expression rules} instead.
14266
14210
  */
14267
14211
  meetingSuggestions: MeetingSuggestion[];
14268
14212
  /**
14269
14213
  * Gets the phone numbers found in an email message or appointment.
14214
+ *
14215
+ * **Warning**: Entity-based contextual Outlook add-ins are now retired. However, regular expression rules are still supported.
14216
+ * We recommend updating your contextual add-in to use regular expression rules as an alternative solution.
14217
+ * For guidance on how to implement these rules, see
14218
+ * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins | Contextual Outlook add-ins}.
14219
+ *
14220
+ * @deprecated Use {@link https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins | regular expression rules} instead.
14270
14221
  */
14271
14222
  phoneNumbers: PhoneNumber[];
14272
14223
  /**
14273
14224
  * Gets the task suggestions found in an email message or appointment.
14225
+ *
14226
+ * **Warning**: Entity-based contextual Outlook add-ins are now retired. However, regular expression rules are still supported.
14227
+ * We recommend updating your contextual add-in to use regular expression rules as an alternative solution.
14228
+ * For guidance on how to implement these rules, see
14229
+ * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins | Contextual Outlook add-ins}.
14230
+ *
14231
+ * @deprecated Use {@link https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins | regular expression rules} instead.
14274
14232
  */
14275
14233
  taskSuggestions: string[];
14276
14234
  /**
14277
14235
  * Gets the Internet URLs present in an email message or appointment.
14236
+ *
14237
+ * **Warning**: Entity-based contextual Outlook add-ins are now retired. However, regular expression rules are still supported.
14238
+ * We recommend updating your contextual add-in to use regular expression rules as an alternative solution.
14239
+ * For guidance on how to implement these rules, see
14240
+ * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins | Contextual Outlook add-ins}.
14241
+ *
14242
+ * @deprecated Use {@link https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins | regular expression rules} instead.
14278
14243
  */
14279
14244
  urls: string[];
14280
14245
  }
@@ -15993,63 +15958,90 @@ declare namespace Office {
15993
15958
  /**
15994
15959
  * Represents a suggested meeting found in an item. Read mode only.
15995
15960
  *
15996
- * The list of meetings suggested in an email message is returned in the `meetingSuggestions` property of the `Entities` object that is returned when
15961
+ * The list of meetings suggested in an email message is returned in the `meetingSuggestions` property of the `Entities` object that's returned when
15997
15962
  * the `getEntities` or `getEntitiesByType` method is called on the active item.
15998
15963
  *
15999
15964
  * The start and end values are string representations of a `Date` object that contains the date and time at which the suggested meeting is to
16000
15965
  * begin and end. The values are in the default time zone specified for the current user.
16001
15966
  *
15967
+ * **Warning**: Entity-based contextual Outlook add-ins are now retired. However, regular expression rules are still supported.
15968
+ * We recommend updating your contextual add-in to use regular expression rules as an alternative solution.
15969
+ * For guidance on how to implement these rules, see
15970
+ * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins | Contextual Outlook add-ins}.
15971
+ *
15972
+ * @deprecated Use {@link https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins | regular expression rules} instead.
15973
+ *
16002
15974
  * @remarks
16003
15975
  *
16004
15976
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
16005
15977
  *
16006
15978
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Read
16007
- *
16008
- * **Important**: Entity-based contextual Outlook add-ins will be retired in Q2 of 2024. The work to retire this feature will start in May and continue
16009
- * until the end of June. After June, contextual add-ins will no longer be able to detect entities in mail items to perform tasks on them.
16010
- * The following APIs will also be retired.
16011
- *
16012
- * - `Office.context.mailbox.item.getEntities`
16013
- * - `Office.context.mailbox.item.getEntitiesByType`
16014
- * - `Office.context.mailbox.item.getFilteredEntitiesByName`
16015
- * - `Office.context.mailbox.item.getSelectedEntities`
16016
- *
16017
- * To help minimize potential disruptions, the following will still be supported after entity-based contextual add-ins are retired.
16018
- *
16019
- * - An alternative implementation of the **Join Meeting** button, which is activated by online meeting add-ins, is being developed. Once support for
16020
- * entity-based contextual add-ins ends, online meeting add-ins will automatically transition to the alternative implementation to activate the
16021
- * **Join Meeting** button.
16022
- *
16023
- * - Regular expression rules will continue to be supported after entity-based contextual add-ins are retired. We recommend updating your contextual add-in
16024
- * to use regular expression rules as an alternative solution. For guidance on how to implement these rules, see
16025
- * {@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}.
16026
- *
16027
- * For more information, see
16028
- * {@link https://devblogs.microsoft.com/microsoft365dev/retirement-of-entity-based-contextual-outlook-add-ins | Retirement of entity-based contextual Outlook add-ins}.
16029
15979
  */
16030
15980
  interface MeetingSuggestion {
16031
15981
  /**
16032
15982
  * Gets the attendees for a suggested meeting.
15983
+ *
15984
+ * **Warning**: Entity-based contextual Outlook add-ins are now retired. However, regular expression rules are still supported.
15985
+ * We recommend updating your contextual add-in to use regular expression rules as an alternative solution.
15986
+ * For guidance on how to implement these rules, see
15987
+ * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins | Contextual Outlook add-ins}.
15988
+ *
15989
+ * @deprecated Use {@link https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins | regular expression rules} instead.
16033
15990
  */
16034
15991
  attendees: EmailUser[];
16035
15992
  /**
16036
15993
  * Gets the date and time that a suggested meeting is to end.
15994
+ *
15995
+ * **Warning**: Entity-based contextual Outlook add-ins are now retired. However, regular expression rules are still supported.
15996
+ * We recommend updating your contextual add-in to use regular expression rules as an alternative solution.
15997
+ * For guidance on how to implement these rules, see
15998
+ * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins | Contextual Outlook add-ins}.
15999
+ *
16000
+ * @deprecated Use {@link https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins | regular expression rules} instead.
16037
16001
  */
16038
16002
  end: string;
16039
16003
  /**
16040
16004
  * Gets the location of a suggested meeting.
16005
+ *
16006
+ * **Warning**: Entity-based contextual Outlook add-ins are now retired. However, regular expression rules are still supported.
16007
+ * We recommend updating your contextual add-in to use regular expression rules as an alternative solution.
16008
+ * For guidance on how to implement these rules, see
16009
+ * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins | Contextual Outlook add-ins}.
16010
+ *
16011
+ * @deprecated Use {@link https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins | regular expression rules} instead.
16041
16012
  */
16042
16013
  location: string;
16043
16014
  /**
16044
16015
  * Gets a string that was identified as a meeting suggestion.
16016
+ *
16017
+ * **Warning**: Entity-based contextual Outlook add-ins are now retired. However, regular expression rules are still supported.
16018
+ * We recommend updating your contextual add-in to use regular expression rules as an alternative solution.
16019
+ * For guidance on how to implement these rules, see
16020
+ * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins | Contextual Outlook add-ins}.
16021
+ *
16022
+ * @deprecated Use {@link https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins | regular expression rules} instead.
16045
16023
  */
16046
16024
  meetingString: string;
16047
16025
  /**
16048
16026
  * Gets the date and time that a suggested meeting is to begin.
16027
+ *
16028
+ * **Warning**: Entity-based contextual Outlook add-ins are now retired. However, regular expression rules are still supported.
16029
+ * We recommend updating your contextual add-in to use regular expression rules as an alternative solution.
16030
+ * For guidance on how to implement these rules, see
16031
+ * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins | Contextual Outlook add-ins}.
16032
+ *
16033
+ * @deprecated Use {@link https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins | regular expression rules} instead.
16049
16034
  */
16050
16035
  start: string;
16051
16036
  /**
16052
16037
  * Gets the subject of a suggested meeting.
16038
+ *
16039
+ * **Warning**: Entity-based contextual Outlook add-ins are now retired. However, regular expression rules are still supported.
16040
+ * We recommend updating your contextual add-in to use regular expression rules as an alternative solution.
16041
+ * For guidance on how to implement these rules, see
16042
+ * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins | Contextual Outlook add-ins}.
16043
+ *
16044
+ * @deprecated Use {@link https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins | regular expression rules} instead.
16053
16045
  */
16054
16046
  subject: string;
16055
16047
  }
@@ -18261,30 +18253,31 @@ declare namespace Office {
18261
18253
  /**
18262
18254
  * Gets the entities found in the selected item's body.
18263
18255
  *
18256
+ * **Warning**: Entity-based contextual Outlook add-ins are now retired. However, regular expression rules are still supported.
18257
+ * We recommend updating your contextual add-in to use regular expression rules as an alternative solution.
18258
+ * For guidance on how to implement these rules, see
18259
+ * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins | Contextual Outlook add-ins}.
18260
+ *
18261
+ * @deprecated Use {@link https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins | regular expression rules} instead.
18262
+ *
18264
18263
  * @remarks
18265
18264
  * [Api set: Mailbox 1.1]
18266
18265
  *
18267
18266
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
18268
18267
  *
18269
18268
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee
18270
- *
18271
- * **Important**:
18272
- *
18273
- * - Entity-based contextual Outlook add-ins, including the `getEntities` method, will be retired in Q2 of 2024. The work to retire this method will
18274
- * start in May and continue until the end of June. After June, contextual add-ins will no longer be able to detect entities in mail items to perform tasks on them.
18275
- * Regular expression rules will continue to be supported after entity-based contextual add-ins are retired. We recommend updating your contextual add-in
18276
- * to use regular expression rules as an alternative solution. For guidance on how to implement these rules, see
18277
- * {@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}.
18278
- * To learn more about the retirement of entity-based contextual Outlook add-ins, see
18279
- * {@link https://devblogs.microsoft.com/microsoft365dev/retirement-of-entity-based-contextual-outlook-add-ins | Retirement of entity-based contextual Outlook add-ins}.
18280
- *
18281
- * - This method isn't supported in Outlook on Android or on iOS. For more information on supported APIs in Outlook mobile, see
18282
- * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
18283
18269
  */
18284
18270
  getEntities(): Entities;
18285
18271
  /**
18286
18272
  * Gets an array of all the entities of the specified entity type found in the selected item's body.
18287
18273
  *
18274
+ * **Warning**: Entity-based contextual Outlook add-ins are now retired. However, regular expression rules are still supported.
18275
+ * We recommend updating your contextual add-in to use regular expression rules as an alternative solution.
18276
+ * For guidance on how to implement these rules, see
18277
+ * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins | Contextual Outlook add-ins}.
18278
+ *
18279
+ * @deprecated Use {@link https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins | regular expression rules} instead.
18280
+ *
18288
18281
  * @returns
18289
18282
  * If the value passed in `entityType` is not a valid member of the `EntityType` enumeration, the method returns `null`.
18290
18283
  * If no entities of the specified type are present in the item's body, the method returns an empty array.
@@ -18297,71 +18290,19 @@ declare namespace Office {
18297
18290
  *
18298
18291
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read
18299
18292
  *
18300
- * **Important**:
18301
- *
18302
- * - Entity-based contextual Outlook add-ins, including the `getEntitiesByType` method, will be retired in Q2 of 2024. The work to retire this method will
18303
- * start in May and continue until the end of June. After June, contextual add-ins will no longer be able to detect entities in mail items to perform tasks on them.
18304
- * Regular expression rules will continue to be supported after entity-based contextual add-ins are retired. We recommend updating your contextual add-in
18305
- * to use regular expression rules as an alternative solution. For guidance on how to implement these rules, see
18306
- * {@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}.
18307
- * To learn more about the retirement of entity-based contextual Outlook add-ins, see
18308
- * {@link https://devblogs.microsoft.com/microsoft365dev/retirement-of-entity-based-contextual-outlook-add-ins | Retirement of entity-based contextual Outlook add-ins}.
18309
- *
18310
- * - This method isn't supported in Outlook on Android or on iOS. For more information on supported APIs in Outlook mobile, see
18311
- * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
18312
- *
18313
18293
  * @param entityType - One of the `EntityType` enumeration values.
18314
- *
18315
- * While the minimum permission level to use this method is **restricted**, some entity types require **read item** to access, as specified in the
18316
- * following table.
18317
- *
18318
- * <table>
18319
- * <tr>
18320
- * <th>Value of entityType</th>
18321
- * <th>Type of objects in returned array</th>
18322
- * <th>Required permission level</th>
18323
- * </tr>
18324
- * <tr>
18325
- * <td>Address</td>
18326
- * <td>String</td>
18327
- * <td>Restricted</td>
18328
- * </tr>
18329
- * <tr>
18330
- * <td>Contact</td>
18331
- * <td>Contact</td>
18332
- * <td>ReadItem</td>
18333
- * </tr>
18334
- * <tr>
18335
- * <td>EmailAddress</td>
18336
- * <td>String</td>
18337
- * <td>ReadItem</td>
18338
- * </tr>
18339
- * <tr>
18340
- * <td>MeetingSuggestion</td>
18341
- * <td>MeetingSuggestion</td>
18342
- * <td>ReadItem</td>
18343
- * </tr>
18344
- * <tr>
18345
- * <td>PhoneNumber</td>
18346
- * <td>PhoneNumber</td>
18347
- * <td>Restricted</td>
18348
- * </tr>
18349
- * <tr>
18350
- * <td>TaskSuggestion</td>
18351
- * <td>TaskSuggestion</td>
18352
- * <td>ReadItem</td>
18353
- * </tr>
18354
- * <tr>
18355
- * <td>URL</td>
18356
- * <td>String</td>
18357
- * <td>Restricted</td>
18358
- * </tr>
18359
- * </table>
18360
18294
  */
18361
18295
  getEntitiesByType(entityType: MailboxEnums.EntityType | string): Array<string | Contact | MeetingSuggestion | PhoneNumber | TaskSuggestion>;
18362
18296
  /**
18363
18297
  * Returns well-known entities in the selected item that pass the named filter defined in an XML manifest file.
18364
18298
  *
18299
+ * **Warning**: Entity-based contextual Outlook add-ins are now retired. However, regular expression rules are still supported.
18300
+ * We recommend updating your contextual add-in to use regular expression rules as an alternative solution.
18301
+ * For guidance on how to implement these rules, see
18302
+ * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins | Contextual Outlook add-ins}.
18303
+ *
18304
+ * @deprecated Use {@link https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins | regular expression rules} instead.
18305
+ *
18365
18306
  * @returns
18366
18307
  * The entities that match the regular expression defined in the `ItemHasKnownEntity` rule element in the
18367
18308
  * manifest XML file with the specified `FilterName` element value. If there's no `ItemHasKnownEntity` element in the manifest with a
@@ -18375,22 +18316,6 @@ declare namespace Office {
18375
18316
  *
18376
18317
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee
18377
18318
  *
18378
- * **Important**:
18379
- *
18380
- * - Entity-based contextual Outlook add-ins, including the `getFilteredEntitiesByName` method, will be retired in Q2 of 2024. The work to retire this method will
18381
- * start in May and continue until the end of June. After June, contextual add-ins will no longer be able to detect entities in mail items to perform tasks on them.
18382
- * Regular expression rules will continue to be supported after entity-based contextual add-ins are retired. We recommend updating your contextual add-in
18383
- * to use regular expression rules as an alternative solution. For guidance on how to implement these rules, see
18384
- * {@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}.
18385
- * To learn more about the retirement of entity-based contextual Outlook add-ins, see
18386
- * {@link https://devblogs.microsoft.com/microsoft365dev/retirement-of-entity-based-contextual-outlook-add-ins | Retirement of entity-based contextual Outlook add-ins}.
18387
- *
18388
- * - 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},
18389
- * which isn't supported by the {@link https://learn.microsoft.com/office/dev/add-ins/develop/json-manifest-overview | unified manifest for Microsoft 365}.
18390
- *
18391
- * - This method isn't supported in Outlook on Android or on iOS. For more information on supported APIs in Outlook mobile, see
18392
- * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
18393
- *
18394
18319
  * @param name - The name of the `ItemHasKnownEntity` rule element that defines the filter to match.
18395
18320
  */
18396
18321
  getFilteredEntitiesByName(name: string): Array<string | Contact | MeetingSuggestion | PhoneNumber | TaskSuggestion>;
@@ -18433,9 +18358,9 @@ declare namespace Office {
18433
18358
  *
18434
18359
  * @returns
18435
18360
  * An object that contains arrays of strings that match the regular expressions defined in the manifest XML file.
18436
- * The name of each array is equal to the corresponding value of the RegExName attribute of the matching `ItemHasRegularExpressionMatch` rule
18437
- * or the `FilterName` attribute of the matching `ItemHasKnownEntity` rule. For an `ItemHasRegularExpressionMatch` rule, a matching string has to occur in the property
18438
- * of the item that is specified by that rule. The `PropertyName` simple type defines the supported properties.
18361
+ * The name of each array is equal to the corresponding value of the RegExName attribute of the matching `ItemHasRegularExpressionMatch` rule.
18362
+ * For an `ItemHasRegularExpressionMatch` rule, a matching string has to occur in the property
18363
+ * of the item that's specified by that rule. The `PropertyName` simple type defines the supported properties.
18439
18364
  *
18440
18365
  * @remarks
18441
18366
  * [Api set: Mailbox 1.1]
@@ -18446,12 +18371,10 @@ declare namespace Office {
18446
18371
  *
18447
18372
  * **Important**:
18448
18373
  *
18449
- * - 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
18450
- * entities in mail items to perform tasks on them. Regular expression rules will continue to be supported after entity-based contextual add-ins are retired.
18451
- * We recommend updating your contextual add-in to use regular expression rules as an alternative solution. For guidance on how to implement these rules, see
18452
- * {@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}.
18453
- * To learn more about the retirement of entity-based contextual add-ins, see
18454
- * {@link https://devblogs.microsoft.com/microsoft365dev/retirement-of-entity-based-contextual-outlook-add-ins | Retirement of entity-based contextual Outlook add-ins}.
18374
+ * - Entity-based contextual Outlook add-ins are now retired. However, regular expression rules are still supported.
18375
+ * We recommend updating your contextual add-in to use regular expression rules as an alternative solution.
18376
+ * For guidance on how to implement these rules, see
18377
+ * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins | Contextual Outlook add-ins}.
18455
18378
  *
18456
18379
  * - 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},
18457
18380
  * which isn't supported by the {@link https://learn.microsoft.com/office/dev/add-ins/develop/json-manifest-overview | unified manifest for Microsoft 365}.
@@ -18480,12 +18403,10 @@ declare namespace Office {
18480
18403
  *
18481
18404
  * **Important**:
18482
18405
  *
18483
- * - 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
18484
- * entities in mail items to perform tasks on them. Regular expression rules will continue to be supported after entity-based contextual add-ins are retired.
18485
- * We recommend updating your contextual add-in to use regular expression rules as an alternative solution. For guidance on how to implement these rules, see
18486
- * {@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}.
18487
- * To learn more about the retirement of entity-based contextual add-ins, see
18488
- * {@link https://devblogs.microsoft.com/microsoft365dev/retirement-of-entity-based-contextual-outlook-add-ins | Retirement of entity-based contextual Outlook add-ins}.
18406
+ * - Entity-based contextual Outlook add-ins are now retired. However, regular expression rules are still supported.
18407
+ * We recommend updating your contextual add-in to use regular expression rules as an alternative solution.
18408
+ * For guidance on how to implement these rules, see
18409
+ * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins | Contextual Outlook add-ins}.
18489
18410
  *
18490
18411
  * - 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},
18491
18412
  * which isn't supported by the {@link https://learn.microsoft.com/office/dev/add-ins/develop/json-manifest-overview | unified manifest for Microsoft 365}.
@@ -18502,11 +18423,13 @@ declare namespace Office {
18502
18423
  getRegExMatchesByName(name: string): string[];
18503
18424
  /**
18504
18425
  * Gets the entities found in a highlighted match a user has selected. Highlighted matches apply to contextual add-ins.
18505
- *
18506
- * **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
18507
- * {@link https://learn.microsoft.com/office/dev/add-ins/develop/unified-manifest-overview | unified manifest for Microsoft 365}.
18508
18426
  *
18509
- * **Note**: This method isn't supported in Outlook on iOS or on Android.
18427
+ * **Warning**: Entity-based contextual Outlook add-ins are now retired. However, regular expression rules are still supported.
18428
+ * We recommend updating your contextual add-in to use regular expression rules as an alternative solution.
18429
+ * For guidance on how to implement these rules, see
18430
+ * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins | Contextual Outlook add-ins}.
18431
+ *
18432
+ * @deprecated Use {@link https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins | regular expression rules} instead.
18510
18433
  *
18511
18434
  * @remarks
18512
18435
  * [Api set: Mailbox 1.6]
@@ -18515,22 +18438,6 @@ declare namespace Office {
18515
18438
  *
18516
18439
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read
18517
18440
  *
18518
- * **Important**:
18519
- *
18520
- * - Entity-based contextual Outlook add-ins, including the `getSelectedEntities` method, will be retired in Q2 of 2024. The work to retire this method will
18521
- * start in May and continue until the end of June. After June, contextual add-ins will no longer be able to detect entities in mail items to perform tasks on them.
18522
- * Regular expression rules will continue to be supported after entity-based contextual add-ins are retired. We recommend updating your contextual add-in
18523
- * to use regular expression rules as an alternative solution. For guidance on how to implement these rules, see
18524
- * {@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}.
18525
- * To learn more about the retirement of entity-based contextual Outlook add-ins, see
18526
- * {@link https://devblogs.microsoft.com/microsoft365dev/retirement-of-entity-based-contextual-outlook-add-ins | Retirement of entity-based contextual Outlook add-ins}.
18527
- *
18528
- * - 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},
18529
- * which isn't supported by the {@link https://learn.microsoft.com/office/dev/add-ins/develop/json-manifest-overview | unified manifest for Microsoft 365}.
18530
- *
18531
- * - This method isn't supported in Outlook on iOS or Android. For more information on supported APIs in Outlook mobile, see
18532
- * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
18533
- *
18534
18441
  * @param name - The name of the `ItemHasRegularExpressionMatch` rule element that defines the filter to match.
18535
18442
  */
18536
18443
  getSelectedEntities(): Entities;
@@ -18540,9 +18447,9 @@ declare namespace Office {
18540
18447
  *
18541
18448
  * @returns
18542
18449
  * An object that contains arrays of strings that match the regular expressions defined in the manifest XML file.
18543
- * The name of each array is equal to the corresponding value of the `RegExName` attribute of the matching `ItemHasRegularExpressionMatch` rule or
18544
- * the `FilterName` attribute of the matching `ItemHasKnownEntity` rule. For an `ItemHasRegularExpressionMatch` rule, a matching string has to occur
18545
- * in the property of the item that is specified by that rule. The `PropertyName` simple type defines the supported properties.
18450
+ * The name of each array is equal to the corresponding value of the `RegExName` attribute of the matching `ItemHasRegularExpressionMatch` rule.
18451
+ * For an `ItemHasRegularExpressionMatch` rule, a matching string has to occur in the property of the item that's specified by that rule.
18452
+ * The `PropertyName` simple type defines the supported properties.
18546
18453
  *
18547
18454
  * @remarks
18548
18455
  * [Api set: Mailbox 1.6]
@@ -18553,12 +18460,10 @@ declare namespace Office {
18553
18460
  *
18554
18461
  * **Important**:
18555
18462
  *
18556
- * - 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
18557
- * entities in mail items to perform tasks on them. Regular expression rules will continue to be supported after entity-based contextual add-ins are retired.
18558
- * We recommend updating your contextual add-in to use regular expression rules as an alternative solution. For guidance on how to implement these rules, see
18559
- * {@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}.
18560
- * To learn more about the retirement of entity-based contextual add-ins, see
18561
- * {@link https://devblogs.microsoft.com/microsoft365dev/retirement-of-entity-based-contextual-outlook-add-ins | Retirement of entity-based contextual Outlook add-ins}.
18463
+ * - Entity-based contextual Outlook add-ins are now retired. However, regular expression rules are still supported.
18464
+ * We recommend updating your contextual add-in to use regular expression rules as an alternative solution.
18465
+ * For guidance on how to implement these rules, see
18466
+ * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins | Contextual Outlook add-ins}.
18562
18467
  *
18563
18468
  * - 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},
18564
18469
  * which isn't supported by the {@link https://learn.microsoft.com/office/dev/add-ins/develop/json-manifest-overview | unified manifest for Microsoft 365}.
@@ -19122,48 +19027,54 @@ declare namespace Office {
19122
19027
  * Represents a phone number identified in an item. Read mode only.
19123
19028
  *
19124
19029
  * An array of `PhoneNumber` objects containing the phone numbers found in an email message is returned in the `phoneNumbers` property of the
19125
- * `Entities` object that is returned when you call the `getEntities` method on the selected item.
19030
+ * `Entities` object that's returned when you call the `getEntities` method on the selected item.
19031
+ *
19032
+ * **Warning**: Entity-based contextual Outlook add-ins are now retired. However, regular expression rules are still supported.
19033
+ * We recommend updating your contextual add-in to use regular expression rules as an alternative solution.
19034
+ * For guidance on how to implement these rules, see
19035
+ * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins | Contextual Outlook add-ins}.
19036
+ *
19037
+ * @deprecated Use {@link https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins | regular expression rules} instead.
19126
19038
  *
19127
19039
  * @remarks
19128
19040
  *
19129
19041
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
19130
19042
  *
19131
19043
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Read
19132
- *
19133
- * **Important**: Entity-based contextual Outlook add-ins will be retired in Q2 of 2024. The work to retire this feature will start in May and continue
19134
- * until the end of June. After June, contextual add-ins will no longer be able to detect entities in mail items to perform tasks on them.
19135
- * The following APIs will also be retired.
19136
- *
19137
- * - `Office.context.mailbox.item.getEntities`
19138
- * - `Office.context.mailbox.item.getEntitiesByType`
19139
- * - `Office.context.mailbox.item.getFilteredEntitiesByName`
19140
- * - `Office.context.mailbox.item.getSelectedEntities`
19141
- *
19142
- * To help minimize potential disruptions, the following will still be supported after entity-based contextual add-ins are retired.
19143
- *
19144
- * - An alternative implementation of the **Join Meeting** button, which is activated by online meeting add-ins, is being developed. Once support for
19145
- * entity-based contextual add-ins ends, online meeting add-ins will automatically transition to the alternative implementation to activate the
19146
- * **Join Meeting** button.
19147
- *
19148
- * - Regular expression rules will continue to be supported after entity-based contextual add-ins are retired. We recommend updating your contextual add-in
19149
- * to use regular expression rules as an alternative solution. For guidance on how to implement these rules, see
19150
- * {@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}.
19151
- *
19152
- * For more information, see
19153
- * {@link https://devblogs.microsoft.com/microsoft365dev/retirement-of-entity-based-contextual-outlook-add-ins | Retirement of entity-based contextual Outlook add-ins}.
19154
19044
  */
19155
19045
  interface PhoneNumber {
19156
19046
  /**
19157
19047
  * Gets a string containing a phone number. This string contains only the digits of the telephone number and excludes characters
19158
19048
  * like parentheses and hyphens, if they exist in the original item.
19049
+ *
19050
+ * **Warning**: Entity-based contextual Outlook add-ins are now retired. However, regular expression rules are still supported.
19051
+ * We recommend updating your contextual add-in to use regular expression rules as an alternative solution.
19052
+ * For guidance on how to implement these rules, see
19053
+ * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins | Contextual Outlook add-ins}.
19054
+ *
19055
+ * @deprecated Use {@link https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins | regular expression rules} instead.
19159
19056
  */
19160
19057
  phoneString: string;
19161
19058
  /**
19162
19059
  * Gets the text that was identified in an item as a phone number.
19060
+ *
19061
+ * **Warning**: Entity-based contextual Outlook add-ins are now retired. However, regular expression rules are still supported.
19062
+ * We recommend updating your contextual add-in to use regular expression rules as an alternative solution.
19063
+ * For guidance on how to implement these rules, see
19064
+ * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins | Contextual Outlook add-ins}.
19065
+ *
19066
+ * @deprecated Use {@link https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins | regular expression rules} instead.
19163
19067
  */
19164
19068
  originalPhoneString: string;
19165
19069
  /**
19166
19070
  * Gets a string that identifies the type of phone number: Home, Work, Mobile, Unspecified.
19071
+ *
19072
+ * **Warning**: Entity-based contextual Outlook add-ins are now retired. However, regular expression rules are still supported.
19073
+ * We recommend updating your contextual add-in to use regular expression rules as an alternative solution.
19074
+ * For guidance on how to implement these rules, see
19075
+ * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins | Contextual Outlook add-ins}.
19076
+ *
19077
+ * @deprecated Use {@link https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins | regular expression rules} instead.
19167
19078
  */
19168
19079
  type: string;
19169
19080
  }
@@ -21141,7 +21052,14 @@ declare namespace Office {
21141
21052
  * Represents a suggested task identified in an item. Read mode only.
21142
21053
  *
21143
21054
  * The list of tasks suggested in an email message is returned in the `taskSuggestions` property of the {@link Office.Entities | Entities} object
21144
- * that is returned when the `getEntities` or `getEntitiesByType` method is called on the active item.
21055
+ * that's returned when the `getEntities` or `getEntitiesByType` method is called on the active item.
21056
+ *
21057
+ * **Warning**: Entity-based contextual Outlook add-ins are now retired. However, regular expression rules are still supported.
21058
+ * We recommend updating your contextual add-in to use regular expression rules as an alternative solution.
21059
+ * For guidance on how to implement these rules, see
21060
+ * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins | Contextual Outlook add-ins}.
21061
+ *
21062
+ * @deprecated Use {@link https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins | regular expression rules} instead.
21145
21063
  *
21146
21064
  * @remarks
21147
21065
  *
@@ -21152,10 +21070,24 @@ declare namespace Office {
21152
21070
  interface TaskSuggestion {
21153
21071
  /**
21154
21072
  * Gets the users that should be assigned a suggested task.
21073
+ *
21074
+ * **Warning**: Entity-based contextual Outlook add-ins are now retired. However, regular expression rules are still supported.
21075
+ * We recommend updating your contextual add-in to use regular expression rules as an alternative solution.
21076
+ * For guidance on how to implement these rules, see
21077
+ * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins | Contextual Outlook add-ins}.
21078
+ *
21079
+ * @deprecated Use {@link https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins | regular expression rules} instead.
21155
21080
  */
21156
21081
  assignees: EmailUser[];
21157
21082
  /**
21158
21083
  * Gets the text of an item that was identified as a task suggestion.
21084
+ *
21085
+ * **Warning**: Entity-based contextual Outlook add-ins are now retired. However, regular expression rules are still supported.
21086
+ * We recommend updating your contextual add-in to use regular expression rules as an alternative solution.
21087
+ * For guidance on how to implement these rules, see
21088
+ * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins | Contextual Outlook add-ins}.
21089
+ *
21090
+ * @deprecated Use {@link https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins | regular expression rules} instead.
21159
21091
  */
21160
21092
  taskString: string;
21161
21093
  }
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@types/office-js-preview",
3
- "version": "1.0.485",
3
+ "version": "1.0.486",
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,7 +45,7 @@
45
45
  },
46
46
  "scripts": {},
47
47
  "dependencies": {},
48
- "typesPublisherContentHash": "f6ec1011499e323b1dbfac6499c6e49ac1a67385c3b879be69f6f87ba7b7a00a",
48
+ "typesPublisherContentHash": "fd6a9fdf302f93bb3ea5190802f0436fd3586db2768d8e91a2dd3648ea6414f3",
49
49
  "typeScriptVersion": "4.8",
50
50
  "nonNpm": true
51
51
  }