@types/office-js 1.0.401 → 1.0.403
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- office-js/README.md +1 -1
- office-js/index.d.ts +308 -354
- office-js/package.json +2 -2
office-js/README.md
CHANGED
|
@@ -8,7 +8,7 @@ This package contains type definitions for office-js (https://github.com/OfficeD
|
|
|
8
8
|
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-js.
|
|
9
9
|
|
|
10
10
|
### Additional Details
|
|
11
|
-
* Last updated: Wed,
|
|
11
|
+
* Last updated: Wed, 17 Jul 2024 22:36:40 GMT
|
|
12
12
|
* Dependencies: none
|
|
13
13
|
|
|
14
14
|
# Credits
|
office-js/index.d.ts
CHANGED
|
@@ -8004,7 +8004,7 @@ declare namespace Office {
|
|
|
8004
8004
|
* </table>
|
|
8005
8005
|
*
|
|
8006
8006
|
* The `format:` property specifies values that correspond to a subset of the settings available in the Format Cells dialog box in Excel
|
|
8007
|
-
* (
|
|
8007
|
+
* (Open the context menu (right-click or select and hold) then select **Format Cells**, or **Home** \> **Format** \> **Format Cells**).
|
|
8008
8008
|
*
|
|
8009
8009
|
* @param cellReference An object literal containing name-value pairs that specify the range of cells to get formatting from.
|
|
8010
8010
|
* @param formats An array specifying the format properties to get.
|
|
@@ -8058,7 +8058,7 @@ declare namespace Office {
|
|
|
8058
8058
|
* </table>
|
|
8059
8059
|
*
|
|
8060
8060
|
* The `format:` property specifies values that correspond to a subset of the settings available in the Format Cells dialog box in Excel
|
|
8061
|
-
* (
|
|
8061
|
+
* (Open the context menu (right-click or select and hold) then select **Format Cells**, or **Home** \> **Format** \> **Format Cells**).
|
|
8062
8062
|
*
|
|
8063
8063
|
* @param cellReference An object literal containing name-value pairs that specify the range of cells to get formatting from.
|
|
8064
8064
|
* @param formats An array specifying the format properties to get.
|
|
@@ -8115,7 +8115,7 @@ declare namespace Office {
|
|
|
8115
8115
|
* </table>
|
|
8116
8116
|
*
|
|
8117
8117
|
* The `format:` property specifies values that correspond to a subset of the settings available in the Format Cells dialog box in Excel
|
|
8118
|
-
* (
|
|
8118
|
+
* (Open the context menu (right-click or select and hold) then select **Format Cells**, or **Home** \> **Format** \> **Format Cells**).
|
|
8119
8119
|
*
|
|
8120
8120
|
* You specify the value of the `format:` property as a list of one or more property name - value pairs in a JavaScript object literal. The
|
|
8121
8121
|
* property name specifies the name of the formatting property to set, and value specifies the property value.
|
|
@@ -8214,7 +8214,7 @@ declare namespace Office {
|
|
|
8214
8214
|
* </table>
|
|
8215
8215
|
*
|
|
8216
8216
|
* The `format:` property specifies values that correspond to a subset of the settings available in the Format Cells dialog box in Excel
|
|
8217
|
-
* (
|
|
8217
|
+
* (Open the context menu (right-click or select and hold) then select **Format Cells**, or **Home** \> **Format** \> **Format Cells**).
|
|
8218
8218
|
*
|
|
8219
8219
|
* You specify the value of the `format:` property as a list of one or more property name - value pairs in a JavaScript object literal. The
|
|
8220
8220
|
* property name specifies the name of the formatting property to set, and value specifies the property value.
|
|
@@ -9088,31 +9088,16 @@ declare namespace Office {
|
|
|
9088
9088
|
/**
|
|
9089
9089
|
* Specifies an entity's type.
|
|
9090
9090
|
*
|
|
9091
|
-
*
|
|
9092
|
-
*
|
|
9093
|
-
*
|
|
9094
|
-
*
|
|
9095
|
-
* **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
|
|
9096
|
-
* 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.
|
|
9097
|
-
* The following APIs will also be retired.
|
|
9091
|
+
* **Warning**: Entity-based contextual Outlook add-ins are now retired. However, regular expression rules are still supported.
|
|
9092
|
+
* We recommend updating your contextual add-in to use regular expression rules as an alternative solution.
|
|
9093
|
+
* For guidance on how to implement these rules, see
|
|
9094
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins | Contextual Outlook add-ins}.
|
|
9098
9095
|
*
|
|
9099
|
-
*
|
|
9100
|
-
* - `Office.context.mailbox.item.getEntitiesByType`
|
|
9101
|
-
* - `Office.context.mailbox.item.getFilteredEntitiesByName`
|
|
9102
|
-
* - `Office.context.mailbox.item.getSelectedEntities`
|
|
9096
|
+
* @deprecated Use {@link https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins | regular expression rules} instead.
|
|
9103
9097
|
*
|
|
9104
|
-
*
|
|
9105
|
-
*
|
|
9106
|
-
* - An alternative implementation of the **Join Meeting** button, which is activated by online meeting add-ins, is being developed. Once support for
|
|
9107
|
-
* entity-based contextual add-ins ends, online meeting add-ins will automatically transition to the alternative implementation to activate the
|
|
9108
|
-
* **Join Meeting** button.
|
|
9109
|
-
*
|
|
9110
|
-
* - Regular expression rules will continue to be supported after entity-based contextual add-ins are retired. We recommend updating your contextual add-in
|
|
9111
|
-
* to use regular expression rules as an alternative solution. For guidance on how to implement these rules, see
|
|
9112
|
-
* {@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}.
|
|
9098
|
+
* @remarks
|
|
9113
9099
|
*
|
|
9114
|
-
*
|
|
9115
|
-
* {@link https://devblogs.microsoft.com/microsoft365dev/retirement-of-entity-based-contextual-outlook-add-ins | Retirement of entity-based contextual Outlook add-ins}.
|
|
9100
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read
|
|
9116
9101
|
*/
|
|
9117
9102
|
enum EntityType {
|
|
9118
9103
|
/**
|
|
@@ -12044,30 +12029,31 @@ declare namespace Office {
|
|
|
12044
12029
|
/**
|
|
12045
12030
|
* Gets the entities found in the selected item's body.
|
|
12046
12031
|
*
|
|
12032
|
+
* **Warning**: Entity-based contextual Outlook add-ins are now retired. However, regular expression rules are still supported.
|
|
12033
|
+
* We recommend updating your contextual add-in to use regular expression rules as an alternative solution.
|
|
12034
|
+
* For guidance on how to implement these rules, see
|
|
12035
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins | Contextual Outlook add-ins}.
|
|
12036
|
+
*
|
|
12037
|
+
* @deprecated Use {@link https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins | regular expression rules} instead.
|
|
12038
|
+
*
|
|
12047
12039
|
* @remarks
|
|
12048
12040
|
* [Api set: Mailbox 1.1]
|
|
12049
12041
|
*
|
|
12050
12042
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
12051
12043
|
*
|
|
12052
12044
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee
|
|
12053
|
-
*
|
|
12054
|
-
* **Important**:
|
|
12055
|
-
*
|
|
12056
|
-
* - Entity-based contextual Outlook add-ins, including the `getEntities` method, will be retired in Q2 of 2024. The work to retire this method will
|
|
12057
|
-
* 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.
|
|
12058
|
-
* Regular expression rules will continue to be supported after entity-based contextual add-ins are retired. We recommend updating your contextual add-in
|
|
12059
|
-
* to use regular expression rules as an alternative solution. For guidance on how to implement these rules, see
|
|
12060
|
-
* {@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}.
|
|
12061
|
-
* To learn more about the retirement of entity-based contextual Outlook add-ins, see
|
|
12062
|
-
* {@link https://devblogs.microsoft.com/microsoft365dev/retirement-of-entity-based-contextual-outlook-add-ins | Retirement of entity-based contextual Outlook add-ins}.
|
|
12063
|
-
*
|
|
12064
|
-
* - This method isn't supported in Outlook on Android or on iOS. For more information on supported APIs in Outlook mobile, see
|
|
12065
|
-
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
|
|
12066
12045
|
*/
|
|
12067
12046
|
getEntities(): Entities;
|
|
12068
12047
|
/**
|
|
12069
12048
|
* Gets an array of all the entities of the specified entity type found in the selected item's body.
|
|
12070
12049
|
*
|
|
12050
|
+
* **Warning**: Entity-based contextual Outlook add-ins are now retired. However, regular expression rules are still supported.
|
|
12051
|
+
* We recommend updating your contextual add-in to use regular expression rules as an alternative solution.
|
|
12052
|
+
* For guidance on how to implement these rules, see
|
|
12053
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins | Contextual Outlook add-ins}.
|
|
12054
|
+
*
|
|
12055
|
+
* @deprecated Use {@link https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins | regular expression rules} instead.
|
|
12056
|
+
*
|
|
12071
12057
|
* @returns
|
|
12072
12058
|
* If the value passed in `entityType` is not a valid member of the `EntityType` enumeration, the method returns null.
|
|
12073
12059
|
* If no entities of the specified type are present in the item's body, the method returns an empty array.
|
|
@@ -12080,70 +12066,19 @@ declare namespace Office {
|
|
|
12080
12066
|
*
|
|
12081
12067
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee
|
|
12082
12068
|
*
|
|
12083
|
-
* **Important**:
|
|
12084
|
-
*
|
|
12085
|
-
* - Entity-based contextual Outlook add-ins, including the `getEntitiesByType` method, will be retired in Q2 of 2024. The work to retire this method will
|
|
12086
|
-
* 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.
|
|
12087
|
-
* Regular expression rules will continue to be supported after entity-based contextual add-ins are retired. We recommend updating your contextual add-in
|
|
12088
|
-
* to use regular expression rules as an alternative solution. For guidance on how to implement these rules, see
|
|
12089
|
-
* {@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}.
|
|
12090
|
-
* To learn more about the retirement of entity-based contextual Outlook add-ins, see
|
|
12091
|
-
* {@link https://devblogs.microsoft.com/microsoft365dev/retirement-of-entity-based-contextual-outlook-add-ins | Retirement of entity-based contextual Outlook add-ins}.
|
|
12092
|
-
*
|
|
12093
|
-
* - This method isn't supported in Outlook on Android or on iOS. For more information on supported APIs in Outlook mobile, see
|
|
12094
|
-
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
|
|
12095
|
-
*
|
|
12096
12069
|
* @param entityType - One of the `EntityType` enumeration values.
|
|
12097
|
-
*
|
|
12098
|
-
* 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.
|
|
12099
|
-
*
|
|
12100
|
-
* <table>
|
|
12101
|
-
* <tr>
|
|
12102
|
-
* <th>Value of entityType</th>
|
|
12103
|
-
* <th>Type of objects in returned array</th>
|
|
12104
|
-
* <th>Required permission level</th>
|
|
12105
|
-
* </tr>
|
|
12106
|
-
* <tr>
|
|
12107
|
-
* <td>Address</td>
|
|
12108
|
-
* <td>String</td>
|
|
12109
|
-
* <td>Restricted</td>
|
|
12110
|
-
* </tr>
|
|
12111
|
-
* <tr>
|
|
12112
|
-
* <td>Contact</td>
|
|
12113
|
-
* <td>Contact</td>
|
|
12114
|
-
* <td>ReadItem</td>
|
|
12115
|
-
* </tr>
|
|
12116
|
-
* <tr>
|
|
12117
|
-
* <td>EmailAddress</td>
|
|
12118
|
-
* <td>String</td>
|
|
12119
|
-
* <td>ReadItem</td>
|
|
12120
|
-
* </tr>
|
|
12121
|
-
* <tr>
|
|
12122
|
-
* <td>MeetingSuggestion</td>
|
|
12123
|
-
* <td>MeetingSuggestion</td>
|
|
12124
|
-
* <td>ReadItem</td>
|
|
12125
|
-
* </tr>
|
|
12126
|
-
* <tr>
|
|
12127
|
-
* <td>PhoneNumber</td>
|
|
12128
|
-
* <td>PhoneNumber</td>
|
|
12129
|
-
* <td>Restricted</td>
|
|
12130
|
-
* </tr>
|
|
12131
|
-
* <tr>
|
|
12132
|
-
* <td>TaskSuggestion</td>
|
|
12133
|
-
* <td>TaskSuggestion</td>
|
|
12134
|
-
* <td>ReadItem</td>
|
|
12135
|
-
* </tr>
|
|
12136
|
-
* <tr>
|
|
12137
|
-
* <td>URL</td>
|
|
12138
|
-
* <td>String</td>
|
|
12139
|
-
* <td>Restricted</td>
|
|
12140
|
-
* </tr>
|
|
12141
|
-
* </table>
|
|
12142
12070
|
*/
|
|
12143
12071
|
getEntitiesByType(entityType: MailboxEnums.EntityType | string): Array<string | Contact | MeetingSuggestion | PhoneNumber | TaskSuggestion>;
|
|
12144
12072
|
/**
|
|
12145
12073
|
* Returns well-known entities in the selected item that pass the named filter defined in an XML manifest file.
|
|
12146
12074
|
*
|
|
12075
|
+
* **Warning**: Entity-based contextual Outlook add-ins are now retired. However, regular expression rules are still supported.
|
|
12076
|
+
* We recommend updating your contextual add-in to use regular expression rules as an alternative solution.
|
|
12077
|
+
* For guidance on how to implement these rules, see
|
|
12078
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins | Contextual Outlook add-ins}.
|
|
12079
|
+
*
|
|
12080
|
+
* @deprecated Use {@link https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins | regular expression rules} instead.
|
|
12081
|
+
*
|
|
12147
12082
|
* @returns
|
|
12148
12083
|
* The entities that match the regular expression defined in the `ItemHasKnownEntity` rule element in the
|
|
12149
12084
|
* manifest XML file with the specified `FilterName` element value. If there's no `ItemHasKnownEntity` element in the manifest with a
|
|
@@ -12157,22 +12092,6 @@ declare namespace Office {
|
|
|
12157
12092
|
*
|
|
12158
12093
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee
|
|
12159
12094
|
*
|
|
12160
|
-
* **Important**:
|
|
12161
|
-
*
|
|
12162
|
-
* - Entity-based contextual Outlook add-ins, including the `getFilteredEntitiesByName` method, will be retired in Q2 of 2024. The work to retire this method will
|
|
12163
|
-
* 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.
|
|
12164
|
-
* Regular expression rules will continue to be supported after entity-based contextual add-ins are retired. We recommend updating your contextual add-in
|
|
12165
|
-
* to use regular expression rules as an alternative solution. For guidance on how to implement these rules, see
|
|
12166
|
-
* {@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}.
|
|
12167
|
-
* To learn more about the retirement of entity-based contextual Outlook add-ins, see
|
|
12168
|
-
* {@link https://devblogs.microsoft.com/microsoft365dev/retirement-of-entity-based-contextual-outlook-add-ins | Retirement of entity-based contextual Outlook add-ins}.
|
|
12169
|
-
*
|
|
12170
|
-
* - 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},
|
|
12171
|
-
* which isn't supported by the {@link https://learn.microsoft.com/office/dev/add-ins/develop/json-manifest-overview | unified manifest for Microsoft 365}.
|
|
12172
|
-
*
|
|
12173
|
-
* - This method isn't supported in Outlook on Android or on iOS. For more information on supported APIs in Outlook mobile, see
|
|
12174
|
-
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
|
|
12175
|
-
*
|
|
12176
12095
|
* @param name - The name of the `ItemHasKnownEntity` rule element that defines the filter to match.
|
|
12177
12096
|
*/
|
|
12178
12097
|
getFilteredEntitiesByName(name: string): Array<string | Contact | MeetingSuggestion | PhoneNumber | TaskSuggestion>;
|
|
@@ -12215,8 +12134,8 @@ declare namespace Office {
|
|
|
12215
12134
|
*
|
|
12216
12135
|
* @returns
|
|
12217
12136
|
* An object that contains arrays of strings that match the regular expressions defined in the manifest XML file.
|
|
12218
|
-
* The name of each array is equal to the corresponding value of the RegExName attribute of the matching `ItemHasRegularExpressionMatch` rule
|
|
12219
|
-
*
|
|
12137
|
+
* The name of each array is equal to the corresponding value of the RegExName attribute of the matching `ItemHasRegularExpressionMatch` rule.
|
|
12138
|
+
* For an `ItemHasRegularExpressionMatch` rule, a matching string has to occur in the property
|
|
12220
12139
|
* of the item that's specified by that rule. The `PropertyName` simple type defines the supported properties.
|
|
12221
12140
|
*
|
|
12222
12141
|
* @remarks
|
|
@@ -12228,12 +12147,10 @@ declare namespace Office {
|
|
|
12228
12147
|
*
|
|
12229
12148
|
* **Important**:
|
|
12230
12149
|
*
|
|
12231
|
-
* - Entity-based contextual Outlook add-ins
|
|
12232
|
-
*
|
|
12233
|
-
*
|
|
12234
|
-
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/
|
|
12235
|
-
* To learn more about the retirement of entity-based contextual add-ins, see
|
|
12236
|
-
* {@link https://devblogs.microsoft.com/microsoft365dev/retirement-of-entity-based-contextual-outlook-add-ins | Retirement of entity-based contextual Outlook add-ins}.
|
|
12150
|
+
* - Entity-based contextual Outlook add-ins are now retired. However, regular expression rules are still supported.
|
|
12151
|
+
* We recommend updating your contextual add-in to use regular expression rules as an alternative solution.
|
|
12152
|
+
* For guidance on how to implement these rules, see
|
|
12153
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins | Contextual Outlook add-ins}.
|
|
12237
12154
|
*
|
|
12238
12155
|
* - 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},
|
|
12239
12156
|
* which isn't supported by the {@link https://learn.microsoft.com/office/dev/add-ins/develop/json-manifest-overview | unified manifest for Microsoft 365}.
|
|
@@ -12262,12 +12179,10 @@ declare namespace Office {
|
|
|
12262
12179
|
*
|
|
12263
12180
|
* **Important**:
|
|
12264
12181
|
*
|
|
12265
|
-
* - Entity-based contextual Outlook add-ins
|
|
12266
|
-
*
|
|
12267
|
-
*
|
|
12268
|
-
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/
|
|
12269
|
-
* To learn more about the retirement of entity-based contextual add-ins, see
|
|
12270
|
-
* {@link https://devblogs.microsoft.com/microsoft365dev/retirement-of-entity-based-contextual-outlook-add-ins | Retirement of entity-based contextual Outlook add-ins}.
|
|
12182
|
+
* - Entity-based contextual Outlook add-ins are now retired. However, regular expression rules are still supported.
|
|
12183
|
+
* We recommend updating your contextual add-in to use regular expression rules as an alternative solution.
|
|
12184
|
+
* For guidance on how to implement these rules, see
|
|
12185
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins | Contextual Outlook add-ins}.
|
|
12271
12186
|
*
|
|
12272
12187
|
* - 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},
|
|
12273
12188
|
* which isn't supported by the {@link https://learn.microsoft.com/office/dev/add-ins/develop/json-manifest-overview | unified manifest for Microsoft 365}.
|
|
@@ -12285,6 +12200,13 @@ declare namespace Office {
|
|
|
12285
12200
|
/**
|
|
12286
12201
|
* Gets the entities found in a highlighted match a user has selected. Highlighted matches apply to contextual add-ins.
|
|
12287
12202
|
*
|
|
12203
|
+
* **Warning**: 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}.
|
|
12207
|
+
*
|
|
12208
|
+
* @deprecated Use {@link https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins | regular expression rules} instead.
|
|
12209
|
+
*
|
|
12288
12210
|
* @remarks
|
|
12289
12211
|
* [Api set: Mailbox 1.6]
|
|
12290
12212
|
*
|
|
@@ -12292,22 +12214,6 @@ declare namespace Office {
|
|
|
12292
12214
|
*
|
|
12293
12215
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee
|
|
12294
12216
|
*
|
|
12295
|
-
* **Important**:
|
|
12296
|
-
*
|
|
12297
|
-
* - Entity-based contextual Outlook add-ins, including the `getSelectedEntities` method, will be retired in Q2 of 2024. The work to retire this method will
|
|
12298
|
-
* 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.
|
|
12299
|
-
* Regular expression rules will continue to be supported after entity-based contextual add-ins are retired. We recommend updating your contextual add-in
|
|
12300
|
-
* to use regular expression rules as an alternative solution. For guidance on how to implement these rules, see
|
|
12301
|
-
* {@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}.
|
|
12302
|
-
* To learn more about the retirement of entity-based contextual Outlook add-ins, see
|
|
12303
|
-
* {@link https://devblogs.microsoft.com/microsoft365dev/retirement-of-entity-based-contextual-outlook-add-ins | Retirement of entity-based contextual Outlook add-ins}.
|
|
12304
|
-
*
|
|
12305
|
-
* - 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},
|
|
12306
|
-
* which isn't supported by the {@link https://learn.microsoft.com/office/dev/add-ins/develop/json-manifest-overview | unified manifest for Microsoft 365}.
|
|
12307
|
-
*
|
|
12308
|
-
* - This method isn't supported in Outlook on iOS or Android. For more information on supported APIs in Outlook mobile, see
|
|
12309
|
-
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
|
|
12310
|
-
*
|
|
12311
12217
|
* @param name - The name of the `ItemHasRegularExpressionMatch` rule element that defines the filter to match.
|
|
12312
12218
|
*/
|
|
12313
12219
|
getSelectedEntities(): Entities;
|
|
@@ -12317,9 +12223,9 @@ declare namespace Office {
|
|
|
12317
12223
|
*
|
|
12318
12224
|
* @returns
|
|
12319
12225
|
* An object that contains arrays of strings that match the regular expressions defined in the manifest XML file.
|
|
12320
|
-
* The name of each array is equal to the corresponding value of the `RegExName` attribute of the matching `ItemHasRegularExpressionMatch` rule
|
|
12321
|
-
*
|
|
12322
|
-
*
|
|
12226
|
+
* The name of each array is equal to the corresponding value of the `RegExName` attribute of the matching `ItemHasRegularExpressionMatch` rule.
|
|
12227
|
+
* For an `ItemHasRegularExpressionMatch` rule, a matching string has to occur in the property of the item that's specified by that rule.
|
|
12228
|
+
* The `PropertyName` simple type defines the supported properties.
|
|
12323
12229
|
*
|
|
12324
12230
|
* @remarks
|
|
12325
12231
|
* [Api set: Mailbox 1.6]
|
|
@@ -12330,12 +12236,10 @@ declare namespace Office {
|
|
|
12330
12236
|
*
|
|
12331
12237
|
* **Important**:
|
|
12332
12238
|
*
|
|
12333
|
-
* - Entity-based contextual Outlook add-ins
|
|
12334
|
-
*
|
|
12335
|
-
*
|
|
12336
|
-
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/
|
|
12337
|
-
* To learn more about the retirement of entity-based contextual add-ins, see
|
|
12338
|
-
* {@link https://devblogs.microsoft.com/microsoft365dev/retirement-of-entity-based-contextual-outlook-add-ins | Retirement of entity-based contextual Outlook add-ins}.
|
|
12239
|
+
* - Entity-based contextual Outlook add-ins are now retired. However, regular expression rules are still supported.
|
|
12240
|
+
* We recommend updating your contextual add-in to use regular expression rules as an alternative solution.
|
|
12241
|
+
* For guidance on how to implement these rules, see
|
|
12242
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins | Contextual Outlook add-ins}.
|
|
12339
12243
|
*
|
|
12340
12244
|
* - 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},
|
|
12341
12245
|
* which isn't supported by the {@link https://learn.microsoft.com/office/dev/add-ins/develop/json-manifest-overview | unified manifest for Microsoft 365}.
|
|
@@ -13372,6 +13276,13 @@ declare namespace Office {
|
|
|
13372
13276
|
* The list of contacts extracted from the body of an email message or appointment is returned in the `contacts` property of the
|
|
13373
13277
|
* {@link Office.Entities | Entities} object returned by the `getEntities` or `getEntitiesByType` method of the current item.
|
|
13374
13278
|
*
|
|
13279
|
+
* **Warning**: Entity-based contextual Outlook add-ins are now retired. However, regular expression rules are still supported.
|
|
13280
|
+
* We recommend updating your contextual add-in to use regular expression rules as an alternative solution.
|
|
13281
|
+
* For guidance on how to implement these rules, see
|
|
13282
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins | Contextual Outlook add-ins}.
|
|
13283
|
+
*
|
|
13284
|
+
* @deprecated Use {@link https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins | regular expression rules} instead.
|
|
13285
|
+
*
|
|
13375
13286
|
* @remarks
|
|
13376
13287
|
*
|
|
13377
13288
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **restricted**
|
|
@@ -13395,7 +13306,7 @@ declare namespace Office {
|
|
|
13395
13306
|
*
|
|
13396
13307
|
* - Regular expression rules will continue to be supported after entity-based contextual add-ins are retired. We recommend updating your contextual add-in
|
|
13397
13308
|
* to use regular expression rules as an alternative solution. For guidance on how to implement these rules, see
|
|
13398
|
-
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/
|
|
13309
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins | Contextual Outlook add-ins}.
|
|
13399
13310
|
*
|
|
13400
13311
|
* For more information, see
|
|
13401
13312
|
* {@link https://devblogs.microsoft.com/microsoft365dev/retirement-of-entity-based-contextual-outlook-add-ins | Retirement of entity-based contextual Outlook add-ins}.
|
|
@@ -13403,26 +13314,68 @@ declare namespace Office {
|
|
|
13403
13314
|
interface Contact {
|
|
13404
13315
|
/**
|
|
13405
13316
|
* An array of strings containing the mailing and street addresses associated with the contact. Nullable.
|
|
13317
|
+
*
|
|
13318
|
+
* **Warning**: Entity-based contextual Outlook add-ins are now retired. However, regular expression rules are still supported.
|
|
13319
|
+
* We recommend updating your contextual add-in to use regular expression rules as an alternative solution.
|
|
13320
|
+
* For guidance on how to implement these rules, see
|
|
13321
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins | Contextual Outlook add-ins}.
|
|
13322
|
+
*
|
|
13323
|
+
* @deprecated Use {@link https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins | regular expression rules} instead.
|
|
13406
13324
|
*/
|
|
13407
13325
|
addresses: string[];
|
|
13408
13326
|
/**
|
|
13409
13327
|
* A string containing the name of the business associated with the contact. Nullable.
|
|
13328
|
+
*
|
|
13329
|
+
* **Warning**: Entity-based contextual Outlook add-ins are now retired. However, regular expression rules are still supported.
|
|
13330
|
+
* We recommend updating your contextual add-in to use regular expression rules as an alternative solution.
|
|
13331
|
+
* For guidance on how to implement these rules, see
|
|
13332
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins | Contextual Outlook add-ins}.
|
|
13333
|
+
*
|
|
13334
|
+
* @deprecated Use {@link https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins | regular expression rules} instead.
|
|
13410
13335
|
*/
|
|
13411
13336
|
businessName: string;
|
|
13412
13337
|
/**
|
|
13413
13338
|
* An array of strings containing the SMTP email addresses associated with the contact. Nullable.
|
|
13339
|
+
*
|
|
13340
|
+
* **Warning**: Entity-based contextual Outlook add-ins are now retired. However, regular expression rules are still supported.
|
|
13341
|
+
* We recommend updating your contextual add-in to use regular expression rules as an alternative solution.
|
|
13342
|
+
* For guidance on how to implement these rules, see
|
|
13343
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins | Contextual Outlook add-ins}.
|
|
13344
|
+
*
|
|
13345
|
+
* @deprecated Use {@link https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins | regular expression rules} instead.
|
|
13414
13346
|
*/
|
|
13415
13347
|
emailAddresses: string[];
|
|
13416
13348
|
/**
|
|
13417
13349
|
* A string containing the name of the person associated with the contact. Nullable.
|
|
13350
|
+
*
|
|
13351
|
+
* **Warning**: Entity-based contextual Outlook add-ins are now retired. However, regular expression rules are still supported.
|
|
13352
|
+
* We recommend updating your contextual add-in to use regular expression rules as an alternative solution.
|
|
13353
|
+
* For guidance on how to implement these rules, see
|
|
13354
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins | Contextual Outlook add-ins}.
|
|
13355
|
+
*
|
|
13356
|
+
* @deprecated Use {@link https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins | regular expression rules} instead.
|
|
13418
13357
|
*/
|
|
13419
13358
|
personName: string;
|
|
13420
13359
|
/**
|
|
13421
13360
|
* An array containing a `PhoneNumber` object for each phone number associated with the contact. Nullable.
|
|
13361
|
+
*
|
|
13362
|
+
* **Warning**: Entity-based contextual Outlook add-ins are now retired. However, regular expression rules are still supported.
|
|
13363
|
+
* We recommend updating your contextual add-in to use regular expression rules as an alternative solution.
|
|
13364
|
+
* For guidance on how to implement these rules, see
|
|
13365
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins | Contextual Outlook add-ins}.
|
|
13366
|
+
*
|
|
13367
|
+
* @deprecated Use {@link https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins | regular expression rules} instead.
|
|
13422
13368
|
*/
|
|
13423
13369
|
phoneNumbers: PhoneNumber[];
|
|
13424
13370
|
/**
|
|
13425
13371
|
* An array of strings containing the Internet URLs associated with the contact. Nullable.
|
|
13372
|
+
*
|
|
13373
|
+
* **Warning**: Entity-based contextual Outlook add-ins are now retired. However, regular expression rules are still supported.
|
|
13374
|
+
* We recommend updating your contextual add-in to use regular expression rules as an alternative solution.
|
|
13375
|
+
* For guidance on how to implement these rules, see
|
|
13376
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins | Contextual Outlook add-ins}.
|
|
13377
|
+
*
|
|
13378
|
+
* @deprecated Use {@link https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins | regular expression rules} instead.
|
|
13426
13379
|
*/
|
|
13427
13380
|
urls: string[];
|
|
13428
13381
|
}
|
|
@@ -13972,61 +13925,95 @@ declare namespace Office {
|
|
|
13972
13925
|
* When the property arrays are returned by the `getEntitiesByType` method, only the property for the specified entity contains data;
|
|
13973
13926
|
* all other properties are null.
|
|
13974
13927
|
*
|
|
13928
|
+
* **Warning**: Entity-based contextual Outlook add-ins are now retired. However, regular expression rules are still supported.
|
|
13929
|
+
* We recommend updating your contextual add-in to use regular expression rules as an alternative solution.
|
|
13930
|
+
* For guidance on how to implement these rules, see
|
|
13931
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins | Contextual Outlook add-ins}.
|
|
13932
|
+
*
|
|
13933
|
+
* @deprecated Use {@link https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins | regular expression rules} instead.
|
|
13934
|
+
*
|
|
13975
13935
|
* @remarks
|
|
13976
13936
|
*
|
|
13977
13937
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
13978
13938
|
*
|
|
13979
13939
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Read
|
|
13980
|
-
*
|
|
13981
|
-
* **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
|
|
13982
|
-
* 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.
|
|
13983
|
-
* The following APIs will also be retired.
|
|
13984
|
-
*
|
|
13985
|
-
* - `Office.context.mailbox.item.getEntities`
|
|
13986
|
-
* - `Office.context.mailbox.item.getEntitiesByType`
|
|
13987
|
-
* - `Office.context.mailbox.item.getFilteredEntitiesByName`
|
|
13988
|
-
* - `Office.context.mailbox.item.getSelectedEntities`
|
|
13989
|
-
*
|
|
13990
|
-
* To help minimize potential disruptions, the following will still be supported after entity-based contextual add-ins are retired.
|
|
13991
|
-
*
|
|
13992
|
-
* - An alternative implementation of the **Join Meeting** button, which is activated by online meeting add-ins, is being developed. Once support for
|
|
13993
|
-
* entity-based contextual add-ins ends, online meeting add-ins will automatically transition to the alternative implementation to activate the
|
|
13994
|
-
* **Join Meeting** button.
|
|
13995
|
-
*
|
|
13996
|
-
* - Regular expression rules will continue to be supported after entity-based contextual add-ins are retired. We recommend updating your contextual add-in
|
|
13997
|
-
* to use regular expression rules as an alternative solution. For guidance on how to implement these rules, see
|
|
13998
|
-
* {@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}.
|
|
13999
|
-
*
|
|
14000
|
-
* For more information, see
|
|
14001
|
-
* {@link https://devblogs.microsoft.com/microsoft365dev/retirement-of-entity-based-contextual-outlook-add-ins | Retirement of entity-based contextual Outlook add-ins}.
|
|
14002
13940
|
*/
|
|
14003
13941
|
interface Entities {
|
|
14004
13942
|
/**
|
|
14005
13943
|
* Gets the physical addresses (street or mailing addresses) found in an email message or appointment.
|
|
13944
|
+
*
|
|
13945
|
+
* **Warning**: Entity-based contextual Outlook add-ins are now retired. However, regular expression rules are still supported.
|
|
13946
|
+
* We recommend updating your contextual add-in to use regular expression rules as an alternative solution.
|
|
13947
|
+
* For guidance on how to implement these rules, see
|
|
13948
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins | Contextual Outlook add-ins}.
|
|
13949
|
+
*
|
|
13950
|
+
* @deprecated Use {@link https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins | regular expression rules} instead.
|
|
14006
13951
|
*/
|
|
14007
13952
|
addresses: string[];
|
|
14008
13953
|
/**
|
|
14009
13954
|
* Gets the contacts found in an email address or appointment.
|
|
13955
|
+
*
|
|
13956
|
+
* **Warning**: Entity-based contextual Outlook add-ins are now retired. However, regular expression rules are still supported.
|
|
13957
|
+
* We recommend updating your contextual add-in to use regular expression rules as an alternative solution.
|
|
13958
|
+
* For guidance on how to implement these rules, see
|
|
13959
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins | Contextual Outlook add-ins}.
|
|
13960
|
+
*
|
|
13961
|
+
* @deprecated Use {@link https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins | regular expression rules} instead.
|
|
14010
13962
|
*/
|
|
14011
13963
|
contacts: Contact[];
|
|
14012
13964
|
/**
|
|
14013
13965
|
* Gets the email addresses found in an email message or appointment.
|
|
13966
|
+
*
|
|
13967
|
+
* **Warning**: Entity-based contextual Outlook add-ins are now retired. However, regular expression rules are still supported.
|
|
13968
|
+
* We recommend updating your contextual add-in to use regular expression rules as an alternative solution.
|
|
13969
|
+
* For guidance on how to implement these rules, see
|
|
13970
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins | Contextual Outlook add-ins}.
|
|
13971
|
+
*
|
|
13972
|
+
* @deprecated Use {@link https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins | regular expression rules} instead.
|
|
14014
13973
|
*/
|
|
14015
13974
|
emailAddresses: string[];
|
|
14016
13975
|
/**
|
|
14017
13976
|
* Gets the meeting suggestions found in an email message.
|
|
13977
|
+
*
|
|
13978
|
+
* **Warning**: Entity-based contextual Outlook add-ins are now retired. However, regular expression rules are still supported.
|
|
13979
|
+
* We recommend updating your contextual add-in to use regular expression rules as an alternative solution.
|
|
13980
|
+
* For guidance on how to implement these rules, see
|
|
13981
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins | Contextual Outlook add-ins}.
|
|
13982
|
+
*
|
|
13983
|
+
* @deprecated Use {@link https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins | regular expression rules} instead.
|
|
14018
13984
|
*/
|
|
14019
13985
|
meetingSuggestions: MeetingSuggestion[];
|
|
14020
13986
|
/**
|
|
14021
13987
|
* Gets the phone numbers found in an email message or appointment.
|
|
13988
|
+
*
|
|
13989
|
+
* **Warning**: Entity-based contextual Outlook add-ins are now retired. However, regular expression rules are still supported.
|
|
13990
|
+
* We recommend updating your contextual add-in to use regular expression rules as an alternative solution.
|
|
13991
|
+
* For guidance on how to implement these rules, see
|
|
13992
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins | Contextual Outlook add-ins}.
|
|
13993
|
+
*
|
|
13994
|
+
* @deprecated Use {@link https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins | regular expression rules} instead.
|
|
14022
13995
|
*/
|
|
14023
13996
|
phoneNumbers: PhoneNumber[];
|
|
14024
13997
|
/**
|
|
14025
13998
|
* Gets the task suggestions found in an email message or appointment.
|
|
13999
|
+
*
|
|
14000
|
+
* **Warning**: Entity-based contextual Outlook add-ins are now retired. However, regular expression rules are still supported.
|
|
14001
|
+
* We recommend updating your contextual add-in to use regular expression rules as an alternative solution.
|
|
14002
|
+
* For guidance on how to implement these rules, see
|
|
14003
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins | Contextual Outlook add-ins}.
|
|
14004
|
+
*
|
|
14005
|
+
* @deprecated Use {@link https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins | regular expression rules} instead.
|
|
14026
14006
|
*/
|
|
14027
14007
|
taskSuggestions: string[];
|
|
14028
14008
|
/**
|
|
14029
14009
|
* Gets the Internet URLs present in an email message or appointment.
|
|
14010
|
+
*
|
|
14011
|
+
* **Warning**: Entity-based contextual Outlook add-ins are now retired. However, regular expression rules are still supported.
|
|
14012
|
+
* We recommend updating your contextual add-in to use regular expression rules as an alternative solution.
|
|
14013
|
+
* For guidance on how to implement these rules, see
|
|
14014
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins | Contextual Outlook add-ins}.
|
|
14015
|
+
*
|
|
14016
|
+
* @deprecated Use {@link https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins | regular expression rules} instead.
|
|
14030
14017
|
*/
|
|
14031
14018
|
urls: string[];
|
|
14032
14019
|
}
|
|
@@ -15746,63 +15733,90 @@ declare namespace Office {
|
|
|
15746
15733
|
/**
|
|
15747
15734
|
* Represents a suggested meeting found in an item. Read mode only.
|
|
15748
15735
|
*
|
|
15749
|
-
* The list of meetings suggested in an email message is returned in the `meetingSuggestions` property of the `Entities` object that
|
|
15736
|
+
* The list of meetings suggested in an email message is returned in the `meetingSuggestions` property of the `Entities` object that's returned when
|
|
15750
15737
|
* the `getEntities` or `getEntitiesByType` method is called on the active item.
|
|
15751
15738
|
*
|
|
15752
15739
|
* 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
|
|
15753
15740
|
* begin and end. The values are in the default time zone specified for the current user.
|
|
15754
15741
|
*
|
|
15742
|
+
* **Warning**: Entity-based contextual Outlook add-ins are now retired. However, regular expression rules are still supported.
|
|
15743
|
+
* We recommend updating your contextual add-in to use regular expression rules as an alternative solution.
|
|
15744
|
+
* For guidance on how to implement these rules, see
|
|
15745
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins | Contextual Outlook add-ins}.
|
|
15746
|
+
*
|
|
15747
|
+
* @deprecated Use {@link https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins | regular expression rules} instead.
|
|
15748
|
+
*
|
|
15755
15749
|
* @remarks
|
|
15756
15750
|
*
|
|
15757
15751
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
15758
15752
|
*
|
|
15759
15753
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Read
|
|
15760
|
-
*
|
|
15761
|
-
* **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
|
|
15762
|
-
* 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.
|
|
15763
|
-
* The following APIs will also be retired.
|
|
15764
|
-
*
|
|
15765
|
-
* - `Office.context.mailbox.item.getEntities`
|
|
15766
|
-
* - `Office.context.mailbox.item.getEntitiesByType`
|
|
15767
|
-
* - `Office.context.mailbox.item.getFilteredEntitiesByName`
|
|
15768
|
-
* - `Office.context.mailbox.item.getSelectedEntities`
|
|
15769
|
-
*
|
|
15770
|
-
* To help minimize potential disruptions, the following will still be supported after entity-based contextual add-ins are retired.
|
|
15771
|
-
*
|
|
15772
|
-
* - An alternative implementation of the **Join Meeting** button, which is activated by online meeting add-ins, is being developed. Once support for
|
|
15773
|
-
* entity-based contextual add-ins ends, online meeting add-ins will automatically transition to the alternative implementation to activate the
|
|
15774
|
-
* **Join Meeting** button.
|
|
15775
|
-
*
|
|
15776
|
-
* - Regular expression rules will continue to be supported after entity-based contextual add-ins are retired. We recommend updating your contextual add-in
|
|
15777
|
-
* to use regular expression rules as an alternative solution. For guidance on how to implement these rules, see
|
|
15778
|
-
* {@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}.
|
|
15779
|
-
*
|
|
15780
|
-
* For more information, see
|
|
15781
|
-
* {@link https://devblogs.microsoft.com/microsoft365dev/retirement-of-entity-based-contextual-outlook-add-ins | Retirement of entity-based contextual Outlook add-ins}.
|
|
15782
15754
|
*/
|
|
15783
15755
|
interface MeetingSuggestion {
|
|
15784
15756
|
/**
|
|
15785
15757
|
* Gets the attendees for a suggested meeting.
|
|
15758
|
+
*
|
|
15759
|
+
* **Warning**: Entity-based contextual Outlook add-ins are now retired. However, regular expression rules are still supported.
|
|
15760
|
+
* We recommend updating your contextual add-in to use regular expression rules as an alternative solution.
|
|
15761
|
+
* For guidance on how to implement these rules, see
|
|
15762
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins | Contextual Outlook add-ins}.
|
|
15763
|
+
*
|
|
15764
|
+
* @deprecated Use {@link https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins | regular expression rules} instead.
|
|
15786
15765
|
*/
|
|
15787
15766
|
attendees: EmailUser[];
|
|
15788
15767
|
/**
|
|
15789
15768
|
* Gets the date and time that a suggested meeting is to end.
|
|
15769
|
+
*
|
|
15770
|
+
* **Warning**: Entity-based contextual Outlook add-ins are now retired. However, regular expression rules are still supported.
|
|
15771
|
+
* We recommend updating your contextual add-in to use regular expression rules as an alternative solution.
|
|
15772
|
+
* For guidance on how to implement these rules, see
|
|
15773
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins | Contextual Outlook add-ins}.
|
|
15774
|
+
*
|
|
15775
|
+
* @deprecated Use {@link https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins | regular expression rules} instead.
|
|
15790
15776
|
*/
|
|
15791
15777
|
end: string;
|
|
15792
15778
|
/**
|
|
15793
15779
|
* Gets the location of a suggested meeting.
|
|
15780
|
+
*
|
|
15781
|
+
* **Warning**: Entity-based contextual Outlook add-ins are now retired. However, regular expression rules are still supported.
|
|
15782
|
+
* We recommend updating your contextual add-in to use regular expression rules as an alternative solution.
|
|
15783
|
+
* For guidance on how to implement these rules, see
|
|
15784
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins | Contextual Outlook add-ins}.
|
|
15785
|
+
*
|
|
15786
|
+
* @deprecated Use {@link https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins | regular expression rules} instead.
|
|
15794
15787
|
*/
|
|
15795
15788
|
location: string;
|
|
15796
15789
|
/**
|
|
15797
15790
|
* Gets a string that was identified as a meeting suggestion.
|
|
15791
|
+
*
|
|
15792
|
+
* **Warning**: Entity-based contextual Outlook add-ins are now retired. However, regular expression rules are still supported.
|
|
15793
|
+
* We recommend updating your contextual add-in to use regular expression rules as an alternative solution.
|
|
15794
|
+
* For guidance on how to implement these rules, see
|
|
15795
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins | Contextual Outlook add-ins}.
|
|
15796
|
+
*
|
|
15797
|
+
* @deprecated Use {@link https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins | regular expression rules} instead.
|
|
15798
15798
|
*/
|
|
15799
15799
|
meetingString: string;
|
|
15800
15800
|
/**
|
|
15801
15801
|
* Gets the date and time that a suggested meeting is to begin.
|
|
15802
|
+
*
|
|
15803
|
+
* **Warning**: Entity-based contextual Outlook add-ins are now retired. However, regular expression rules are still supported.
|
|
15804
|
+
* We recommend updating your contextual add-in to use regular expression rules as an alternative solution.
|
|
15805
|
+
* For guidance on how to implement these rules, see
|
|
15806
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins | Contextual Outlook add-ins}.
|
|
15807
|
+
*
|
|
15808
|
+
* @deprecated Use {@link https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins | regular expression rules} instead.
|
|
15802
15809
|
*/
|
|
15803
15810
|
start: string;
|
|
15804
15811
|
/**
|
|
15805
15812
|
* Gets the subject of a suggested meeting.
|
|
15813
|
+
*
|
|
15814
|
+
* **Warning**: Entity-based contextual Outlook add-ins are now retired. However, regular expression rules are still supported.
|
|
15815
|
+
* We recommend updating your contextual add-in to use regular expression rules as an alternative solution.
|
|
15816
|
+
* For guidance on how to implement these rules, see
|
|
15817
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins | Contextual Outlook add-ins}.
|
|
15818
|
+
*
|
|
15819
|
+
* @deprecated Use {@link https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins | regular expression rules} instead.
|
|
15806
15820
|
*/
|
|
15807
15821
|
subject: string;
|
|
15808
15822
|
}
|
|
@@ -18001,30 +18015,31 @@ declare namespace Office {
|
|
|
18001
18015
|
/**
|
|
18002
18016
|
* Gets the entities found in the selected item's body.
|
|
18003
18017
|
*
|
|
18018
|
+
* **Warning**: Entity-based contextual Outlook add-ins are now retired. However, regular expression rules are still supported.
|
|
18019
|
+
* We recommend updating your contextual add-in to use regular expression rules as an alternative solution.
|
|
18020
|
+
* For guidance on how to implement these rules, see
|
|
18021
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins | Contextual Outlook add-ins}.
|
|
18022
|
+
*
|
|
18023
|
+
* @deprecated Use {@link https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins | regular expression rules} instead.
|
|
18024
|
+
*
|
|
18004
18025
|
* @remarks
|
|
18005
18026
|
* [Api set: Mailbox 1.1]
|
|
18006
18027
|
*
|
|
18007
18028
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
18008
18029
|
*
|
|
18009
18030
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee
|
|
18010
|
-
*
|
|
18011
|
-
* **Important**:
|
|
18012
|
-
*
|
|
18013
|
-
* - Entity-based contextual Outlook add-ins, including the `getEntities` method, will be retired in Q2 of 2024. The work to retire this method will
|
|
18014
|
-
* 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.
|
|
18015
|
-
* Regular expression rules will continue to be supported after entity-based contextual add-ins are retired. We recommend updating your contextual add-in
|
|
18016
|
-
* to use regular expression rules as an alternative solution. For guidance on how to implement these rules, see
|
|
18017
|
-
* {@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}.
|
|
18018
|
-
* To learn more about the retirement of entity-based contextual Outlook add-ins, see
|
|
18019
|
-
* {@link https://devblogs.microsoft.com/microsoft365dev/retirement-of-entity-based-contextual-outlook-add-ins | Retirement of entity-based contextual Outlook add-ins}.
|
|
18020
|
-
*
|
|
18021
|
-
* - This method isn't supported in Outlook on Android or on iOS. For more information on supported APIs in Outlook mobile, see
|
|
18022
|
-
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
|
|
18023
18031
|
*/
|
|
18024
18032
|
getEntities(): Entities;
|
|
18025
18033
|
/**
|
|
18026
18034
|
* Gets an array of all the entities of the specified entity type found in the selected item's body.
|
|
18027
18035
|
*
|
|
18036
|
+
* **Warning**: Entity-based contextual Outlook add-ins are now retired. However, regular expression rules are still supported.
|
|
18037
|
+
* We recommend updating your contextual add-in to use regular expression rules as an alternative solution.
|
|
18038
|
+
* For guidance on how to implement these rules, see
|
|
18039
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins | Contextual Outlook add-ins}.
|
|
18040
|
+
*
|
|
18041
|
+
* @deprecated Use {@link https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins | regular expression rules} instead.
|
|
18042
|
+
*
|
|
18028
18043
|
* @returns
|
|
18029
18044
|
* If the value passed in `entityType` is not a valid member of the `EntityType` enumeration, the method returns `null`.
|
|
18030
18045
|
* If no entities of the specified type are present in the item's body, the method returns an empty array.
|
|
@@ -18037,71 +18052,19 @@ declare namespace Office {
|
|
|
18037
18052
|
*
|
|
18038
18053
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read
|
|
18039
18054
|
*
|
|
18040
|
-
* **Important**:
|
|
18041
|
-
*
|
|
18042
|
-
* - Entity-based contextual Outlook add-ins, including the `getEntitiesByType` method, will be retired in Q2 of 2024. The work to retire this method will
|
|
18043
|
-
* 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.
|
|
18044
|
-
* Regular expression rules will continue to be supported after entity-based contextual add-ins are retired. We recommend updating your contextual add-in
|
|
18045
|
-
* to use regular expression rules as an alternative solution. For guidance on how to implement these rules, see
|
|
18046
|
-
* {@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}.
|
|
18047
|
-
* To learn more about the retirement of entity-based contextual Outlook add-ins, see
|
|
18048
|
-
* {@link https://devblogs.microsoft.com/microsoft365dev/retirement-of-entity-based-contextual-outlook-add-ins | Retirement of entity-based contextual Outlook add-ins}.
|
|
18049
|
-
*
|
|
18050
|
-
* - This method isn't supported in Outlook on Android or on iOS. For more information on supported APIs in Outlook mobile, see
|
|
18051
|
-
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
|
|
18052
|
-
*
|
|
18053
18055
|
* @param entityType - One of the `EntityType` enumeration values.
|
|
18054
|
-
*
|
|
18055
|
-
* While the minimum permission level to use this method is **restricted**, some entity types require **read item** to access, as specified in the
|
|
18056
|
-
* following table.
|
|
18057
|
-
*
|
|
18058
|
-
* <table>
|
|
18059
|
-
* <tr>
|
|
18060
|
-
* <th>Value of entityType</th>
|
|
18061
|
-
* <th>Type of objects in returned array</th>
|
|
18062
|
-
* <th>Required permission level</th>
|
|
18063
|
-
* </tr>
|
|
18064
|
-
* <tr>
|
|
18065
|
-
* <td>Address</td>
|
|
18066
|
-
* <td>String</td>
|
|
18067
|
-
* <td>Restricted</td>
|
|
18068
|
-
* </tr>
|
|
18069
|
-
* <tr>
|
|
18070
|
-
* <td>Contact</td>
|
|
18071
|
-
* <td>Contact</td>
|
|
18072
|
-
* <td>ReadItem</td>
|
|
18073
|
-
* </tr>
|
|
18074
|
-
* <tr>
|
|
18075
|
-
* <td>EmailAddress</td>
|
|
18076
|
-
* <td>String</td>
|
|
18077
|
-
* <td>ReadItem</td>
|
|
18078
|
-
* </tr>
|
|
18079
|
-
* <tr>
|
|
18080
|
-
* <td>MeetingSuggestion</td>
|
|
18081
|
-
* <td>MeetingSuggestion</td>
|
|
18082
|
-
* <td>ReadItem</td>
|
|
18083
|
-
* </tr>
|
|
18084
|
-
* <tr>
|
|
18085
|
-
* <td>PhoneNumber</td>
|
|
18086
|
-
* <td>PhoneNumber</td>
|
|
18087
|
-
* <td>Restricted</td>
|
|
18088
|
-
* </tr>
|
|
18089
|
-
* <tr>
|
|
18090
|
-
* <td>TaskSuggestion</td>
|
|
18091
|
-
* <td>TaskSuggestion</td>
|
|
18092
|
-
* <td>ReadItem</td>
|
|
18093
|
-
* </tr>
|
|
18094
|
-
* <tr>
|
|
18095
|
-
* <td>URL</td>
|
|
18096
|
-
* <td>String</td>
|
|
18097
|
-
* <td>Restricted</td>
|
|
18098
|
-
* </tr>
|
|
18099
|
-
* </table>
|
|
18100
18056
|
*/
|
|
18101
18057
|
getEntitiesByType(entityType: MailboxEnums.EntityType | string): Array<string | Contact | MeetingSuggestion | PhoneNumber | TaskSuggestion>;
|
|
18102
18058
|
/**
|
|
18103
18059
|
* Returns well-known entities in the selected item that pass the named filter defined in an XML manifest file.
|
|
18104
18060
|
*
|
|
18061
|
+
* **Warning**: Entity-based contextual Outlook add-ins are now retired. However, regular expression rules are still supported.
|
|
18062
|
+
* We recommend updating your contextual add-in to use regular expression rules as an alternative solution.
|
|
18063
|
+
* For guidance on how to implement these rules, see
|
|
18064
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins | Contextual Outlook add-ins}.
|
|
18065
|
+
*
|
|
18066
|
+
* @deprecated Use {@link https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins | regular expression rules} instead.
|
|
18067
|
+
*
|
|
18105
18068
|
* @returns
|
|
18106
18069
|
* The entities that match the regular expression defined in the `ItemHasKnownEntity` rule element in the
|
|
18107
18070
|
* manifest XML file with the specified `FilterName` element value. If there's no `ItemHasKnownEntity` element in the manifest with a
|
|
@@ -18115,22 +18078,6 @@ declare namespace Office {
|
|
|
18115
18078
|
*
|
|
18116
18079
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee
|
|
18117
18080
|
*
|
|
18118
|
-
* **Important**:
|
|
18119
|
-
*
|
|
18120
|
-
* - Entity-based contextual Outlook add-ins, including the `getFilteredEntitiesByName` method, will be retired in Q2 of 2024. The work to retire this method will
|
|
18121
|
-
* 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.
|
|
18122
|
-
* Regular expression rules will continue to be supported after entity-based contextual add-ins are retired. We recommend updating your contextual add-in
|
|
18123
|
-
* to use regular expression rules as an alternative solution. For guidance on how to implement these rules, see
|
|
18124
|
-
* {@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}.
|
|
18125
|
-
* To learn more about the retirement of entity-based contextual Outlook add-ins, see
|
|
18126
|
-
* {@link https://devblogs.microsoft.com/microsoft365dev/retirement-of-entity-based-contextual-outlook-add-ins | Retirement of entity-based contextual Outlook add-ins}.
|
|
18127
|
-
*
|
|
18128
|
-
* - 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},
|
|
18129
|
-
* which isn't supported by the {@link https://learn.microsoft.com/office/dev/add-ins/develop/json-manifest-overview | unified manifest for Microsoft 365}.
|
|
18130
|
-
*
|
|
18131
|
-
* - This method isn't supported in Outlook on Android or on iOS. For more information on supported APIs in Outlook mobile, see
|
|
18132
|
-
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
|
|
18133
|
-
*
|
|
18134
18081
|
* @param name - The name of the `ItemHasKnownEntity` rule element that defines the filter to match.
|
|
18135
18082
|
*/
|
|
18136
18083
|
getFilteredEntitiesByName(name: string): Array<string | Contact | MeetingSuggestion | PhoneNumber | TaskSuggestion>;
|
|
@@ -18173,9 +18120,9 @@ declare namespace Office {
|
|
|
18173
18120
|
*
|
|
18174
18121
|
* @returns
|
|
18175
18122
|
* An object that contains arrays of strings that match the regular expressions defined in the manifest XML file.
|
|
18176
|
-
* The name of each array is equal to the corresponding value of the RegExName attribute of the matching `ItemHasRegularExpressionMatch` rule
|
|
18177
|
-
*
|
|
18178
|
-
* of the item that
|
|
18123
|
+
* The name of each array is equal to the corresponding value of the RegExName attribute of the matching `ItemHasRegularExpressionMatch` rule.
|
|
18124
|
+
* For an `ItemHasRegularExpressionMatch` rule, a matching string has to occur in the property
|
|
18125
|
+
* of the item that's specified by that rule. The `PropertyName` simple type defines the supported properties.
|
|
18179
18126
|
*
|
|
18180
18127
|
* @remarks
|
|
18181
18128
|
* [Api set: Mailbox 1.1]
|
|
@@ -18186,12 +18133,10 @@ declare namespace Office {
|
|
|
18186
18133
|
*
|
|
18187
18134
|
* **Important**:
|
|
18188
18135
|
*
|
|
18189
|
-
* - Entity-based contextual Outlook add-ins
|
|
18190
|
-
*
|
|
18191
|
-
*
|
|
18192
|
-
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/
|
|
18193
|
-
* To learn more about the retirement of entity-based contextual add-ins, see
|
|
18194
|
-
* {@link https://devblogs.microsoft.com/microsoft365dev/retirement-of-entity-based-contextual-outlook-add-ins | Retirement of entity-based contextual Outlook add-ins}.
|
|
18136
|
+
* - Entity-based contextual Outlook add-ins are now retired. However, regular expression rules are still supported.
|
|
18137
|
+
* We recommend updating your contextual add-in to use regular expression rules as an alternative solution.
|
|
18138
|
+
* For guidance on how to implement these rules, see
|
|
18139
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins | Contextual Outlook add-ins}.
|
|
18195
18140
|
*
|
|
18196
18141
|
* - 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},
|
|
18197
18142
|
* which isn't supported by the {@link https://learn.microsoft.com/office/dev/add-ins/develop/json-manifest-overview | unified manifest for Microsoft 365}.
|
|
@@ -18220,12 +18165,10 @@ declare namespace Office {
|
|
|
18220
18165
|
*
|
|
18221
18166
|
* **Important**:
|
|
18222
18167
|
*
|
|
18223
|
-
* - Entity-based contextual Outlook add-ins
|
|
18224
|
-
*
|
|
18225
|
-
*
|
|
18226
|
-
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/
|
|
18227
|
-
* To learn more about the retirement of entity-based contextual add-ins, see
|
|
18228
|
-
* {@link https://devblogs.microsoft.com/microsoft365dev/retirement-of-entity-based-contextual-outlook-add-ins | Retirement of entity-based contextual Outlook add-ins}.
|
|
18168
|
+
* - Entity-based contextual Outlook add-ins are now retired. However, regular expression rules are still supported.
|
|
18169
|
+
* We recommend updating your contextual add-in to use regular expression rules as an alternative solution.
|
|
18170
|
+
* For guidance on how to implement these rules, see
|
|
18171
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins | Contextual Outlook add-ins}.
|
|
18229
18172
|
*
|
|
18230
18173
|
* - 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},
|
|
18231
18174
|
* which isn't supported by the {@link https://learn.microsoft.com/office/dev/add-ins/develop/json-manifest-overview | unified manifest for Microsoft 365}.
|
|
@@ -18242,11 +18185,13 @@ declare namespace Office {
|
|
|
18242
18185
|
getRegExMatchesByName(name: string): string[];
|
|
18243
18186
|
/**
|
|
18244
18187
|
* Gets the entities found in a highlighted match a user has selected. Highlighted matches apply to contextual add-ins.
|
|
18245
|
-
*
|
|
18246
|
-
* **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
|
|
18247
|
-
* {@link https://learn.microsoft.com/office/dev/add-ins/develop/unified-manifest-overview | unified manifest for Microsoft 365}.
|
|
18248
18188
|
*
|
|
18249
|
-
* **
|
|
18189
|
+
* **Warning**: Entity-based contextual Outlook add-ins are now retired. However, regular expression rules are still supported.
|
|
18190
|
+
* We recommend updating your contextual add-in to use regular expression rules as an alternative solution.
|
|
18191
|
+
* For guidance on how to implement these rules, see
|
|
18192
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins | Contextual Outlook add-ins}.
|
|
18193
|
+
*
|
|
18194
|
+
* @deprecated Use {@link https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins | regular expression rules} instead.
|
|
18250
18195
|
*
|
|
18251
18196
|
* @remarks
|
|
18252
18197
|
* [Api set: Mailbox 1.6]
|
|
@@ -18255,22 +18200,6 @@ declare namespace Office {
|
|
|
18255
18200
|
*
|
|
18256
18201
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read
|
|
18257
18202
|
*
|
|
18258
|
-
* **Important**:
|
|
18259
|
-
*
|
|
18260
|
-
* - Entity-based contextual Outlook add-ins, including the `getSelectedEntities` method, will be retired in Q2 of 2024. The work to retire this method will
|
|
18261
|
-
* 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.
|
|
18262
|
-
* Regular expression rules will continue to be supported after entity-based contextual add-ins are retired. We recommend updating your contextual add-in
|
|
18263
|
-
* to use regular expression rules as an alternative solution. For guidance on how to implement these rules, see
|
|
18264
|
-
* {@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}.
|
|
18265
|
-
* To learn more about the retirement of entity-based contextual Outlook add-ins, see
|
|
18266
|
-
* {@link https://devblogs.microsoft.com/microsoft365dev/retirement-of-entity-based-contextual-outlook-add-ins | Retirement of entity-based contextual Outlook add-ins}.
|
|
18267
|
-
*
|
|
18268
|
-
* - 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},
|
|
18269
|
-
* which isn't supported by the {@link https://learn.microsoft.com/office/dev/add-ins/develop/json-manifest-overview | unified manifest for Microsoft 365}.
|
|
18270
|
-
*
|
|
18271
|
-
* - This method isn't supported in Outlook on iOS or Android. For more information on supported APIs in Outlook mobile, see
|
|
18272
|
-
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
|
|
18273
|
-
*
|
|
18274
18203
|
* @param name - The name of the `ItemHasRegularExpressionMatch` rule element that defines the filter to match.
|
|
18275
18204
|
*/
|
|
18276
18205
|
getSelectedEntities(): Entities;
|
|
@@ -18280,9 +18209,9 @@ declare namespace Office {
|
|
|
18280
18209
|
*
|
|
18281
18210
|
* @returns
|
|
18282
18211
|
* An object that contains arrays of strings that match the regular expressions defined in the manifest XML file.
|
|
18283
|
-
* The name of each array is equal to the corresponding value of the `RegExName` attribute of the matching `ItemHasRegularExpressionMatch` rule
|
|
18284
|
-
*
|
|
18285
|
-
*
|
|
18212
|
+
* The name of each array is equal to the corresponding value of the `RegExName` attribute of the matching `ItemHasRegularExpressionMatch` rule.
|
|
18213
|
+
* For an `ItemHasRegularExpressionMatch` rule, a matching string has to occur in the property of the item that's specified by that rule.
|
|
18214
|
+
* The `PropertyName` simple type defines the supported properties.
|
|
18286
18215
|
*
|
|
18287
18216
|
* @remarks
|
|
18288
18217
|
* [Api set: Mailbox 1.6]
|
|
@@ -18293,12 +18222,10 @@ declare namespace Office {
|
|
|
18293
18222
|
*
|
|
18294
18223
|
* **Important**:
|
|
18295
18224
|
*
|
|
18296
|
-
* - Entity-based contextual Outlook add-ins
|
|
18297
|
-
*
|
|
18298
|
-
*
|
|
18299
|
-
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/
|
|
18300
|
-
* To learn more about the retirement of entity-based contextual add-ins, see
|
|
18301
|
-
* {@link https://devblogs.microsoft.com/microsoft365dev/retirement-of-entity-based-contextual-outlook-add-ins | Retirement of entity-based contextual Outlook add-ins}.
|
|
18225
|
+
* - Entity-based contextual Outlook add-ins are now retired. However, regular expression rules are still supported.
|
|
18226
|
+
* We recommend updating your contextual add-in to use regular expression rules as an alternative solution.
|
|
18227
|
+
* For guidance on how to implement these rules, see
|
|
18228
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins | Contextual Outlook add-ins}.
|
|
18302
18229
|
*
|
|
18303
18230
|
* - 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},
|
|
18304
18231
|
* which isn't supported by the {@link https://learn.microsoft.com/office/dev/add-ins/develop/json-manifest-overview | unified manifest for Microsoft 365}.
|
|
@@ -18772,48 +18699,54 @@ declare namespace Office {
|
|
|
18772
18699
|
* Represents a phone number identified in an item. Read mode only.
|
|
18773
18700
|
*
|
|
18774
18701
|
* An array of `PhoneNumber` objects containing the phone numbers found in an email message is returned in the `phoneNumbers` property of the
|
|
18775
|
-
* `Entities` object that
|
|
18702
|
+
* `Entities` object that's returned when you call the `getEntities` method on the selected item.
|
|
18703
|
+
*
|
|
18704
|
+
* **Warning**: Entity-based contextual Outlook add-ins are now retired. However, regular expression rules are still supported.
|
|
18705
|
+
* We recommend updating your contextual add-in to use regular expression rules as an alternative solution.
|
|
18706
|
+
* For guidance on how to implement these rules, see
|
|
18707
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins | Contextual Outlook add-ins}.
|
|
18708
|
+
*
|
|
18709
|
+
* @deprecated Use {@link https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins | regular expression rules} instead.
|
|
18776
18710
|
*
|
|
18777
18711
|
* @remarks
|
|
18778
18712
|
*
|
|
18779
18713
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
18780
18714
|
*
|
|
18781
18715
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Read
|
|
18782
|
-
*
|
|
18783
|
-
* **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
|
|
18784
|
-
* 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.
|
|
18785
|
-
* The following APIs will also be retired.
|
|
18786
|
-
*
|
|
18787
|
-
* - `Office.context.mailbox.item.getEntities`
|
|
18788
|
-
* - `Office.context.mailbox.item.getEntitiesByType`
|
|
18789
|
-
* - `Office.context.mailbox.item.getFilteredEntitiesByName`
|
|
18790
|
-
* - `Office.context.mailbox.item.getSelectedEntities`
|
|
18791
|
-
*
|
|
18792
|
-
* To help minimize potential disruptions, the following will still be supported after entity-based contextual add-ins are retired.
|
|
18793
|
-
*
|
|
18794
|
-
* - An alternative implementation of the **Join Meeting** button, which is activated by online meeting add-ins, is being developed. Once support for
|
|
18795
|
-
* entity-based contextual add-ins ends, online meeting add-ins will automatically transition to the alternative implementation to activate the
|
|
18796
|
-
* **Join Meeting** button.
|
|
18797
|
-
*
|
|
18798
|
-
* - Regular expression rules will continue to be supported after entity-based contextual add-ins are retired. We recommend updating your contextual add-in
|
|
18799
|
-
* to use regular expression rules as an alternative solution. For guidance on how to implement these rules, see
|
|
18800
|
-
* {@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}.
|
|
18801
|
-
*
|
|
18802
|
-
* For more information, see
|
|
18803
|
-
* {@link https://devblogs.microsoft.com/microsoft365dev/retirement-of-entity-based-contextual-outlook-add-ins | Retirement of entity-based contextual Outlook add-ins}.
|
|
18804
18716
|
*/
|
|
18805
18717
|
interface PhoneNumber {
|
|
18806
18718
|
/**
|
|
18807
18719
|
* Gets a string containing a phone number. This string contains only the digits of the telephone number and excludes characters
|
|
18808
18720
|
* like parentheses and hyphens, if they exist in the original item.
|
|
18721
|
+
*
|
|
18722
|
+
* **Warning**: Entity-based contextual Outlook add-ins are now retired. However, regular expression rules are still supported.
|
|
18723
|
+
* We recommend updating your contextual add-in to use regular expression rules as an alternative solution.
|
|
18724
|
+
* For guidance on how to implement these rules, see
|
|
18725
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins | Contextual Outlook add-ins}.
|
|
18726
|
+
*
|
|
18727
|
+
* @deprecated Use {@link https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins | regular expression rules} instead.
|
|
18809
18728
|
*/
|
|
18810
18729
|
phoneString: string;
|
|
18811
18730
|
/**
|
|
18812
18731
|
* Gets the text that was identified in an item as a phone number.
|
|
18732
|
+
*
|
|
18733
|
+
* **Warning**: Entity-based contextual Outlook add-ins are now retired. However, regular expression rules are still supported.
|
|
18734
|
+
* We recommend updating your contextual add-in to use regular expression rules as an alternative solution.
|
|
18735
|
+
* For guidance on how to implement these rules, see
|
|
18736
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins | Contextual Outlook add-ins}.
|
|
18737
|
+
*
|
|
18738
|
+
* @deprecated Use {@link https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins | regular expression rules} instead.
|
|
18813
18739
|
*/
|
|
18814
18740
|
originalPhoneString: string;
|
|
18815
18741
|
/**
|
|
18816
18742
|
* Gets a string that identifies the type of phone number: Home, Work, Mobile, Unspecified.
|
|
18743
|
+
*
|
|
18744
|
+
* **Warning**: Entity-based contextual Outlook add-ins are now retired. However, regular expression rules are still supported.
|
|
18745
|
+
* We recommend updating your contextual add-in to use regular expression rules as an alternative solution.
|
|
18746
|
+
* For guidance on how to implement these rules, see
|
|
18747
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins | Contextual Outlook add-ins}.
|
|
18748
|
+
*
|
|
18749
|
+
* @deprecated Use {@link https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins | regular expression rules} instead.
|
|
18817
18750
|
*/
|
|
18818
18751
|
type: string;
|
|
18819
18752
|
}
|
|
@@ -20765,7 +20698,14 @@ declare namespace Office {
|
|
|
20765
20698
|
* Represents a suggested task identified in an item. Read mode only.
|
|
20766
20699
|
*
|
|
20767
20700
|
* The list of tasks suggested in an email message is returned in the `taskSuggestions` property of the {@link Office.Entities | Entities} object
|
|
20768
|
-
* that
|
|
20701
|
+
* that's returned when the `getEntities` or `getEntitiesByType` method is called on the active item.
|
|
20702
|
+
*
|
|
20703
|
+
* **Warning**: Entity-based contextual Outlook add-ins are now retired. However, regular expression rules are still supported.
|
|
20704
|
+
* We recommend updating your contextual add-in to use regular expression rules as an alternative solution.
|
|
20705
|
+
* For guidance on how to implement these rules, see
|
|
20706
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins | Contextual Outlook add-ins}.
|
|
20707
|
+
*
|
|
20708
|
+
* @deprecated Use {@link https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins | regular expression rules} instead.
|
|
20769
20709
|
*
|
|
20770
20710
|
* @remarks
|
|
20771
20711
|
*
|
|
@@ -20776,10 +20716,24 @@ declare namespace Office {
|
|
|
20776
20716
|
interface TaskSuggestion {
|
|
20777
20717
|
/**
|
|
20778
20718
|
* Gets the users that should be assigned a suggested task.
|
|
20719
|
+
*
|
|
20720
|
+
* **Warning**: Entity-based contextual Outlook add-ins are now retired. However, regular expression rules are still supported.
|
|
20721
|
+
* We recommend updating your contextual add-in to use regular expression rules as an alternative solution.
|
|
20722
|
+
* For guidance on how to implement these rules, see
|
|
20723
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins | Contextual Outlook add-ins}.
|
|
20724
|
+
*
|
|
20725
|
+
* @deprecated Use {@link https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins | regular expression rules} instead.
|
|
20779
20726
|
*/
|
|
20780
20727
|
assignees: EmailUser[];
|
|
20781
20728
|
/**
|
|
20782
20729
|
* Gets the text of an item that was identified as a task suggestion.
|
|
20730
|
+
*
|
|
20731
|
+
* **Warning**: Entity-based contextual Outlook add-ins are now retired. However, regular expression rules are still supported.
|
|
20732
|
+
* We recommend updating your contextual add-in to use regular expression rules as an alternative solution.
|
|
20733
|
+
* For guidance on how to implement these rules, see
|
|
20734
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins | Contextual Outlook add-ins}.
|
|
20735
|
+
*
|
|
20736
|
+
* @deprecated Use {@link https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins | regular expression rules} instead.
|
|
20783
20737
|
*/
|
|
20784
20738
|
taskString: string;
|
|
20785
20739
|
}
|
office-js/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@types/office-js",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.403",
|
|
4
4
|
"description": "TypeScript definitions for office-js",
|
|
5
5
|
"homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-js",
|
|
6
6
|
"license": "MIT",
|
|
@@ -45,6 +45,6 @@
|
|
|
45
45
|
},
|
|
46
46
|
"scripts": {},
|
|
47
47
|
"dependencies": {},
|
|
48
|
-
"typesPublisherContentHash": "
|
|
48
|
+
"typesPublisherContentHash": "73f5aed3bcdb2e3f7f30b3a200189ccf4d5cd4598244af75b7df50223fee6689",
|
|
49
49
|
"typeScriptVersion": "4.8"
|
|
50
50
|
}
|