@types/office-js-preview 1.0.387 → 1.0.389
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 +128 -188
- 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 (https://github.com/OfficeD
|
|
|
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: Tue, 30 May 2023 21:32:44 GMT
|
|
12
12
|
* Dependencies: none
|
|
13
13
|
* Global values: `Excel`, `Office`, `OfficeCore`, `OfficeExtension`, `OneNote`, `PowerPoint`, `Visio`, `Word`
|
|
14
14
|
|
office-js-preview/index.d.ts
CHANGED
|
@@ -990,14 +990,14 @@ declare namespace Office {
|
|
|
990
990
|
/**
|
|
991
991
|
* Gets the object to check the status of the catalog of sensitivity labels in Outlook and retrieve all available
|
|
992
992
|
* sensitivity labels if the catalog is enabled.
|
|
993
|
-
*
|
|
993
|
+
*
|
|
994
994
|
* @remarks
|
|
995
|
-
*
|
|
995
|
+
*
|
|
996
|
+
* [Api set: Mailbox 1.13]
|
|
997
|
+
*
|
|
996
998
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item**
|
|
997
999
|
*
|
|
998
1000
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
999
|
-
*
|
|
1000
|
-
* @beta
|
|
1001
1001
|
*/
|
|
1002
1002
|
sensitivityLabelsCatalog: Office.SensitivityLabelsCatalog;
|
|
1003
1003
|
/**
|
|
@@ -1549,9 +1549,13 @@ declare namespace Office {
|
|
|
1549
1549
|
* **Applications**: Excel, OneNote, Outlook, PowerPoint, Word
|
|
1550
1550
|
*
|
|
1551
1551
|
* **Requirement set**: {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/identity-api-requirement-sets | IdentityAPI 1.3}
|
|
1552
|
-
*
|
|
1553
|
-
* **Important**: In Outlook, this API isn't supported
|
|
1554
|
-
*
|
|
1552
|
+
*
|
|
1553
|
+
* **Important**: In Outlook, this API isn't supported in the following scenarios.
|
|
1554
|
+
*
|
|
1555
|
+
* - If the add-in is loaded in an Outlook.com or Gmail mailbox.
|
|
1556
|
+
*
|
|
1557
|
+
* - If the add-in is loaded in Outlook on the web in the Safari browser. This results in error 13001 ("The user is not signed into Office").
|
|
1558
|
+
*
|
|
1555
1559
|
* **Note**: In an Outlook event-based activation add-in, this API is supported in Outlook on Windows starting from Version 2111 (Build 14701.20000).
|
|
1556
1560
|
* To retrieve an access token in older builds, use
|
|
1557
1561
|
* {@link https://learn.microsoft.com/javascript/api/office-runtime/officeruntime.auth?view=common-js-preview#office-runtime-officeruntime-auth-getaccesstoken-member(1) |
|
|
@@ -2416,7 +2420,7 @@ declare namespace Office {
|
|
|
2416
2420
|
*
|
|
2417
2421
|
* To add an event handler for the `SelectedItemsChanged` event, use the `addHandlerAsync` method of the `Mailbox` object.
|
|
2418
2422
|
*
|
|
2419
|
-
* [Api set: Mailbox
|
|
2423
|
+
* [Api set: Mailbox 1.13]
|
|
2420
2424
|
*/
|
|
2421
2425
|
SelectedItemsChanged,
|
|
2422
2426
|
/**
|
|
@@ -2425,11 +2429,9 @@ declare namespace Office {
|
|
|
2425
2429
|
*
|
|
2426
2430
|
* To add an event handler for the `SensitivityLabelChanged` event, use the `addHandlerAsync` method of the `Item` object.
|
|
2427
2431
|
* The event handler receives an argument of type
|
|
2428
|
-
* {@link https://learn.microsoft.com/javascript/api/outlook/office.sensitivitylabelchangedeventargs
|
|
2432
|
+
* {@link https://learn.microsoft.com/javascript/api/outlook/office.sensitivitylabelchangedeventargs | Office.SensitivityLabelChangedEventArgs}.
|
|
2429
2433
|
*
|
|
2430
|
-
* [Api set: Mailbox
|
|
2431
|
-
*
|
|
2432
|
-
* @beta
|
|
2434
|
+
* [Api set: Mailbox 1.13]
|
|
2433
2435
|
*/
|
|
2434
2436
|
SensitivityLabelChanged,
|
|
2435
2437
|
/**
|
|
@@ -10542,45 +10544,43 @@ declare namespace Office {
|
|
|
10542
10544
|
*/
|
|
10543
10545
|
getSelectedDataAsync(coercionType: Office.CoercionType | string, callback: (asyncResult: Office.AsyncResult<string>) => void): void;
|
|
10544
10546
|
/**
|
|
10545
|
-
* Gets the properties of an appointment or message in a shared folder or shared mailbox
|
|
10546
|
-
*
|
|
10547
|
-
* For more information around using this API, see the
|
|
10548
|
-
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/delegate-access | shared folders and shared mailbox} article.
|
|
10547
|
+
* Gets the properties of an appointment or message in a shared folder or shared mailbox.
|
|
10549
10548
|
*
|
|
10550
|
-
*
|
|
10549
|
+
* For more information around using this API, see
|
|
10550
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/delegate-access | Enable shared folders and shared mailbox scenarios in an Outlook add-in}.
|
|
10551
10551
|
*
|
|
10552
10552
|
* @remarks
|
|
10553
|
-
* [Api set: Mailbox 1.8]
|
|
10553
|
+
* [Api set: Mailbox 1.8 for shared folder support, Mailbox 1.13 for shared mailbox support]
|
|
10554
10554
|
*
|
|
10555
10555
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
10556
10556
|
*
|
|
10557
10557
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Organizer
|
|
10558
10558
|
*
|
|
10559
|
+
* *Note**: This method is not supported in Outlook on iOS or Android.
|
|
10560
|
+
*
|
|
10559
10561
|
* @param options - An object literal that contains one or more of the following properties:-
|
|
10560
10562
|
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
10561
|
-
* @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter
|
|
10562
|
-
*
|
|
10563
|
-
* The `value` property of the result is the properties of the shared item.
|
|
10563
|
+
* @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter, `asyncResult`, which is an
|
|
10564
|
+
* `Office.AsyncResult` object. The `asyncResult.value` property provides the properties of the shared item.
|
|
10564
10565
|
*/
|
|
10565
10566
|
getSharedPropertiesAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<SharedProperties>) => void): void;
|
|
10566
10567
|
/**
|
|
10567
|
-
* Gets the properties of an appointment or message in a shared folder or shared mailbox
|
|
10568
|
+
* Gets the properties of an appointment or message in a shared folder or shared mailbox.
|
|
10568
10569
|
*
|
|
10569
|
-
* For more information around using this API, see
|
|
10570
|
-
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/delegate-access | shared folders and shared mailbox}
|
|
10571
|
-
*
|
|
10572
|
-
* **Note**: This method is not supported in Outlook on iOS or Android.
|
|
10570
|
+
* For more information around using this API, see
|
|
10571
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/delegate-access | Enable shared folders and shared mailbox scenarios in an Outlook add-in}.
|
|
10573
10572
|
*
|
|
10574
10573
|
* @remarks
|
|
10575
|
-
* [Api set: Mailbox 1.8]
|
|
10574
|
+
* [Api set: Mailbox 1.8 for shared folder support, Mailbox 1.13 for shared mailbox support]
|
|
10576
10575
|
*
|
|
10577
10576
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
10578
10577
|
*
|
|
10579
10578
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Organizer
|
|
10580
10579
|
*
|
|
10581
|
-
*
|
|
10582
|
-
*
|
|
10583
|
-
*
|
|
10580
|
+
* **Note**: This method is not supported in Outlook on iOS or Android.
|
|
10581
|
+
*
|
|
10582
|
+
* @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter, `asyncResult`, which is an
|
|
10583
|
+
* `Office.AsyncResult` object. The `asyncResult.value` property provides the properties of the shared item.
|
|
10584
10584
|
*/
|
|
10585
10585
|
getSharedPropertiesAsync(callback: (asyncResult: Office.AsyncResult<SharedProperties>) => void): void;
|
|
10586
10586
|
/**
|
|
@@ -11886,45 +11886,43 @@ declare namespace Office {
|
|
|
11886
11886
|
*/
|
|
11887
11887
|
getSelectedRegExMatches(): any;
|
|
11888
11888
|
/**
|
|
11889
|
-
* Gets the properties of an appointment or message in a shared folder or shared mailbox
|
|
11890
|
-
*
|
|
11891
|
-
* For more information around using this API, see the
|
|
11892
|
-
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/delegate-access | shared folders and shared mailbox} article.
|
|
11889
|
+
* Gets the properties of an appointment or message in a shared folder or shared mailbox.
|
|
11893
11890
|
*
|
|
11894
|
-
*
|
|
11891
|
+
* For more information around using this API, see
|
|
11892
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/delegate-access | Enable shared folders and shared mailbox scenarios in an Outlook add-in}.
|
|
11895
11893
|
*
|
|
11896
11894
|
* @remarks
|
|
11897
|
-
* [Api set: Mailbox 1.8]
|
|
11895
|
+
* [Api set: Mailbox 1.8 for shared folder support, Mailbox 1.13 for shared mailbox support]
|
|
11898
11896
|
*
|
|
11899
11897
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
11900
11898
|
*
|
|
11901
11899
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee
|
|
11902
11900
|
*
|
|
11901
|
+
* **Note**: This method is not supported in Outlook on iOS or Android.
|
|
11902
|
+
*
|
|
11903
11903
|
* @param options - An object literal that contains one or more of the following properties:-
|
|
11904
11904
|
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
11905
|
-
* @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter
|
|
11906
|
-
*
|
|
11907
|
-
* The `value` property of the result is the properties of the shared item.
|
|
11905
|
+
* @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter, `asyncResult`, which is an
|
|
11906
|
+
* `Office.AsyncResult` object. The `asyncResult.value` property provides the properties of the shared item.
|
|
11908
11907
|
*/
|
|
11909
11908
|
getSharedPropertiesAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<SharedProperties>) => void): void;
|
|
11910
11909
|
/**
|
|
11911
|
-
* Gets the properties of an appointment or message in a shared folder or shared mailbox
|
|
11912
|
-
*
|
|
11913
|
-
* For more information around using this API, see the
|
|
11914
|
-
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/delegate-access | shared folders and shared mailbox} article.
|
|
11910
|
+
* Gets the properties of an appointment or message in a shared folder or shared mailbox.
|
|
11915
11911
|
*
|
|
11916
|
-
*
|
|
11912
|
+
* For more information around using this API, see
|
|
11913
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/delegate-access | Enable shared folders and shared mailbox scenarios in an Outlook add-in}.
|
|
11917
11914
|
*
|
|
11918
11915
|
* @remarks
|
|
11919
|
-
* [Api set: Mailbox 1.8]
|
|
11916
|
+
* [Api set: Mailbox 1.8 for shared folder support, Mailbox 1.13 for shared mailbox support]
|
|
11920
11917
|
*
|
|
11921
11918
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
11922
11919
|
*
|
|
11923
11920
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee
|
|
11924
11921
|
*
|
|
11925
|
-
*
|
|
11926
|
-
*
|
|
11927
|
-
*
|
|
11922
|
+
* **Note**: This method is not supported in Outlook on iOS or Android.
|
|
11923
|
+
*
|
|
11924
|
+
* @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter, `asyncResult`, which is an
|
|
11925
|
+
* `Office.AsyncResult` object. The `asyncResult.value` property provides the properties of the shared item.
|
|
11928
11926
|
*/
|
|
11929
11927
|
getSharedPropertiesAsync(callback: (asyncResult: Office.AsyncResult<SharedProperties>) => void): void;
|
|
11930
11928
|
/**
|
|
@@ -12414,7 +12412,7 @@ declare namespace Office {
|
|
|
12414
12412
|
* see {@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Understanding Outlook add-in permissions}.
|
|
12415
12413
|
*
|
|
12416
12414
|
* @remarks
|
|
12417
|
-
* [Api set: Mailbox
|
|
12415
|
+
* [Api set: Mailbox 1.13]
|
|
12418
12416
|
*
|
|
12419
12417
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item**
|
|
12420
12418
|
*
|
|
@@ -12446,8 +12444,6 @@ declare namespace Office {
|
|
|
12446
12444
|
* `coercionType`: The desired format for the body. The string in the `data` parameter is converted to this format.
|
|
12447
12445
|
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter
|
|
12448
12446
|
* of type `Office.AsyncResult`. Any errors encountered will be provided in the `asyncResult.error` property.
|
|
12449
|
-
*
|
|
12450
|
-
* @beta
|
|
12451
12447
|
*/
|
|
12452
12448
|
prependOnSendAsync(data: string, options: Office.AsyncContextOptions & CoercionTypeOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
|
|
12453
12449
|
/**
|
|
@@ -12457,7 +12453,7 @@ declare namespace Office {
|
|
|
12457
12453
|
* see {@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Understanding Outlook add-in permissions}.
|
|
12458
12454
|
*
|
|
12459
12455
|
* @remarks
|
|
12460
|
-
* [Api set: Mailbox
|
|
12456
|
+
* [Api set: Mailbox 1.13]
|
|
12461
12457
|
*
|
|
12462
12458
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item**
|
|
12463
12459
|
*
|
|
@@ -12486,8 +12482,6 @@ declare namespace Office {
|
|
|
12486
12482
|
* @param data - The string to be prepended to the beginning of the message or appointment body. The string is limited to 5,000 characters.
|
|
12487
12483
|
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter
|
|
12488
12484
|
* of type `Office.AsyncResult`. Any errors encountered will be provided in the `asyncResult.error` property.
|
|
12489
|
-
*
|
|
12490
|
-
* @beta
|
|
12491
12485
|
*/
|
|
12492
12486
|
prependOnSendAsync(data: string, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
|
|
12493
12487
|
/**
|
|
@@ -13038,20 +13032,18 @@ declare namespace Office {
|
|
|
13038
13032
|
* The `DelayDeliveryTime` object enables you to manage the delayed delivery date and time of a message.
|
|
13039
13033
|
*
|
|
13040
13034
|
* @remarks
|
|
13041
|
-
* [Api set: Mailbox
|
|
13035
|
+
* [Api set: Mailbox 1.13]
|
|
13042
13036
|
*
|
|
13043
13037
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
13044
13038
|
*
|
|
13045
13039
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
13046
|
-
*
|
|
13047
|
-
* @beta
|
|
13048
13040
|
*/
|
|
13049
13041
|
interface DelayDeliveryTime {
|
|
13050
13042
|
/**
|
|
13051
13043
|
* Gets the delivery date and time of a message.
|
|
13052
13044
|
*
|
|
13053
13045
|
* @remarks
|
|
13054
|
-
* [Api set: Mailbox
|
|
13046
|
+
* [Api set: Mailbox 1.13]
|
|
13055
13047
|
*
|
|
13056
13048
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
13057
13049
|
*
|
|
@@ -13062,15 +13054,13 @@ declare namespace Office {
|
|
|
13062
13054
|
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter,
|
|
13063
13055
|
* `asyncResult`, which is an `Office.AsyncResult` object. The delivery date and time of a message is returned in the
|
|
13064
13056
|
* `asyncResult.value` property. If a delivery date hasn't been set on a message yet, `0` is returned instead.
|
|
13065
|
-
*
|
|
13066
|
-
* @beta
|
|
13067
13057
|
*/
|
|
13068
13058
|
getAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<Date | 0>) => void): void;
|
|
13069
13059
|
/**
|
|
13070
13060
|
* Gets the delivery date and time of a message.
|
|
13071
13061
|
*
|
|
13072
13062
|
* @remarks
|
|
13073
|
-
* [Api set: Mailbox
|
|
13063
|
+
* [Api set: Mailbox 1.13]
|
|
13074
13064
|
*
|
|
13075
13065
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
13076
13066
|
*
|
|
@@ -13079,15 +13069,13 @@ declare namespace Office {
|
|
|
13079
13069
|
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter,
|
|
13080
13070
|
* `asyncResult`, which is an `Office.AsyncResult` object. The delivery date and time of a message is returned in the
|
|
13081
13071
|
* `asyncResult.value` property. If a delivery date hasn't been set on a message yet, `0` is returned instead.
|
|
13082
|
-
*
|
|
13083
|
-
* @beta
|
|
13084
13072
|
*/
|
|
13085
13073
|
getAsync(callback?: (asyncResult: Office.AsyncResult<Date | 0>) => void): void;
|
|
13086
13074
|
/**
|
|
13087
13075
|
* Sets the delivery date and time of a message.
|
|
13088
13076
|
*
|
|
13089
13077
|
* @remarks
|
|
13090
|
-
* [Api set: Mailbox
|
|
13078
|
+
* [Api set: Mailbox 1.13]
|
|
13091
13079
|
*
|
|
13092
13080
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item**
|
|
13093
13081
|
*
|
|
@@ -13102,15 +13090,13 @@ declare namespace Office {
|
|
|
13102
13090
|
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
13103
13091
|
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter,
|
|
13104
13092
|
* `asyncResult`, which is an `Office.AsyncResult` object. Any errors encountered will be provided in the `asyncResult.error` property.
|
|
13105
|
-
*
|
|
13106
|
-
* @beta
|
|
13107
13093
|
*/
|
|
13108
13094
|
setAsync(datetime: Date, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
|
|
13109
13095
|
/**
|
|
13110
13096
|
* Sets the delivery date and time of a message.
|
|
13111
13097
|
*
|
|
13112
13098
|
* @remarks
|
|
13113
|
-
* [Api set: Mailbox
|
|
13099
|
+
* [Api set: Mailbox 1.13]
|
|
13114
13100
|
*
|
|
13115
13101
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item**
|
|
13116
13102
|
*
|
|
@@ -13123,8 +13109,6 @@ declare namespace Office {
|
|
|
13123
13109
|
* @param datetime - The future date and time when the message should be sent.
|
|
13124
13110
|
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter,
|
|
13125
13111
|
* `asyncResult`, which is an `Office.AsyncResult` object. Any errors encountered will be provided in the `asyncResult.error` property.
|
|
13126
|
-
*
|
|
13127
|
-
* @beta
|
|
13128
13112
|
*/
|
|
13129
13113
|
setAsync(datetime: Date, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
|
|
13130
13114
|
}
|
|
@@ -14737,10 +14721,10 @@ declare namespace Office {
|
|
|
14737
14721
|
/**
|
|
14738
14722
|
* Gets currently selected messages on which an add-in can activate and perform operations. An add-in can activate on a maximum of 100 messages at a time.
|
|
14739
14723
|
* To learn more about item multi-select, see
|
|
14740
|
-
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/item-multi-select | Activate your Outlook add-in on multiple messages
|
|
14724
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/item-multi-select | Activate your Outlook add-in on multiple messages}.
|
|
14741
14725
|
*
|
|
14742
14726
|
* @remarks
|
|
14743
|
-
* [Api set: Mailbox
|
|
14727
|
+
* [Api set: Mailbox 1.13]
|
|
14744
14728
|
*
|
|
14745
14729
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write mailbox**
|
|
14746
14730
|
*
|
|
@@ -14754,17 +14738,15 @@ declare namespace Office {
|
|
|
14754
14738
|
* `asyncResult`, which is an `Office.AsyncResult` object. The properties of the selected messages are returned as an array of JSON objects in the
|
|
14755
14739
|
* `asyncResult.value` property. These properties include the item ID, subject, item type (`Message` is the only supported type at this time), and item mode
|
|
14756
14740
|
* (`Read` or `Compose`). The objects in the array follow the order in which messages were selected.
|
|
14757
|
-
*
|
|
14758
|
-
* @beta
|
|
14759
14741
|
*/
|
|
14760
14742
|
getSelectedItemsAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<object[]>) => void): void;
|
|
14761
14743
|
/**
|
|
14762
14744
|
* Gets currently selected messages on which an add-in can activate and perform operations. An add-in can activate on a maximum of 100 messages at a time.
|
|
14763
14745
|
* To learn more about item multi-select, see
|
|
14764
|
-
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/item-multi-select | Activate your Outlook add-in on multiple messages
|
|
14746
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/item-multi-select | Activate your Outlook add-in on multiple messages}.
|
|
14765
14747
|
*
|
|
14766
14748
|
* @remarks
|
|
14767
|
-
* [Api set: Mailbox
|
|
14749
|
+
* [Api set: Mailbox 1.13]
|
|
14768
14750
|
*
|
|
14769
14751
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write mailbox**
|
|
14770
14752
|
*
|
|
@@ -14778,8 +14760,6 @@ declare namespace Office {
|
|
|
14778
14760
|
* `asyncResult`, which is an `Office.AsyncResult` object. The properties of the selected messages are returned as an array of JSON objects in the
|
|
14779
14761
|
* `asyncResult.value` property. These properties include the item ID, subject, item type (`Message` is the only supported type at this time), and item mode
|
|
14780
14762
|
* (`Read` or `Compose`). The objects in the array follow the order in which messages were selected.
|
|
14781
|
-
*
|
|
14782
|
-
* @beta
|
|
14783
14763
|
*/
|
|
14784
14764
|
getSelectedItemsAsync(callback: (asyncResult: Office.AsyncResult<object[]>) => void): void;
|
|
14785
14765
|
/**
|
|
@@ -15178,13 +15158,11 @@ declare namespace Office {
|
|
|
15178
15158
|
* The `delayDeliveryTime` property returns a `DelayDeliveryTime` object that provides methods to manage the delivery date and time of the message.
|
|
15179
15159
|
*
|
|
15180
15160
|
* @remarks
|
|
15181
|
-
* [Api set: Mailbox
|
|
15161
|
+
* [Api set: Mailbox 1.13]
|
|
15182
15162
|
*
|
|
15183
15163
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
15184
15164
|
*
|
|
15185
15165
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose
|
|
15186
|
-
*
|
|
15187
|
-
* @beta
|
|
15188
15166
|
*/
|
|
15189
15167
|
delayDeliveryTime: DelayDeliveryTime;
|
|
15190
15168
|
/**
|
|
@@ -15244,7 +15222,7 @@ declare namespace Office {
|
|
|
15244
15222
|
* Gets the object to get or set the {@link Office.SensitivityLabel | sensitivity label} of a message.
|
|
15245
15223
|
*
|
|
15246
15224
|
* @remarks
|
|
15247
|
-
* [Api set: Mailbox
|
|
15225
|
+
* [Api set: Mailbox 1.13]
|
|
15248
15226
|
*
|
|
15249
15227
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item**
|
|
15250
15228
|
*
|
|
@@ -15253,9 +15231,7 @@ declare namespace Office {
|
|
|
15253
15231
|
* **Important**: To use the sensitivity label feature in your add-in, you must have a Microsoft 365 E5 subscription.
|
|
15254
15232
|
*
|
|
15255
15233
|
* To learn more about how to manage sensitivity labels in your add-in, see
|
|
15256
|
-
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/sensitivity-label | Manage the sensitivity label of your message or appointment in compose mode
|
|
15257
|
-
*
|
|
15258
|
-
* @beta
|
|
15234
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/sensitivity-label | Manage the sensitivity label of your message or appointment in compose mode}.
|
|
15259
15235
|
*/
|
|
15260
15236
|
sensitivityLabel: SensitivityLabel;
|
|
15261
15237
|
/**
|
|
@@ -15982,15 +15958,19 @@ declare namespace Office {
|
|
|
15982
15958
|
*/
|
|
15983
15959
|
getSelectedDataAsync(coercionType: Office.CoercionType | string, callback: (asyncResult: Office.AsyncResult<any>) => void): void;
|
|
15984
15960
|
/**
|
|
15985
|
-
* Gets the properties of an appointment or message in a shared folder or shared mailbox
|
|
15961
|
+
* Gets the properties of an appointment or message in a shared folder or shared mailbox.
|
|
15986
15962
|
*
|
|
15987
|
-
* For more information around using this API, see
|
|
15988
|
-
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/delegate-access | shared folders and shared mailbox}
|
|
15989
|
-
*
|
|
15990
|
-
* **Note**: This method is not supported in Outlook on iOS or Android.
|
|
15963
|
+
* For more information around using this API, see
|
|
15964
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/delegate-access | Enable shared folders and shared mailbox scenarios in an Outlook add-in}.
|
|
15991
15965
|
*
|
|
15992
15966
|
* @remarks
|
|
15993
|
-
* [Api set: Mailbox 1.8]
|
|
15967
|
+
* [Api set: Mailbox 1.8 for shared folder support, Mailbox 1.13 for shared mailbox support]
|
|
15968
|
+
*
|
|
15969
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
15970
|
+
*
|
|
15971
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose
|
|
15972
|
+
*
|
|
15973
|
+
* **Note**: This method is not supported in Outlook on iOS or Android.
|
|
15994
15974
|
*
|
|
15995
15975
|
* **Important**: In Message Compose mode, this API is not supported in Outlook on the web or on Windows unless the following conditions are met.
|
|
15996
15976
|
*
|
|
@@ -16013,26 +15993,26 @@ declare namespace Office {
|
|
|
16013
15993
|
* The message is now in a shared context and add-ins that support these shared scenarios can get the item's shared properties.
|
|
16014
15994
|
* After the message has been sent, it's usually found in the sender's **Sent Items** folder.
|
|
16015
15995
|
*
|
|
16016
|
-
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
16017
|
-
*
|
|
16018
|
-
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose
|
|
16019
|
-
*
|
|
16020
15996
|
* @param options - An object literal that contains one or more of the following properties:-
|
|
16021
15997
|
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
16022
|
-
* @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter
|
|
16023
|
-
*
|
|
15998
|
+
* @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter, `asyncResult`, which is an
|
|
15999
|
+
* `Office.AsyncResult` object. The `asyncResult.value` property provides the properties of the shared item.
|
|
16024
16000
|
*/
|
|
16025
16001
|
getSharedPropertiesAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<SharedProperties>) => void): void;
|
|
16026
16002
|
/**
|
|
16027
|
-
* Gets the properties of an appointment or message in a shared folder or shared mailbox
|
|
16028
|
-
*
|
|
16029
|
-
* For more information around using this API, see the
|
|
16030
|
-
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/delegate-access | shared folders and shared mailbox} article.
|
|
16003
|
+
* Gets the properties of an appointment or message in a shared folder or shared mailbox.
|
|
16031
16004
|
*
|
|
16032
|
-
*
|
|
16005
|
+
* For more information around using this API, see
|
|
16006
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/delegate-access | Enable shared folders and shared mailbox scenarios in an Outlook add-in}.
|
|
16033
16007
|
*
|
|
16034
16008
|
* @remarks
|
|
16035
|
-
* [Api set: Mailbox 1.8]
|
|
16009
|
+
* [Api set: Mailbox 1.8 for shared folder support, Mailbox 1.13 for shared mailbox support]
|
|
16010
|
+
*
|
|
16011
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
16012
|
+
*
|
|
16013
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose
|
|
16014
|
+
*
|
|
16015
|
+
* **Note**: This method is not supported in Outlook on iOS or Android.
|
|
16036
16016
|
*
|
|
16037
16017
|
* **Important**: In Message Compose mode, this API is not supported in Outlook on the web or on Windows unless the following conditions are met.
|
|
16038
16018
|
*
|
|
@@ -16055,12 +16035,8 @@ declare namespace Office {
|
|
|
16055
16035
|
* The message is now in a shared context and add-ins that support these shared scenarios can get the item's shared properties.
|
|
16056
16036
|
* After the message has been sent, it's usually found in the sender's **Sent Items** folder.
|
|
16057
16037
|
*
|
|
16058
|
-
*
|
|
16059
|
-
*
|
|
16060
|
-
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose
|
|
16061
|
-
*
|
|
16062
|
-
* @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter of
|
|
16063
|
-
* type `Office.AsyncResult`. The `value` property of the result is the properties of the shared item.
|
|
16038
|
+
* @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter, `asyncResult`, which is an
|
|
16039
|
+
* `Office.AsyncResult` object. The `asyncResult.value` property provides the properties of the shared item.
|
|
16064
16040
|
*/
|
|
16065
16041
|
getSharedPropertiesAsync(callback: (asyncResult: Office.AsyncResult<SharedProperties>) => void): void;
|
|
16066
16042
|
/**
|
|
@@ -17254,43 +17230,43 @@ declare namespace Office {
|
|
|
17254
17230
|
*/
|
|
17255
17231
|
getSelectedRegExMatches(): any;
|
|
17256
17232
|
/**
|
|
17257
|
-
* Gets the properties of an appointment or message in a shared folder or shared mailbox
|
|
17258
|
-
*
|
|
17259
|
-
* For more information around using this API, see the
|
|
17260
|
-
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/delegate-access | shared folders and shared mailbox} article.
|
|
17233
|
+
* Gets the properties of an appointment or message in a shared folder or shared mailbox.
|
|
17261
17234
|
*
|
|
17262
|
-
*
|
|
17235
|
+
* For more information around using this API, see
|
|
17236
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/delegate-access | Enable shared folders and shared mailbox scenarios in an Outlook add-in}.
|
|
17263
17237
|
*
|
|
17264
17238
|
* @remarks
|
|
17265
|
-
* [Api set: Mailbox 1.8]
|
|
17239
|
+
* [Api set: Mailbox 1.8 for shared folder support, Mailbox 1.13 for shared mailbox support]
|
|
17266
17240
|
*
|
|
17267
17241
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
17268
17242
|
*
|
|
17269
17243
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read
|
|
17270
17244
|
*
|
|
17245
|
+
* **Note**: This method is not supported in Outlook on iOS or Android.
|
|
17246
|
+
*
|
|
17271
17247
|
* @param options - An object literal that contains one or more of the following properties:-
|
|
17272
17248
|
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
17273
|
-
* @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter
|
|
17274
|
-
*
|
|
17249
|
+
* @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter, `asyncResult`, which is an
|
|
17250
|
+
* `Office.AsyncResult` object. The `asyncResult.value` property provides the properties of the shared item.
|
|
17275
17251
|
*/
|
|
17276
17252
|
getSharedPropertiesAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<SharedProperties>) => void): void;
|
|
17277
17253
|
/**
|
|
17278
17254
|
* Gets the properties of an appointment or message in a shared folder or shared mailbox (now in preview).
|
|
17279
17255
|
*
|
|
17280
|
-
* For more information around using this API, see
|
|
17281
|
-
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/delegate-access | shared folders and shared mailbox}
|
|
17282
|
-
*
|
|
17283
|
-
* **Note**: This method is not supported in Outlook on iOS or Android.
|
|
17256
|
+
* For more information around using this API, see
|
|
17257
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/delegate-access | Enable shared folders and shared mailbox scenarios in an Outlook add-in}.
|
|
17284
17258
|
*
|
|
17285
17259
|
* @remarks
|
|
17286
|
-
* [Api set: Mailbox 1.8]
|
|
17260
|
+
* [Api set: Mailbox 1.8 for shared folder support, Mailbox 1.13 for shared mailbox support]
|
|
17287
17261
|
*
|
|
17288
17262
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
17289
17263
|
*
|
|
17290
17264
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read
|
|
17291
17265
|
*
|
|
17292
|
-
*
|
|
17293
|
-
*
|
|
17266
|
+
* **Note**: This method is not supported in Outlook on iOS or Android.
|
|
17267
|
+
*
|
|
17268
|
+
* @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter, `asyncResult`, which is an
|
|
17269
|
+
* `Office.AsyncResult` object. The `asyncResult.value` property provides the properties of the shared item.
|
|
17294
17270
|
*/
|
|
17295
17271
|
getSharedPropertiesAsync(callback: (asyncResult: Office.AsyncResult<SharedProperties>) => void): void;
|
|
17296
17272
|
/**
|
|
@@ -18642,7 +18618,7 @@ declare namespace Office {
|
|
|
18642
18618
|
* {@link https://learn.microsoft.com/microsoft-365/compliance/sensitivity-labels | Learn about sensitivity labels}.
|
|
18643
18619
|
*
|
|
18644
18620
|
* @remarks
|
|
18645
|
-
* [Api set: Mailbox
|
|
18621
|
+
* [Api set: Mailbox 1.13]
|
|
18646
18622
|
*
|
|
18647
18623
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item**
|
|
18648
18624
|
*
|
|
@@ -18651,16 +18627,14 @@ declare namespace Office {
|
|
|
18651
18627
|
* **Important**: To use the sensitivity label feature in your add-in, you must have a Microsoft 365 E5 subscription.
|
|
18652
18628
|
*
|
|
18653
18629
|
* To learn more about how to manage sensitivity labels in your add-in, see
|
|
18654
|
-
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/sensitivity-label | Manage the sensitivity label of your message or appointment in compose mode
|
|
18655
|
-
*
|
|
18656
|
-
* @beta
|
|
18630
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/sensitivity-label | Manage the sensitivity label of your message or appointment in compose mode}.
|
|
18657
18631
|
*/
|
|
18658
18632
|
interface SensitivityLabel {
|
|
18659
18633
|
/**
|
|
18660
18634
|
* Gets the unique identifier (GUID) of the sensitivity label applied to a message or appointment being composed.
|
|
18661
18635
|
*
|
|
18662
18636
|
* @remarks
|
|
18663
|
-
* [Api set: Mailbox
|
|
18637
|
+
* [Api set: Mailbox 1.13]
|
|
18664
18638
|
*
|
|
18665
18639
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item**
|
|
18666
18640
|
*
|
|
@@ -18669,22 +18643,20 @@ declare namespace Office {
|
|
|
18669
18643
|
* **Important**: To use the sensitivity label feature in your add-in, you must have a Microsoft 365 E5 subscription.
|
|
18670
18644
|
*
|
|
18671
18645
|
* To learn more about how to manage sensitivity labels in your add-in, see
|
|
18672
|
-
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/sensitivity-label | Manage the sensitivity label of your message or appointment in compose mode
|
|
18646
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/sensitivity-label | Manage the sensitivity label of your message or appointment in compose mode}.
|
|
18673
18647
|
*
|
|
18674
18648
|
* @param options - An object literal that contains one or more of the following properties:-
|
|
18675
18649
|
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
18676
18650
|
* @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter, `asyncResult`,
|
|
18677
18651
|
* which is an `Office.AsyncResult` object. The sensitivity label's GUID is returned in the
|
|
18678
18652
|
* `asyncResult.value` property.
|
|
18679
|
-
*
|
|
18680
|
-
* @beta
|
|
18681
18653
|
*/
|
|
18682
18654
|
getAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<string>) => void): void;
|
|
18683
18655
|
/**
|
|
18684
18656
|
* Gets the unique identifier (GUID) of the sensitivity label applied to a message or appointment being composed.
|
|
18685
18657
|
*
|
|
18686
18658
|
* @remarks
|
|
18687
|
-
* [Api set: Mailbox
|
|
18659
|
+
* [Api set: Mailbox 1.13]
|
|
18688
18660
|
*
|
|
18689
18661
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item**
|
|
18690
18662
|
*
|
|
@@ -18693,20 +18665,18 @@ declare namespace Office {
|
|
|
18693
18665
|
* **Important**: To use the sensitivity label feature in your add-in, you must have a Microsoft 365 E5 subscription.
|
|
18694
18666
|
*
|
|
18695
18667
|
* To learn more about how to manage sensitivity labels in your add-in, see
|
|
18696
|
-
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/sensitivity-label | Manage the sensitivity label of your message or appointment in compose mode
|
|
18668
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/sensitivity-label | Manage the sensitivity label of your message or appointment in compose mode}.
|
|
18697
18669
|
*
|
|
18698
18670
|
* @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter, `asyncResult`,
|
|
18699
18671
|
* which is an `Office.AsyncResult` object. The sensitivity label's GUID is returned in the
|
|
18700
18672
|
* `asyncResult.value` property.
|
|
18701
|
-
*
|
|
18702
|
-
* @beta
|
|
18703
18673
|
*/
|
|
18704
18674
|
getAsync(callback: (asyncResult: Office.AsyncResult<string>) => void): void;
|
|
18705
18675
|
/**
|
|
18706
18676
|
* Applies the specified sensitivity label to the message or appointment being composed.
|
|
18707
18677
|
*
|
|
18708
18678
|
* @remarks
|
|
18709
|
-
* [Api set: Mailbox
|
|
18679
|
+
* [Api set: Mailbox 1.13]
|
|
18710
18680
|
*
|
|
18711
18681
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item**
|
|
18712
18682
|
*
|
|
@@ -18717,7 +18687,7 @@ declare namespace Office {
|
|
|
18717
18687
|
* **Tip**: To determine the sensitivity labels available for use, call the `Office.context.sensitivityLabelsCatalog.getAsync` method.
|
|
18718
18688
|
*
|
|
18719
18689
|
* To learn more about how to manage sensitivity labels in your add-in, see
|
|
18720
|
-
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/sensitivity-label | Manage the sensitivity label of your message or appointment in compose mode
|
|
18690
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/sensitivity-label | Manage the sensitivity label of your message or appointment in compose mode}.
|
|
18721
18691
|
*
|
|
18722
18692
|
* @param sensitivityLabel - The sensitivity label to be applied to the message or appointment being composed. The parameter value can be a sensitivity label's
|
|
18723
18693
|
* unique identifier (GUID) or a {@link Office.SensitivityLabelDetails | SensitivityLabelDetails} object.
|
|
@@ -18725,15 +18695,13 @@ declare namespace Office {
|
|
|
18725
18695
|
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
18726
18696
|
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter, `asyncResult`,
|
|
18727
18697
|
* which is an `Office.AsyncResult` object.
|
|
18728
|
-
*
|
|
18729
|
-
* @beta
|
|
18730
18698
|
*/
|
|
18731
18699
|
setAsync(sensitivityLabel: string | SensitivityLabelDetails, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
|
|
18732
18700
|
/**
|
|
18733
18701
|
* Applies the specified sensitivity label to the message or appointment being composed.
|
|
18734
18702
|
*
|
|
18735
18703
|
* @remarks
|
|
18736
|
-
* [Api set: Mailbox
|
|
18704
|
+
* [Api set: Mailbox 1.13]
|
|
18737
18705
|
*
|
|
18738
18706
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item**
|
|
18739
18707
|
*
|
|
@@ -18744,14 +18712,12 @@ declare namespace Office {
|
|
|
18744
18712
|
* **Tip**: To determine the sensitivity labels available for use, call the `Office.context.sensitivityLabelsCatalog.getAsync` method.
|
|
18745
18713
|
*
|
|
18746
18714
|
* To learn more about how to manage sensitivity labels in your add-in, see
|
|
18747
|
-
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/sensitivity-label | Manage the sensitivity label of your message or appointment in compose mode
|
|
18715
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/sensitivity-label | Manage the sensitivity label of your message or appointment in compose mode}.
|
|
18748
18716
|
*
|
|
18749
18717
|
* @param sensitivityLabel - The sensitivity label to be applied to the message or appointment being composed. The parameter value can be a sensitivity label's
|
|
18750
18718
|
* unique identifier (GUID) or a {@link Office.SensitivityLabelDetails | SensitivityLabelDetails} object.
|
|
18751
18719
|
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter, `asyncResult`,
|
|
18752
18720
|
* which is an `Office.AsyncResult` object.
|
|
18753
|
-
*
|
|
18754
|
-
* @beta
|
|
18755
18721
|
*/
|
|
18756
18722
|
setAsync(sensitivityLabel: string | SensitivityLabelDetails, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
|
|
18757
18723
|
}
|
|
@@ -18760,23 +18726,19 @@ declare namespace Office {
|
|
|
18760
18726
|
* `Office.EventType.SensitivityLabelChanged` event is raised.
|
|
18761
18727
|
*
|
|
18762
18728
|
* @remarks
|
|
18763
|
-
* [Api set: Mailbox
|
|
18729
|
+
* [Api set: Mailbox 1.13]
|
|
18764
18730
|
*
|
|
18765
18731
|
* **Important**: To use the sensitivity label feature in your add-in, you must have a Microsoft 365 E5 subscription.
|
|
18766
18732
|
*
|
|
18767
18733
|
* To learn more about how to manage sensitivity labels in your add-in, see
|
|
18768
|
-
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/sensitivity-label | Manage the sensitivity label of your message or appointment in compose mode
|
|
18769
|
-
*
|
|
18770
|
-
* @beta
|
|
18734
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/sensitivity-label | Manage the sensitivity label of your message or appointment in compose mode}.
|
|
18771
18735
|
*/
|
|
18772
18736
|
export interface SensitivityLabelChangedEventArgs {
|
|
18773
18737
|
/**
|
|
18774
18738
|
* The type of event that was raised. For details, refer to {@link https://learn.microsoft.com/javascript/api/office/office.eventtype | Office.EventType}.
|
|
18775
18739
|
*
|
|
18776
18740
|
* @remarks
|
|
18777
|
-
* [Api set: Mailbox
|
|
18778
|
-
*
|
|
18779
|
-
* @beta
|
|
18741
|
+
* [Api set: Mailbox 1.13]
|
|
18780
18742
|
*/
|
|
18781
18743
|
type: "olkSensitivityLabelChanged";
|
|
18782
18744
|
}
|
|
@@ -18784,7 +18746,7 @@ declare namespace Office {
|
|
|
18784
18746
|
* Represents the properties of available sensitivity labels in Outlook.
|
|
18785
18747
|
*
|
|
18786
18748
|
* @remarks
|
|
18787
|
-
* [Api set: Mailbox
|
|
18749
|
+
* [Api set: Mailbox 1.13]
|
|
18788
18750
|
*
|
|
18789
18751
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item**
|
|
18790
18752
|
*
|
|
@@ -18793,40 +18755,28 @@ declare namespace Office {
|
|
|
18793
18755
|
* **Important**: To use the sensitivity label feature in your add-in, you must have a Microsoft 365 E5 subscription.
|
|
18794
18756
|
*
|
|
18795
18757
|
* To learn more about how to manage sensitivity labels in your add-in, see
|
|
18796
|
-
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/sensitivity-label | Manage the sensitivity label of your message or appointment in compose mode
|
|
18797
|
-
*
|
|
18798
|
-
* @beta
|
|
18758
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/sensitivity-label | Manage the sensitivity label of your message or appointment in compose mode}.
|
|
18799
18759
|
*/
|
|
18800
18760
|
interface SensitivityLabelDetails {
|
|
18801
18761
|
/**
|
|
18802
18762
|
* The color of the sensitivity label.
|
|
18803
|
-
*
|
|
18804
|
-
* @beta
|
|
18805
18763
|
*/
|
|
18806
18764
|
color: string;
|
|
18807
18765
|
/**
|
|
18808
18766
|
* The {@link https://learn.microsoft.com/microsoft-365/compliance/sensitivity-labels#sublabels-grouping-labels | sublabels} of the sensitivity label.
|
|
18809
18767
|
* Returns `null` if a label doesn't have any sublabels.
|
|
18810
|
-
*
|
|
18811
|
-
* @beta
|
|
18812
18768
|
*/
|
|
18813
18769
|
children: SensitivityLabelDetails[];
|
|
18814
18770
|
/**
|
|
18815
18771
|
* The unique identifier (GUID) of the sensitivity label.
|
|
18816
|
-
*
|
|
18817
|
-
* @beta
|
|
18818
18772
|
*/
|
|
18819
18773
|
id: string;
|
|
18820
18774
|
/**
|
|
18821
18775
|
* The name of the sensitivity label.
|
|
18822
|
-
*
|
|
18823
|
-
* @beta
|
|
18824
18776
|
*/
|
|
18825
18777
|
name: string;
|
|
18826
18778
|
/**
|
|
18827
18779
|
* The description of the sensitivity label.
|
|
18828
|
-
*
|
|
18829
|
-
* @beta
|
|
18830
18780
|
*/
|
|
18831
18781
|
tooltip: string;
|
|
18832
18782
|
}
|
|
@@ -18835,7 +18785,7 @@ declare namespace Office {
|
|
|
18835
18785
|
* in Outlook and retrieve all available sensitivity labels if the catalog is enabled.
|
|
18836
18786
|
*
|
|
18837
18787
|
* @remarks
|
|
18838
|
-
* [Api set: Mailbox
|
|
18788
|
+
* [Api set: Mailbox 1.13]
|
|
18839
18789
|
*
|
|
18840
18790
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item**
|
|
18841
18791
|
*
|
|
@@ -18844,16 +18794,14 @@ declare namespace Office {
|
|
|
18844
18794
|
* **Important**: To use the sensitivity label feature in your add-in, you must have a Microsoft 365 E5 subscription.
|
|
18845
18795
|
*
|
|
18846
18796
|
* To learn more about how to manage sensitivity labels in your add-in, see
|
|
18847
|
-
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/sensitivity-label | Manage the sensitivity label of your message or appointment in compose mode
|
|
18848
|
-
*
|
|
18849
|
-
* @beta
|
|
18797
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/sensitivity-label | Manage the sensitivity label of your message or appointment in compose mode}.
|
|
18850
18798
|
*/
|
|
18851
18799
|
export interface SensitivityLabelsCatalog {
|
|
18852
18800
|
/**
|
|
18853
18801
|
* Gets all the sensitivity labels that are enabled in Outlook.
|
|
18854
18802
|
*
|
|
18855
18803
|
* @remarks
|
|
18856
|
-
* [Api set: Mailbox
|
|
18804
|
+
* [Api set: Mailbox 1.13]
|
|
18857
18805
|
*
|
|
18858
18806
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item**
|
|
18859
18807
|
*
|
|
@@ -18864,22 +18812,20 @@ declare namespace Office {
|
|
|
18864
18812
|
* **Recommended**: To determine whether the catalog of sensitivity labels is enabled in Outlook, call `getIsEnabledAsync` before using `getAsync`.
|
|
18865
18813
|
*
|
|
18866
18814
|
* To learn more about how to manage sensitivity labels in your add-in, see
|
|
18867
|
-
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/sensitivity-label | Manage the sensitivity label of your message or appointment in compose mode
|
|
18815
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/sensitivity-label | Manage the sensitivity label of your message or appointment in compose mode}.
|
|
18868
18816
|
*
|
|
18869
18817
|
* @param options - An object literal that contains one or more of the following properties:-
|
|
18870
18818
|
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
18871
18819
|
* @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter, `asyncResult`,
|
|
18872
18820
|
* which is an `Office.AsyncResult` object. The available sensitivity labels and their properties are returned in the
|
|
18873
18821
|
* `asyncResult.value` property.
|
|
18874
|
-
*
|
|
18875
|
-
* @beta
|
|
18876
18822
|
*/
|
|
18877
18823
|
getAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<SensitivityLabelDetails[]>) => void): void;
|
|
18878
18824
|
/**
|
|
18879
18825
|
* Gets all the sensitivity labels that are enabled in Outlook.
|
|
18880
18826
|
*
|
|
18881
18827
|
* @remarks
|
|
18882
|
-
* [Api set: Mailbox
|
|
18828
|
+
* [Api set: Mailbox 1.13]
|
|
18883
18829
|
*
|
|
18884
18830
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item**
|
|
18885
18831
|
*
|
|
@@ -18890,20 +18836,18 @@ declare namespace Office {
|
|
|
18890
18836
|
* **Recommended**: To determine whether the catalog of sensitivity labels is enabled in Outlook, call `getIsEnabledAsync` before using `getAsync`.
|
|
18891
18837
|
*
|
|
18892
18838
|
* To learn more about how to manage sensitivity labels in your add-in, see
|
|
18893
|
-
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/sensitivity-label | Manage the sensitivity label of your message or appointment in compose mode
|
|
18839
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/sensitivity-label | Manage the sensitivity label of your message or appointment in compose mode}.
|
|
18894
18840
|
*
|
|
18895
18841
|
* @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter, `asyncResult`,
|
|
18896
18842
|
* which is an `Office.AsyncResult` object. The available sensitivity labels and their properties are returned in the
|
|
18897
18843
|
* `asyncResult.value` property.
|
|
18898
|
-
*
|
|
18899
|
-
* @beta
|
|
18900
18844
|
*/
|
|
18901
18845
|
getAsync(callback: (asyncResult: Office.AsyncResult<SensitivityLabelDetails[]>) => void): void;
|
|
18902
18846
|
/**
|
|
18903
18847
|
* Checks whether the catalog of sensitivity labels is enabled in Outlook.
|
|
18904
18848
|
*
|
|
18905
18849
|
* @remarks
|
|
18906
|
-
* [Api set: Mailbox
|
|
18850
|
+
* [Api set: Mailbox 1.13]
|
|
18907
18851
|
*
|
|
18908
18852
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item**
|
|
18909
18853
|
*
|
|
@@ -18915,21 +18859,19 @@ declare namespace Office {
|
|
|
18915
18859
|
* **Important**: To use the sensitivity label feature in your add-in, you must have a Microsoft 365 E5 subscription.
|
|
18916
18860
|
*
|
|
18917
18861
|
* To learn more about how to manage sensitivity labels in your add-in, see
|
|
18918
|
-
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/sensitivity-label | Manage the sensitivity label of your message or appointment in compose mode
|
|
18862
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/sensitivity-label | Manage the sensitivity label of your message or appointment in compose mode}.
|
|
18919
18863
|
*
|
|
18920
18864
|
* @param options - An object literal that contains one or more of the following properties:-
|
|
18921
18865
|
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
18922
18866
|
* @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter, `asyncResult`,
|
|
18923
18867
|
* which is an `Office.AsyncResult` object. The status of the catalog of sensitivity labels is returned in the `asyncResult.value` property.
|
|
18924
|
-
*
|
|
18925
|
-
* @beta
|
|
18926
18868
|
*/
|
|
18927
18869
|
getIsEnabledAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<boolean>) => void): void;
|
|
18928
18870
|
/**
|
|
18929
18871
|
* Checks whether the catalog of sensitivity labels is enabled in Outlook.
|
|
18930
18872
|
*
|
|
18931
18873
|
* @remarks
|
|
18932
|
-
* [Api set: Mailbox
|
|
18874
|
+
* [Api set: Mailbox 1.13]
|
|
18933
18875
|
*
|
|
18934
18876
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item**
|
|
18935
18877
|
*
|
|
@@ -18941,12 +18883,10 @@ declare namespace Office {
|
|
|
18941
18883
|
* **Important**: To use the sensitivity label feature in your add-in, you must have a Microsoft 365 E5 subscription.
|
|
18942
18884
|
*
|
|
18943
18885
|
* To learn more about how to manage sensitivity labels in your add-in, see
|
|
18944
|
-
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/sensitivity-label | Manage the sensitivity label of your message or appointment in compose mode
|
|
18886
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/sensitivity-label | Manage the sensitivity label of your message or appointment in compose mode}.
|
|
18945
18887
|
*
|
|
18946
18888
|
* @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter, `asyncResult`,
|
|
18947
18889
|
* which is an `Office.AsyncResult` object. The status of the catalog of sensitivity labels is returned in the `asyncResult.value` property.
|
|
18948
|
-
*
|
|
18949
|
-
* @beta
|
|
18950
18890
|
*/
|
|
18951
18891
|
getIsEnabledAsync(callback: (asyncResult: Office.AsyncResult<boolean>) => void): void;
|
|
18952
18892
|
}
|
|
@@ -19267,13 +19207,13 @@ declare namespace Office {
|
|
|
19267
19207
|
setAsync(name: string, value: string, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
|
|
19268
19208
|
}
|
|
19269
19209
|
/**
|
|
19270
|
-
* Represents the properties of an appointment or message in a shared folder or shared mailbox
|
|
19210
|
+
* Represents the properties of an appointment or message in a shared folder or shared mailbox.
|
|
19271
19211
|
*
|
|
19272
|
-
* For more information on how this object is used, see
|
|
19273
|
-
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/delegate-access | shared folders and shared mailbox}
|
|
19212
|
+
* For more information on how this object is used, see
|
|
19213
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/delegate-access | Enable shared folders and shared mailbox scenarios in an Outlook add-in}.
|
|
19274
19214
|
*
|
|
19275
19215
|
* @remarks
|
|
19276
|
-
* [Api set: Mailbox 1.8]
|
|
19216
|
+
* [Api set: Mailbox 1.8 for shared folder support, Mailbox 1.13 for shared mailbox support]
|
|
19277
19217
|
*
|
|
19278
19218
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
19279
19219
|
*
|
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.389",
|
|
4
4
|
"description": "TypeScript definitions for Office.js",
|
|
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": "07fd1a2f72c042f59b175f686a119385f6578d87fb632293d7da586b4d85aaf9",
|
|
49
49
|
"typeScriptVersion": "4.3"
|
|
50
50
|
}
|