@types/office-js-preview 1.0.439 → 1.0.441
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-preview/README.md +1 -1
- office-js-preview/index.d.ts +355 -48
- office-js-preview/package.json +2 -2
office-js-preview/README.md
CHANGED
|
@@ -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:
|
|
11
|
+
* Last updated: Thu, 18 Jan 2024 21:07:10 GMT
|
|
12
12
|
* Dependencies: none
|
|
13
13
|
|
|
14
14
|
# Credits
|
office-js-preview/index.d.ts
CHANGED
|
@@ -8468,6 +8468,8 @@ declare namespace Office {
|
|
|
8468
8468
|
/**
|
|
8469
8469
|
* Treat the item as personal.
|
|
8470
8470
|
*
|
|
8471
|
+
* **Important**: The Personal sensitivity level is only supported in Outlook on Windows.
|
|
8472
|
+
*
|
|
8471
8473
|
* @remarks
|
|
8472
8474
|
* [Api set: Mailbox preview]
|
|
8473
8475
|
*/
|
|
@@ -8482,6 +8484,8 @@ declare namespace Office {
|
|
|
8482
8484
|
/**
|
|
8483
8485
|
* Treat the item as confidential.
|
|
8484
8486
|
*
|
|
8487
|
+
* **Important**: The Confidential sensitivity level is only supported in Outlook on Windows.
|
|
8488
|
+
*
|
|
8485
8489
|
* @remarks
|
|
8486
8490
|
* [Api set: Mailbox preview]
|
|
8487
8491
|
*/
|
|
@@ -8792,6 +8796,21 @@ declare namespace Office {
|
|
|
8792
8796
|
* @remarks
|
|
8793
8797
|
*
|
|
8794
8798
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read
|
|
8799
|
+
*
|
|
8800
|
+
* **Important**: Entity-based contextual Outlook add-ins will be retired in Q2 of 2024. Once retired, contextual add-ins will no longer be able to detect
|
|
8801
|
+
* entities in mail items to perform tasks on them. To help minimize potential disruptions, the following will still be supported after entity-based
|
|
8802
|
+
* contextual add-ins are retired.
|
|
8803
|
+
*
|
|
8804
|
+
* - An alternative implementation of the **Join Meeting** button, which is activated by online meeting add-ins, is being developed. Once support for
|
|
8805
|
+
* entity-based contextual add-ins ends, online meeting add-ins will automatically transition to the alternative implementation to activate the
|
|
8806
|
+
* **Join Meeting** button.
|
|
8807
|
+
*
|
|
8808
|
+
* - Regular expression rules will continue to be supported after entity-based contextual add-ins are retired. We recommend updating your contextual add-in
|
|
8809
|
+
* to use regular expression rules as an alternative solution. For guidance on how to implement these rules, see
|
|
8810
|
+
* {@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}.
|
|
8811
|
+
*
|
|
8812
|
+
* For more information, see
|
|
8813
|
+
* {@link https://devblogs.microsoft.com/microsoft365dev/retirement-of-entity-based-contextual-outlook-add-ins | Retirement of entity-based contextual Outlook add-ins}.
|
|
8795
8814
|
*/
|
|
8796
8815
|
enum EntityType {
|
|
8797
8816
|
/**
|
|
@@ -10022,6 +10041,8 @@ declare namespace Office {
|
|
|
10022
10041
|
*
|
|
10023
10042
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Organizer
|
|
10024
10043
|
*
|
|
10044
|
+
* **Important**: Outlook on Mac, Outlook on the web, and the new Outlook on Windows (preview) only support Normal and Private sensitivity levels.
|
|
10045
|
+
*
|
|
10025
10046
|
* @beta
|
|
10026
10047
|
*/
|
|
10027
10048
|
sensitivity: Sensitivity;
|
|
@@ -11517,6 +11538,8 @@ declare namespace Office {
|
|
|
11517
11538
|
*
|
|
11518
11539
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee
|
|
11519
11540
|
*
|
|
11541
|
+
* **Important**: Outlook on Mac, Outlook on the web, and the new Outlook on Windows (preview) only support Normal and Private sensitivity levels.
|
|
11542
|
+
*
|
|
11520
11543
|
* @beta
|
|
11521
11544
|
*/
|
|
11522
11545
|
sensitivity: MailboxEnums.AppointmentSensitivityType;
|
|
@@ -11792,7 +11815,23 @@ declare namespace Office {
|
|
|
11792
11815
|
*
|
|
11793
11816
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee
|
|
11794
11817
|
*
|
|
11795
|
-
* **Important**:
|
|
11818
|
+
* **Important**:
|
|
11819
|
+
*
|
|
11820
|
+
* - Entity-based contextual Outlook add-ins will be retired in Q2 of 2024. Once retired, contextual add-ins will no longer be able to detect
|
|
11821
|
+
* entities in mail items to perform tasks on them.
|
|
11822
|
+
*
|
|
11823
|
+
* An alternative implementation of the **Join Meeting** button, which is activated by online meeting add-ins, is being developed.
|
|
11824
|
+
* Once support for entity-based contextual add-ins ends, online meeting add-ins will automatically transition to the alternative implementation
|
|
11825
|
+
* to activate the **Join Meeting** button.
|
|
11826
|
+
*
|
|
11827
|
+
* Regular expression rules will continue to be supported after entity-based contextual add-ins are retired. We recommend updating your contextual add-in
|
|
11828
|
+
* to use regular expression rules as an alternative solution. For guidance on how to implement these rules, see
|
|
11829
|
+
* {@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}.
|
|
11830
|
+
*
|
|
11831
|
+
* For more information, see
|
|
11832
|
+
* {@link https://devblogs.microsoft.com/microsoft365dev/retirement-of-entity-based-contextual-outlook-add-ins | Retirement of entity-based contextual Outlook add-ins}.
|
|
11833
|
+
*
|
|
11834
|
+
* - This method isn't supported in Outlook on Android or on iOS. For more information on supported APIs in Outlook mobile, see
|
|
11796
11835
|
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
|
|
11797
11836
|
*/
|
|
11798
11837
|
getEntities(): Entities;
|
|
@@ -11811,7 +11850,23 @@ declare namespace Office {
|
|
|
11811
11850
|
*
|
|
11812
11851
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee
|
|
11813
11852
|
*
|
|
11814
|
-
* **Important**:
|
|
11853
|
+
* **Important**:
|
|
11854
|
+
*
|
|
11855
|
+
* - 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
|
|
11856
|
+
* entities in mail items to perform tasks on them.
|
|
11857
|
+
*
|
|
11858
|
+
* An alternative implementation of the **Join Meeting** button, which is activated by online meeting add-ins, is being developed.
|
|
11859
|
+
* Once support for entity-based contextual add-ins ends, online meeting add-ins will automatically transition to the alternative implementation
|
|
11860
|
+
* to activate the **Join Meeting** button.
|
|
11861
|
+
*
|
|
11862
|
+
* Regular expression rules will continue to be supported after entity-based contextual add-ins are retired. We recommend updating your contextual add-in
|
|
11863
|
+
* to use regular expression rules as an alternative solution. For guidance on how to implement these rules, see
|
|
11864
|
+
* {@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}.
|
|
11865
|
+
*
|
|
11866
|
+
* For more information, see
|
|
11867
|
+
* {@link https://devblogs.microsoft.com/microsoft365dev/retirement-of-entity-based-contextual-outlook-add-ins | Retirement of entity-based contextual Outlook add-ins}.
|
|
11868
|
+
*
|
|
11869
|
+
* - This method isn't supported in Outlook on Android or on iOS. For more information on supported APIs in Outlook mobile, see
|
|
11815
11870
|
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
|
|
11816
11871
|
*
|
|
11817
11872
|
* @param entityType - One of the `EntityType` enumeration values.
|
|
@@ -11880,8 +11935,22 @@ declare namespace Office {
|
|
|
11880
11935
|
*
|
|
11881
11936
|
* **Important**:
|
|
11882
11937
|
*
|
|
11938
|
+
* - 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
|
|
11939
|
+
* entities in mail items to perform tasks on them.
|
|
11940
|
+
*
|
|
11941
|
+
* An alternative implementation of the **Join Meeting** button, which is activated by online meeting add-ins, is being developed.
|
|
11942
|
+
* Once support for entity-based contextual add-ins ends, online meeting add-ins will automatically transition to the alternative implementation
|
|
11943
|
+
* to activate the **Join Meeting** button.
|
|
11944
|
+
*
|
|
11945
|
+
* Regular expression rules will continue to be supported after entity-based contextual add-ins are retired. We recommend updating your contextual add-in
|
|
11946
|
+
* to use regular expression rules as an alternative solution. For guidance on how to implement these rules, see
|
|
11947
|
+
* {@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}.
|
|
11948
|
+
*
|
|
11949
|
+
* For more information, see
|
|
11950
|
+
* {@link https://devblogs.microsoft.com/microsoft365dev/retirement-of-entity-based-contextual-outlook-add-ins | Retirement of entity-based contextual Outlook add-ins}.
|
|
11951
|
+
*
|
|
11883
11952
|
* - This method is used with the {@link https://learn.microsoft.com/office/dev/add-ins/outlook/activation-rules | activation rules feature for Outlook add-ins},
|
|
11884
|
-
* which isn't supported by the {@link https://learn.microsoft.com/office/dev/add-ins/develop/json-manifest-overview |
|
|
11953
|
+
* which isn't supported by the {@link https://learn.microsoft.com/office/dev/add-ins/develop/json-manifest-overview | unified manifest for Microsoft 365 (preview)}.
|
|
11885
11954
|
*
|
|
11886
11955
|
* - This method isn't supported in Outlook on Android or on iOS. For more information on supported APIs in Outlook mobile, see
|
|
11887
11956
|
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
|
|
@@ -11941,8 +12010,22 @@ declare namespace Office {
|
|
|
11941
12010
|
*
|
|
11942
12011
|
* **Important**:
|
|
11943
12012
|
*
|
|
12013
|
+
* - 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
|
|
12014
|
+
* entities in mail items to perform tasks on them.
|
|
12015
|
+
*
|
|
12016
|
+
* An alternative implementation of the **Join Meeting** button, which is activated by online meeting add-ins, is being developed.
|
|
12017
|
+
* Once support for entity-based contextual add-ins ends, online meeting add-ins will automatically transition to the alternative implementation
|
|
12018
|
+
* to activate the **Join Meeting** button.
|
|
12019
|
+
*
|
|
12020
|
+
* Regular expression rules will continue to be supported after entity-based contextual add-ins are retired. We recommend updating your contextual add-in
|
|
12021
|
+
* to use regular expression rules as an alternative solution. For guidance on how to implement these rules, see
|
|
12022
|
+
* {@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}.
|
|
12023
|
+
*
|
|
12024
|
+
* For more information, see
|
|
12025
|
+
* {@link https://devblogs.microsoft.com/microsoft365dev/retirement-of-entity-based-contextual-outlook-add-ins | Retirement of entity-based contextual Outlook add-ins}.
|
|
12026
|
+
*
|
|
11944
12027
|
* - This method is used with the {@link https://learn.microsoft.com/office/dev/add-ins/outlook/activation-rules | activation rules feature for Outlook add-ins},
|
|
11945
|
-
* which isn't supported by the {@link https://learn.microsoft.com/office/dev/add-ins/develop/json-manifest-overview |
|
|
12028
|
+
* which isn't supported by the {@link https://learn.microsoft.com/office/dev/add-ins/develop/json-manifest-overview | unified manifest for Microsoft 365 (preview)}.
|
|
11946
12029
|
*
|
|
11947
12030
|
* - If you specify an `ItemHasRegularExpressionMatch` rule on the body property of an item, the regular expression should further filter the body
|
|
11948
12031
|
* and shouldn't attempt to return the entire body of the item. Using a regular expression such as `.*` to obtain the entire body of an item doesn't always return the expected results.
|
|
@@ -11968,8 +12051,22 @@ declare namespace Office {
|
|
|
11968
12051
|
*
|
|
11969
12052
|
* **Important**:
|
|
11970
12053
|
*
|
|
12054
|
+
* - 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
|
|
12055
|
+
* entities in mail items to perform tasks on them.
|
|
12056
|
+
*
|
|
12057
|
+
* An alternative implementation of the **Join Meeting** button, which is activated by online meeting add-ins, is being developed.
|
|
12058
|
+
* Once support for entity-based contextual add-ins ends, online meeting add-ins will automatically transition to the alternative implementation
|
|
12059
|
+
* to activate the **Join Meeting** button.
|
|
12060
|
+
*
|
|
12061
|
+
* Regular expression rules will continue to be supported after entity-based contextual add-ins are retired. We recommend updating your contextual add-in
|
|
12062
|
+
* to use regular expression rules as an alternative solution. For guidance on how to implement these rules, see
|
|
12063
|
+
* {@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}.
|
|
12064
|
+
*
|
|
12065
|
+
* For more information, see
|
|
12066
|
+
* {@link https://devblogs.microsoft.com/microsoft365dev/retirement-of-entity-based-contextual-outlook-add-ins | Retirement of entity-based contextual Outlook add-ins}.
|
|
12067
|
+
*
|
|
11971
12068
|
* - This method is used with the {@link https://learn.microsoft.com/office/dev/add-ins/outlook/activation-rules | activation rules feature for Outlook add-ins},
|
|
11972
|
-
* which isn't supported by the {@link https://learn.microsoft.com/office/dev/add-ins/develop/json-manifest-overview |
|
|
12069
|
+
* which isn't supported by the {@link https://learn.microsoft.com/office/dev/add-ins/develop/json-manifest-overview | unified manifest for Microsoft 365 (preview)}.
|
|
11973
12070
|
*
|
|
11974
12071
|
* - If you specify an `ItemHasRegularExpressionMatch` rule on the body property of an item, the regular expression should further filter the body
|
|
11975
12072
|
* and shouldn't attempt to return the entire body of the item. Using a regular expression such as `.*` to obtain the entire body of an item doesn't always return the expected results.
|
|
@@ -11983,10 +12080,6 @@ declare namespace Office {
|
|
|
11983
12080
|
getRegExMatchesByName(name: string): string[];
|
|
11984
12081
|
/**
|
|
11985
12082
|
* Gets the entities found in a highlighted match a user has selected. Highlighted matches apply to contextual add-ins.
|
|
11986
|
-
*
|
|
11987
|
-
* **Note**: This method is used with the {@link https://learn.microsoft.com/office/dev/add-ins/outlook/activation-rules | activation rules feature for Outlook add-ins}, which isn't supported by the {@link https://learn.microsoft.com/office/dev/add-ins/develop/json-manifest-overview | Teams manifest for Office Add-ins (preview)}.
|
|
11988
|
-
*
|
|
11989
|
-
* **Note**: This method is not supported in Outlook on iOS or Android.
|
|
11990
12083
|
*
|
|
11991
12084
|
* @remarks
|
|
11992
12085
|
* [Api set: Mailbox 1.6]
|
|
@@ -11995,31 +12088,39 @@ declare namespace Office {
|
|
|
11995
12088
|
*
|
|
11996
12089
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee
|
|
11997
12090
|
*
|
|
12091
|
+
* **Important**:
|
|
12092
|
+
*
|
|
12093
|
+
* - 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
|
|
12094
|
+
* entities in mail items to perform tasks on them.
|
|
12095
|
+
*
|
|
12096
|
+
* An alternative implementation of the **Join Meeting** button, which is activated by online meeting add-ins, is being developed.
|
|
12097
|
+
* Once support for entity-based contextual add-ins ends, online meeting add-ins will automatically transition to the alternative implementation
|
|
12098
|
+
* to activate the **Join Meeting** button.
|
|
12099
|
+
*
|
|
12100
|
+
* Regular expression rules will continue to be supported after entity-based contextual add-ins are retired. We recommend updating your contextual add-in
|
|
12101
|
+
* to use regular expression rules as an alternative solution. For guidance on how to implement these rules, see
|
|
12102
|
+
* {@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}.
|
|
12103
|
+
*
|
|
12104
|
+
* For more information, see
|
|
12105
|
+
* {@link https://devblogs.microsoft.com/microsoft365dev/retirement-of-entity-based-contextual-outlook-add-ins | Retirement of entity-based contextual Outlook add-ins}.
|
|
12106
|
+
*
|
|
12107
|
+
* - 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},
|
|
12108
|
+
* which isn't supported by the {@link https://learn.microsoft.com/office/dev/add-ins/develop/json-manifest-overview | unified manifest for Microsoft 365 (preview)}.
|
|
12109
|
+
*
|
|
12110
|
+
* - This method isn't supported in Outlook on iOS or Android.
|
|
12111
|
+
*
|
|
11998
12112
|
* @param name - The name of the `ItemHasRegularExpressionMatch` rule element that defines the filter to match.
|
|
11999
12113
|
*/
|
|
12000
12114
|
getSelectedEntities(): Entities;
|
|
12001
12115
|
/**
|
|
12002
12116
|
* Returns string values in a highlighted match that match the regular expressions defined in an XML manifest file.
|
|
12003
12117
|
* Highlighted matches apply to contextual add-ins.
|
|
12004
|
-
*
|
|
12005
|
-
* **Note**: This method is used with the {@link https://learn.microsoft.com/office/dev/add-ins/outlook/activation-rules | activation rules feature for Outlook add-ins}, which isn't supported by the {@link https://learn.microsoft.com/office/dev/add-ins/develop/json-manifest-overview | Teams manifest for Office Add-ins (preview)}.
|
|
12006
|
-
*
|
|
12007
|
-
* The `getSelectedRegExMatches` method returns the strings that match the regular expression defined in each `ItemHasRegularExpressionMatch` or
|
|
12008
|
-
* `ItemHasKnownEntity` rule element in the manifest XML file.
|
|
12009
|
-
* For an `ItemHasRegularExpressionMatch` rule, a matching string has to occur in the property of the item that is specified by that rule.
|
|
12010
|
-
* The `PropertyName` simple type defines the supported properties.
|
|
12011
|
-
*
|
|
12012
|
-
* If you specify an `ItemHasRegularExpressionMatch` rule on the body property of an item, the regular expression should further filter the body
|
|
12013
|
-
* and should not attempt to return the entire body of the item.
|
|
12014
|
-
* Using a regular expression such as .* to obtain the entire body of an item does not always return the expected results.
|
|
12015
|
-
* Instead, use the `Body.getAsync` method to retrieve the entire body.
|
|
12016
|
-
*
|
|
12017
|
-
* **Note**: This method is not supported in Outlook on iOS or Android.
|
|
12018
12118
|
*
|
|
12019
12119
|
* @returns
|
|
12020
12120
|
* An object that contains arrays of strings that match the regular expressions defined in the manifest XML file.
|
|
12021
|
-
* The name of each array is equal to the corresponding value of the `RegExName` attribute of the matching `ItemHasRegularExpressionMatch` rule
|
|
12022
|
-
*
|
|
12121
|
+
* The name of each array is equal to the corresponding value of the `RegExName` attribute of the matching `ItemHasRegularExpressionMatch` rule or
|
|
12122
|
+
* the `FilterName` attribute of the matching `ItemHasKnownEntity` rule. For an `ItemHasRegularExpressionMatch` rule, a matching string has to occur
|
|
12123
|
+
* in the property of the item that is specified by that rule. The `PropertyName` simple type defines the supported properties.
|
|
12023
12124
|
*
|
|
12024
12125
|
* @remarks
|
|
12025
12126
|
* [Api set: Mailbox 1.6]
|
|
@@ -12027,6 +12128,31 @@ declare namespace Office {
|
|
|
12027
12128
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
12028
12129
|
*
|
|
12029
12130
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee
|
|
12131
|
+
*
|
|
12132
|
+
* **Important**:
|
|
12133
|
+
*
|
|
12134
|
+
* - 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
|
|
12135
|
+
* entities in mail items to perform tasks on them.
|
|
12136
|
+
*
|
|
12137
|
+
* An alternative implementation of the **Join Meeting** button, which is activated by online meeting add-ins, is being developed.
|
|
12138
|
+
* Once support for entity-based contextual add-ins ends, online meeting add-ins will automatically transition to the alternative implementation
|
|
12139
|
+
* to activate the **Join Meeting** button.
|
|
12140
|
+
*
|
|
12141
|
+
* Regular expression rules will continue to be supported after entity-based contextual add-ins are retired. We recommend updating your contextual add-in
|
|
12142
|
+
* to use regular expression rules as an alternative solution. For guidance on how to implement these rules, see
|
|
12143
|
+
* {@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}.
|
|
12144
|
+
*
|
|
12145
|
+
* For more information, see
|
|
12146
|
+
* {@link https://devblogs.microsoft.com/microsoft365dev/retirement-of-entity-based-contextual-outlook-add-ins | Retirement of entity-based contextual Outlook add-ins}.
|
|
12147
|
+
*
|
|
12148
|
+
* - 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},
|
|
12149
|
+
* which isn't supported by the {@link https://learn.microsoft.com/office/dev/add-ins/develop/json-manifest-overview | unified manifest for Microsoft 365 (preview)}.
|
|
12150
|
+
*
|
|
12151
|
+
* - This method isn't supported in Outlook on iOS or Android.
|
|
12152
|
+
*
|
|
12153
|
+
* - If you specify an `ItemHasRegularExpressionMatch` rule on the body property of an item, the regular expression should further filter the body
|
|
12154
|
+
* and shouldn't attempt to return the entire body of the item. Using a regular expression such as .* to obtain the entire body of an item doesn't always return the
|
|
12155
|
+
* expected results. Instead, use the `Body.getAsync` method to retrieve the entire body.
|
|
12030
12156
|
*/
|
|
12031
12157
|
getSelectedRegExMatches(): any;
|
|
12032
12158
|
/**
|
|
@@ -13056,6 +13182,21 @@ declare namespace Office {
|
|
|
13056
13182
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **restricted**
|
|
13057
13183
|
*
|
|
13058
13184
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Read
|
|
13185
|
+
*
|
|
13186
|
+
* **Important**: Entity-based contextual Outlook add-ins will be retired in Q2 of 2024. Once retired, contextual add-ins will no longer be able to detect
|
|
13187
|
+
* entities in mail items to perform tasks on them. To help minimize potential disruptions, the following will still be supported after entity-based
|
|
13188
|
+
* contextual add-ins are retired.
|
|
13189
|
+
*
|
|
13190
|
+
* - An alternative implementation of the **Join Meeting** button, which is activated by online meeting add-ins, is being developed. Once support for
|
|
13191
|
+
* entity-based contextual add-ins ends, online meeting add-ins will automatically transition to the alternative implementation to activate the
|
|
13192
|
+
* **Join Meeting** button.
|
|
13193
|
+
*
|
|
13194
|
+
* - Regular expression rules will continue to be supported after entity-based contextual add-ins are retired. We recommend updating your contextual add-in
|
|
13195
|
+
* to use regular expression rules as an alternative solution. For guidance on how to implement these rules, see
|
|
13196
|
+
* {@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}.
|
|
13197
|
+
*
|
|
13198
|
+
* For more information, see
|
|
13199
|
+
* {@link https://devblogs.microsoft.com/microsoft365dev/retirement-of-entity-based-contextual-outlook-add-ins | Retirement of entity-based contextual Outlook add-ins}.
|
|
13059
13200
|
*/
|
|
13060
13201
|
interface Contact {
|
|
13061
13202
|
/**
|
|
@@ -13779,6 +13920,21 @@ declare namespace Office {
|
|
|
13779
13920
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
13780
13921
|
*
|
|
13781
13922
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Read
|
|
13923
|
+
*
|
|
13924
|
+
* **Important**: Entity-based contextual Outlook add-ins will be retired in Q2 of 2024. Once retired, contextual add-ins will no longer be able to detect
|
|
13925
|
+
* entities in mail items to perform tasks on them. To help minimize potential disruptions, the following will still be supported after entity-based
|
|
13926
|
+
* contextual add-ins are retired.
|
|
13927
|
+
*
|
|
13928
|
+
* - An alternative implementation of the **Join Meeting** button, which is activated by online meeting add-ins, is being developed. Once support for
|
|
13929
|
+
* entity-based contextual add-ins ends, online meeting add-ins will automatically transition to the alternative implementation to activate the
|
|
13930
|
+
* **Join Meeting** button.
|
|
13931
|
+
*
|
|
13932
|
+
* - Regular expression rules will continue to be supported after entity-based contextual add-ins are retired. We recommend updating your contextual add-in
|
|
13933
|
+
* to use regular expression rules as an alternative solution. For guidance on how to implement these rules, see
|
|
13934
|
+
* {@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}.
|
|
13935
|
+
*
|
|
13936
|
+
* For more information, see
|
|
13937
|
+
* {@link https://devblogs.microsoft.com/microsoft365dev/retirement-of-entity-based-contextual-outlook-add-ins | Retirement of entity-based contextual Outlook add-ins}.
|
|
13782
13938
|
*/
|
|
13783
13939
|
interface Entities {
|
|
13784
13940
|
/**
|
|
@@ -15460,6 +15616,21 @@ declare namespace Office {
|
|
|
15460
15616
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
15461
15617
|
*
|
|
15462
15618
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Read
|
|
15619
|
+
*
|
|
15620
|
+
* **Important**: Entity-based contextual Outlook add-ins will be retired in Q2 of 2024. Once retired, contextual add-ins will no longer be able to detect
|
|
15621
|
+
* entities in mail items to perform tasks on them. To help minimize potential disruptions, the following will still be supported after entity-based
|
|
15622
|
+
* contextual add-ins are retired.
|
|
15623
|
+
*
|
|
15624
|
+
* - An alternative implementation of the **Join Meeting** button, which is activated by online meeting add-ins, is being developed. Once support for
|
|
15625
|
+
* entity-based contextual add-ins ends, online meeting add-ins will automatically transition to the alternative implementation to activate the
|
|
15626
|
+
* **Join Meeting** button.
|
|
15627
|
+
*
|
|
15628
|
+
* - Regular expression rules will continue to be supported after entity-based contextual add-ins are retired. We recommend updating your contextual add-in
|
|
15629
|
+
* to use regular expression rules as an alternative solution. For guidance on how to implement these rules, see
|
|
15630
|
+
* {@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}.
|
|
15631
|
+
*
|
|
15632
|
+
* For more information, see
|
|
15633
|
+
* {@link https://devblogs.microsoft.com/microsoft365dev/retirement-of-entity-based-contextual-outlook-add-ins | Retirement of entity-based contextual Outlook add-ins}.
|
|
15463
15634
|
*/
|
|
15464
15635
|
interface MeetingSuggestion {
|
|
15465
15636
|
/**
|
|
@@ -17537,7 +17708,23 @@ declare namespace Office {
|
|
|
17537
17708
|
*
|
|
17538
17709
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee
|
|
17539
17710
|
*
|
|
17540
|
-
* **Important**:
|
|
17711
|
+
* **Important**:
|
|
17712
|
+
*
|
|
17713
|
+
* - 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
|
|
17714
|
+
* entities in mail items to perform tasks on them.
|
|
17715
|
+
*
|
|
17716
|
+
* An alternative implementation of the **Join Meeting** button, which is activated by online meeting add-ins, is being developed.
|
|
17717
|
+
* Once support for entity-based contextual add-ins ends, online meeting add-ins will automatically transition to the alternative implementation
|
|
17718
|
+
* to activate the **Join Meeting** button.
|
|
17719
|
+
*
|
|
17720
|
+
* Regular expression rules will continue to be supported after entity-based contextual add-ins are retired. We recommend updating your contextual add-in
|
|
17721
|
+
* to use regular expression rules as an alternative solution. For guidance on how to implement these rules, see
|
|
17722
|
+
* {@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}.
|
|
17723
|
+
*
|
|
17724
|
+
* For more information, see
|
|
17725
|
+
* {@link https://devblogs.microsoft.com/microsoft365dev/retirement-of-entity-based-contextual-outlook-add-ins | Retirement of entity-based contextual Outlook add-ins}.
|
|
17726
|
+
*
|
|
17727
|
+
* - This method isn't supported in Outlook on Android or on iOS. For more information on supported APIs in Outlook mobile, see
|
|
17541
17728
|
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
|
|
17542
17729
|
*/
|
|
17543
17730
|
getEntities(): Entities;
|
|
@@ -17556,7 +17743,23 @@ declare namespace Office {
|
|
|
17556
17743
|
*
|
|
17557
17744
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read
|
|
17558
17745
|
*
|
|
17559
|
-
* **Important**:
|
|
17746
|
+
* **Important**:
|
|
17747
|
+
*
|
|
17748
|
+
* - 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
|
|
17749
|
+
* entities in mail items to perform tasks on them.
|
|
17750
|
+
*
|
|
17751
|
+
* An alternative implementation of the **Join Meeting** button, which is activated by online meeting add-ins, is being developed.
|
|
17752
|
+
* Once support for entity-based contextual add-ins ends, online meeting add-ins will automatically transition to the alternative implementation
|
|
17753
|
+
* to activate the **Join Meeting** button.
|
|
17754
|
+
*
|
|
17755
|
+
* Regular expression rules will continue to be supported after entity-based contextual add-ins are retired. We recommend updating your contextual add-in
|
|
17756
|
+
* to use regular expression rules as an alternative solution. For guidance on how to implement these rules, see
|
|
17757
|
+
* {@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}.
|
|
17758
|
+
*
|
|
17759
|
+
* For more information, see
|
|
17760
|
+
* {@link https://devblogs.microsoft.com/microsoft365dev/retirement-of-entity-based-contextual-outlook-add-ins | Retirement of entity-based contextual Outlook add-ins}.
|
|
17761
|
+
*
|
|
17762
|
+
* - This method isn't supported in Outlook on Android or on iOS. For more information on supported APIs in Outlook mobile, see
|
|
17560
17763
|
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
|
|
17561
17764
|
*
|
|
17562
17765
|
* @param entityType - One of the `EntityType` enumeration values.
|
|
@@ -17626,8 +17829,22 @@ declare namespace Office {
|
|
|
17626
17829
|
*
|
|
17627
17830
|
* **Important**:
|
|
17628
17831
|
*
|
|
17832
|
+
* - 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
|
|
17833
|
+
* entities in mail items to perform tasks on them.
|
|
17834
|
+
*
|
|
17835
|
+
* An alternative implementation of the **Join Meeting** button, which is activated by online meeting add-ins, is being developed.
|
|
17836
|
+
* Once support for entity-based contextual add-ins ends, online meeting add-ins will automatically transition to the alternative implementation
|
|
17837
|
+
* to activate the **Join Meeting** button.
|
|
17838
|
+
*
|
|
17839
|
+
* Regular expression rules will continue to be supported after entity-based contextual add-ins are retired. We recommend updating your contextual add-in
|
|
17840
|
+
* to use regular expression rules as an alternative solution. For guidance on how to implement these rules, see
|
|
17841
|
+
* {@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}.
|
|
17842
|
+
*
|
|
17843
|
+
* For more information, see
|
|
17844
|
+
* {@link https://devblogs.microsoft.com/microsoft365dev/retirement-of-entity-based-contextual-outlook-add-ins | Retirement of entity-based contextual Outlook add-ins}.
|
|
17845
|
+
*
|
|
17629
17846
|
* - 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},
|
|
17630
|
-
* which isn't supported by the {@link https://learn.microsoft.com/office/dev/add-ins/develop/json-manifest-overview |
|
|
17847
|
+
* which isn't supported by the {@link https://learn.microsoft.com/office/dev/add-ins/develop/json-manifest-overview | unified manifest for Microsoft 365 (preview)}.
|
|
17631
17848
|
*
|
|
17632
17849
|
* - This method isn't supported in Outlook on Android or on iOS. For more information on supported APIs in Outlook mobile, see
|
|
17633
17850
|
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
|
|
@@ -17687,8 +17904,22 @@ declare namespace Office {
|
|
|
17687
17904
|
*
|
|
17688
17905
|
* **Important**:
|
|
17689
17906
|
*
|
|
17907
|
+
* - 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
|
|
17908
|
+
* entities in mail items to perform tasks on them.
|
|
17909
|
+
*
|
|
17910
|
+
* An alternative implementation of the **Join Meeting** button, which is activated by online meeting add-ins, is being developed.
|
|
17911
|
+
* Once support for entity-based contextual add-ins ends, online meeting add-ins will automatically transition to the alternative implementation
|
|
17912
|
+
* to activate the **Join Meeting** button.
|
|
17913
|
+
*
|
|
17914
|
+
* Regular expression rules will continue to be supported after entity-based contextual add-ins are retired. We recommend updating your contextual add-in
|
|
17915
|
+
* to use regular expression rules as an alternative solution. For guidance on how to implement these rules, see
|
|
17916
|
+
* {@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}.
|
|
17917
|
+
*
|
|
17918
|
+
* For more information, see
|
|
17919
|
+
* {@link https://devblogs.microsoft.com/microsoft365dev/retirement-of-entity-based-contextual-outlook-add-ins | Retirement of entity-based contextual Outlook add-ins}.
|
|
17920
|
+
*
|
|
17690
17921
|
* - 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},
|
|
17691
|
-
* which isn't supported by the {@link https://learn.microsoft.com/office/dev/add-ins/develop/json-manifest-overview |
|
|
17922
|
+
* which isn't supported by the {@link https://learn.microsoft.com/office/dev/add-ins/develop/json-manifest-overview | unified manifest for Microsoft 365 (preview)}.
|
|
17692
17923
|
*
|
|
17693
17924
|
* - If you specify an `ItemHasRegularExpressionMatch` rule on the body property of an item, the regular expression should further filter the body
|
|
17694
17925
|
* and shouldn't attempt to return the entire body of the item. Using a regular expression such as `.*` to obtain the entire body of an item doesn't always return the expected results.
|
|
@@ -17714,8 +17945,22 @@ declare namespace Office {
|
|
|
17714
17945
|
*
|
|
17715
17946
|
* **Important**:
|
|
17716
17947
|
*
|
|
17948
|
+
* - 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
|
|
17949
|
+
* entities in mail items to perform tasks on them.
|
|
17950
|
+
*
|
|
17951
|
+
* An alternative implementation of the **Join Meeting** button, which is activated by online meeting add-ins, is being developed.
|
|
17952
|
+
* Once support for entity-based contextual add-ins ends, online meeting add-ins will automatically transition to the alternative implementation
|
|
17953
|
+
* to activate the **Join Meeting** button.
|
|
17954
|
+
*
|
|
17955
|
+
* Regular expression rules will continue to be supported after entity-based contextual add-ins are retired. We recommend updating your contextual add-in
|
|
17956
|
+
* to use regular expression rules as an alternative solution. For guidance on how to implement these rules, see
|
|
17957
|
+
* {@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}.
|
|
17958
|
+
*
|
|
17959
|
+
* For more information, see
|
|
17960
|
+
* {@link https://devblogs.microsoft.com/microsoft365dev/retirement-of-entity-based-contextual-outlook-add-ins | Retirement of entity-based contextual Outlook add-ins}.
|
|
17961
|
+
*
|
|
17717
17962
|
* - 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},
|
|
17718
|
-
* which isn't supported by the {@link https://learn.microsoft.com/office/dev/add-ins/develop/json-manifest-overview |
|
|
17963
|
+
* which isn't supported by the {@link https://learn.microsoft.com/office/dev/add-ins/develop/json-manifest-overview | unified manifest for Microsoft 365 (preview)}.
|
|
17719
17964
|
*
|
|
17720
17965
|
* - If you specify an `ItemHasRegularExpressionMatch` rule on the body property of an item, the regular expression should further filter the body
|
|
17721
17966
|
* and shouldn't attempt to return the entire body of the item. Using a regular expression such as `.*` to obtain the entire body of an item doesn't always return the expected results.
|
|
@@ -17741,31 +17986,33 @@ declare namespace Office {
|
|
|
17741
17986
|
*
|
|
17742
17987
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read
|
|
17743
17988
|
*
|
|
17989
|
+
* **Important**: Entity-based contextual Outlook add-ins will be retired in Q2 of 2024. Once retired, contextual add-ins will no longer be able to detect
|
|
17990
|
+
* entities in mail items to perform tasks on them. To help minimize potential disruptions, the following will still be supported after entity-based
|
|
17991
|
+
* contextual add-ins are retired.
|
|
17992
|
+
*
|
|
17993
|
+
* - An alternative implementation of the **Join Meeting** button, which is activated by online meeting add-ins, is being developed. Once support for
|
|
17994
|
+
* entity-based contextual add-ins ends, online meeting add-ins will automatically transition to the alternative implementation to activate the
|
|
17995
|
+
* **Join Meeting** button.
|
|
17996
|
+
*
|
|
17997
|
+
* - Regular expression rules will continue to be supported after entity-based contextual add-ins are retired. We recommend updating your contextual add-in
|
|
17998
|
+
* to use regular expression rules as an alternative solution. For guidance on how to implement these rules, see
|
|
17999
|
+
* {@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}.
|
|
18000
|
+
*
|
|
18001
|
+
* For more information, see
|
|
18002
|
+
* {@link https://devblogs.microsoft.com/microsoft365dev/retirement-of-entity-based-contextual-outlook-add-ins | Retirement of entity-based contextual Outlook add-ins}.
|
|
18003
|
+
*
|
|
17744
18004
|
* @param name - The name of the `ItemHasRegularExpressionMatch` rule element that defines the filter to match.
|
|
17745
18005
|
*/
|
|
17746
18006
|
getSelectedEntities(): Entities;
|
|
17747
18007
|
/**
|
|
17748
18008
|
* Returns string values in a highlighted match that match the regular expressions defined in an XML manifest file.
|
|
17749
18009
|
* Highlighted matches apply to contextual add-ins.
|
|
17750
|
-
*
|
|
17751
|
-
* **Note**: This method is used with the {@link https://learn.microsoft.com/office/dev/add-ins/outlook/activation-rules | activation rules feature for Outlook add-ins}, which isn't supported by the {@link https://learn.microsoft.com/office/dev/add-ins/develop/json-manifest-overview | Teams manifest for Office Add-ins (preview)}.
|
|
17752
|
-
*
|
|
17753
|
-
* The `getSelectedRegExMatches` method returns the strings that match the regular expression defined in
|
|
17754
|
-
* each `ItemHasRegularExpressionMatch` or `ItemHasKnownEntity` rule element in the manifest XML file.
|
|
17755
|
-
* For an `ItemHasRegularExpressionMatch` rule, a matching string has to occur in the property of the item that is specified by that rule.
|
|
17756
|
-
* The `PropertyName` simple type defines the supported properties.
|
|
17757
|
-
*
|
|
17758
|
-
* If you specify an `ItemHasRegularExpressionMatch` rule on the body property of an item, the regular expression should further filter the body
|
|
17759
|
-
* and should not attempt to return the entire body of the item.
|
|
17760
|
-
* Using a regular expression such as .* to obtain the entire body of an item does not always return the expected results.
|
|
17761
|
-
* Instead, use the `Body.getAsync` method to retrieve the entire body.
|
|
17762
|
-
*
|
|
17763
|
-
* **Note**: This method is not supported in Outlook on iOS or Android.
|
|
17764
18010
|
*
|
|
17765
18011
|
* @returns
|
|
17766
18012
|
* An object that contains arrays of strings that match the regular expressions defined in the manifest XML file.
|
|
17767
18013
|
* The name of each array is equal to the corresponding value of the `RegExName` attribute of the matching `ItemHasRegularExpressionMatch` rule or
|
|
17768
|
-
* the `FilterName` attribute of the matching `ItemHasKnownEntity` rule.
|
|
18014
|
+
* the `FilterName` attribute of the matching `ItemHasKnownEntity` rule. For an `ItemHasRegularExpressionMatch` rule, a matching string has to occur
|
|
18015
|
+
* in the property of the item that is specified by that rule. The `PropertyName` simple type defines the supported properties.
|
|
17769
18016
|
*
|
|
17770
18017
|
* @remarks
|
|
17771
18018
|
* [Api set: Mailbox 1.6]
|
|
@@ -17773,6 +18020,31 @@ declare namespace Office {
|
|
|
17773
18020
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
17774
18021
|
*
|
|
17775
18022
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read
|
|
18023
|
+
*
|
|
18024
|
+
* **Important**:
|
|
18025
|
+
*
|
|
18026
|
+
* - 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
|
|
18027
|
+
* entities in mail items to perform tasks on them.
|
|
18028
|
+
*
|
|
18029
|
+
* An alternative implementation of the **Join Meeting** button, which is activated by online meeting add-ins, is being developed.
|
|
18030
|
+
* Once support for entity-based contextual add-ins ends, online meeting add-ins will automatically transition to the alternative implementation
|
|
18031
|
+
* to activate the **Join Meeting** button.
|
|
18032
|
+
*
|
|
18033
|
+
* Regular expression rules will continue to be supported after entity-based contextual add-ins are retired. We recommend updating your contextual add-in
|
|
18034
|
+
* to use regular expression rules as an alternative solution. For guidance on how to implement these rules, see
|
|
18035
|
+
* {@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}.
|
|
18036
|
+
*
|
|
18037
|
+
* For more information, see
|
|
18038
|
+
* {@link https://devblogs.microsoft.com/microsoft365dev/retirement-of-entity-based-contextual-outlook-add-ins | Retirement of entity-based contextual Outlook add-ins}.
|
|
18039
|
+
*
|
|
18040
|
+
* - 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},
|
|
18041
|
+
* which isn't supported by the {@link https://learn.microsoft.com/office/dev/add-ins/develop/json-manifest-overview | unified manifest for Microsoft 365 (preview)}.
|
|
18042
|
+
*
|
|
18043
|
+
* - This method isn't supported in Outlook on iOS or Android.
|
|
18044
|
+
*
|
|
18045
|
+
* - If you specify an `ItemHasRegularExpressionMatch` rule on the body property of an item, the regular expression should further filter the body
|
|
18046
|
+
* and shouldn't attempt to return the entire body of the item. Using a regular expression such as .* to obtain the entire body of an item doesn't always return the
|
|
18047
|
+
* expected results. Instead, use the `Body.getAsync` method to retrieve the entire body.
|
|
17776
18048
|
*/
|
|
17777
18049
|
getSelectedRegExMatches(): any;
|
|
17778
18050
|
/**
|
|
@@ -18330,6 +18602,21 @@ declare namespace Office {
|
|
|
18330
18602
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
18331
18603
|
*
|
|
18332
18604
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Read
|
|
18605
|
+
*
|
|
18606
|
+
* **Important**: Entity-based contextual Outlook add-ins will be retired in Q2 of 2024. Once retired, contextual add-ins will no longer be able to detect
|
|
18607
|
+
* entities in mail items to perform tasks on them. To help minimize potential disruptions, the following will still be supported after entity-based
|
|
18608
|
+
* contextual add-ins are retired.
|
|
18609
|
+
*
|
|
18610
|
+
* - An alternative implementation of the **Join Meeting** button, which is activated by online meeting add-ins, is being developed. Once support for
|
|
18611
|
+
* entity-based contextual add-ins ends, online meeting add-ins will automatically transition to the alternative implementation to activate the
|
|
18612
|
+
* **Join Meeting** button.
|
|
18613
|
+
*
|
|
18614
|
+
* - Regular expression rules will continue to be supported after entity-based contextual add-ins are retired. We recommend updating your contextual add-in
|
|
18615
|
+
* to use regular expression rules as an alternative solution. For guidance on how to implement these rules, see
|
|
18616
|
+
* {@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}.
|
|
18617
|
+
*
|
|
18618
|
+
* For more information, see
|
|
18619
|
+
* {@link https://devblogs.microsoft.com/microsoft365dev/retirement-of-entity-based-contextual-outlook-add-ins | Retirement of entity-based contextual Outlook add-ins}.
|
|
18333
18620
|
*/
|
|
18334
18621
|
interface PhoneNumber {
|
|
18335
18622
|
/**
|
|
@@ -19154,6 +19441,10 @@ declare namespace Office {
|
|
|
19154
19441
|
*
|
|
19155
19442
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
19156
19443
|
*
|
|
19444
|
+
* **Important**: Outlook on Mac, Outlook on the web, and the new Outlook on Windows (preview) only support Normal and Private sensitivity levels.
|
|
19445
|
+
* If you call `getAsync` on an appointment that has a Confidential or Personal sensitivity level from these clients, the Normal sensitivity level
|
|
19446
|
+
* is returned in the `asyncResult.value` property.
|
|
19447
|
+
*
|
|
19157
19448
|
* @param options - An object literal that contains one or more of the following properties:-
|
|
19158
19449
|
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
19159
19450
|
* @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter, `asyncResult`,
|
|
@@ -19165,9 +19456,6 @@ declare namespace Office {
|
|
|
19165
19456
|
/**
|
|
19166
19457
|
* Gets the sensitivity level of an appointment.
|
|
19167
19458
|
*
|
|
19168
|
-
* @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter, `asyncResult`,
|
|
19169
|
-
* which is an `Office.AsyncResult` object. The sensitivity level of the appointment is returned in the `asyncResult.value` property.
|
|
19170
|
-
*
|
|
19171
19459
|
* @remarks
|
|
19172
19460
|
* [Api set: Mailbox preview]
|
|
19173
19461
|
*
|
|
@@ -19175,6 +19463,13 @@ declare namespace Office {
|
|
|
19175
19463
|
*
|
|
19176
19464
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
19177
19465
|
*
|
|
19466
|
+
* **Important**: Outlook on Mac, Outlook on the web, and the new Outlook on Windows (preview) only support Normal and Private sensitivity levels.
|
|
19467
|
+
* If you call `getAsync` on an appointment that has a Confidential or Personal sensitivity level from these clients, the Normal sensitivity level
|
|
19468
|
+
* is returned in the `asyncResult.value` property.
|
|
19469
|
+
*
|
|
19470
|
+
* @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter, `asyncResult`,
|
|
19471
|
+
* which is an `Office.AsyncResult` object. The sensitivity level of the appointment is returned in the `asyncResult.value` property.
|
|
19472
|
+
*
|
|
19178
19473
|
* @beta
|
|
19179
19474
|
*/
|
|
19180
19475
|
getAsync(callback: (asyncResult: Office.AsyncResult<MailboxEnums.AppointmentSensitivityType>) => void): void;
|
|
@@ -19188,6 +19483,12 @@ declare namespace Office {
|
|
|
19188
19483
|
*
|
|
19189
19484
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
19190
19485
|
*
|
|
19486
|
+
* **Important**: Outlook on Mac, Outlook on the web, and the new Outlook on Windows (preview) only support Normal and Private sensitivity levels.
|
|
19487
|
+
*
|
|
19488
|
+
* **Errors**:
|
|
19489
|
+
*
|
|
19490
|
+
* - `Unsupported API parameter`: Setting the sensitivity level of an appointment isn't supported.
|
|
19491
|
+
*
|
|
19191
19492
|
* @param sensitivity - The sensitivity level as an enum or string.
|
|
19192
19493
|
* @param options - An object literal that contains one or more of the following properties:-
|
|
19193
19494
|
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
@@ -19207,6 +19508,12 @@ declare namespace Office {
|
|
|
19207
19508
|
*
|
|
19208
19509
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
19209
19510
|
*
|
|
19511
|
+
* **Important**: Outlook on Mac, Outlook on the web, and the new Outlook on Windows (preview) only support Normal and Private sensitivity levels.
|
|
19512
|
+
*
|
|
19513
|
+
* **Errors**:
|
|
19514
|
+
*
|
|
19515
|
+
* - `Unsupported API parameter`: Setting the sensitivity level of an appointment isn't supported.
|
|
19516
|
+
*
|
|
19210
19517
|
* @param sensitivity - The sensitivity level as an enum or string.
|
|
19211
19518
|
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter,
|
|
19212
19519
|
* `asyncResult`, which is an `Office.AsyncResult` object.
|
office-js-preview/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@types/office-js-preview",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.441",
|
|
4
4
|
"description": "TypeScript definitions for office-js-preview",
|
|
5
5
|
"homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-js-preview",
|
|
6
6
|
"license": "MIT",
|
|
@@ -45,6 +45,6 @@
|
|
|
45
45
|
},
|
|
46
46
|
"scripts": {},
|
|
47
47
|
"dependencies": {},
|
|
48
|
-
"typesPublisherContentHash": "
|
|
48
|
+
"typesPublisherContentHash": "2dd5cf66e2dcbf14359468bab9c23aa16f67fc30c85a8dd5a04597e058d7cf05",
|
|
49
49
|
"typeScriptVersion": "4.6"
|
|
50
50
|
}
|