@types/office-js 1.0.489 → 1.0.491
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- office-js/README.md +1 -1
- office-js/index.d.ts +152 -64
- office-js/package.json +2 -2
office-js/README.md
CHANGED
|
@@ -8,7 +8,7 @@ This package contains type definitions for office-js (https://github.com/OfficeD
|
|
|
8
8
|
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-js.
|
|
9
9
|
|
|
10
10
|
### Additional Details
|
|
11
|
-
* Last updated:
|
|
11
|
+
* Last updated: Wed, 16 Apr 2025 21:02:22 GMT
|
|
12
12
|
* Dependencies: none
|
|
13
13
|
|
|
14
14
|
# Credits
|
office-js/index.d.ts
CHANGED
|
@@ -12949,6 +12949,9 @@ declare namespace Office {
|
|
|
12949
12949
|
*
|
|
12950
12950
|
* - The `appendOnSendAsync` method doesn't support inline CSS. Use internal or external CSS instead.
|
|
12951
12951
|
*
|
|
12952
|
+
* - The `appendOnSendAsync` method isn't supported on a message that's currently loaded using the `loadItemByIdAsync` method.
|
|
12953
|
+
* For more information, see {@link https://learn.microsoft.com/office/dev/add-ins/outlook/item-multi-select | Activate your Outlook add-in on multiple messages}.
|
|
12954
|
+
*
|
|
12952
12955
|
* **Errors**:
|
|
12953
12956
|
*
|
|
12954
12957
|
* - `DataExceedsMaximumSize`: The `data` parameter is longer than 5,000 characters.
|
|
@@ -12993,6 +12996,9 @@ declare namespace Office {
|
|
|
12993
12996
|
*
|
|
12994
12997
|
* - The `appendOnSendAsync` method doesn't support inline CSS. Use internal or external CSS instead.
|
|
12995
12998
|
*
|
|
12999
|
+
* - The `appendOnSendAsync` method isn't supported on a message that's currently loaded using the `loadItemByIdAsync` method.
|
|
13000
|
+
* For more information, see {@link https://learn.microsoft.com/office/dev/add-ins/outlook/item-multi-select | Activate your Outlook add-in on multiple messages}.
|
|
13001
|
+
*
|
|
12996
13002
|
* **Errors**:
|
|
12997
13003
|
*
|
|
12998
13004
|
* - `DataExceedsMaximumSize`: The `data` parameter is longer than 5,000 characters.
|
|
@@ -13135,6 +13141,9 @@ declare namespace Office {
|
|
|
13135
13141
|
*
|
|
13136
13142
|
* - The `prependAsync` method doesn't support inline CSS. Use internal or external CSS instead.
|
|
13137
13143
|
*
|
|
13144
|
+
* - The `prependAsync` method isn't supported on a message that's currently loaded using the `loadItemByIdAsync` method.
|
|
13145
|
+
* For more information, see {@link https://learn.microsoft.com/office/dev/add-ins/outlook/item-multi-select | Activate your Outlook add-in on multiple messages}.
|
|
13146
|
+
*
|
|
13138
13147
|
* **Errors**:
|
|
13139
13148
|
*
|
|
13140
13149
|
* - `DataExceedsMaximumSize`: The data parameter is longer than 1,000,000 characters.
|
|
@@ -13182,6 +13191,9 @@ declare namespace Office {
|
|
|
13182
13191
|
*
|
|
13183
13192
|
* - The `prependAsync` method doesn't support inline CSS. Use internal or external CSS instead.
|
|
13184
13193
|
*
|
|
13194
|
+
* - The `prependAsync` method isn't supported on a message that's currently loaded using the `loadItemByIdAsync` method.
|
|
13195
|
+
* For more information, see {@link https://learn.microsoft.com/office/dev/add-ins/outlook/item-multi-select | Activate your Outlook add-in on multiple messages}.
|
|
13196
|
+
*
|
|
13185
13197
|
* **Errors**:
|
|
13186
13198
|
*
|
|
13187
13199
|
* - `DataExceedsMaximumSize`: The data parameter is longer than 1,000,000 characters.
|
|
@@ -13222,6 +13234,9 @@ declare namespace Office {
|
|
|
13222
13234
|
*
|
|
13223
13235
|
* - The `prependOnSendAsync` method doesn't support inline CSS. Use internal or external CSS instead.
|
|
13224
13236
|
*
|
|
13237
|
+
* - The `prependOnSendAsync` method isn't supported on a message that's currently loaded using the `loadItemByIdAsync` method.
|
|
13238
|
+
* For more information, see {@link https://learn.microsoft.com/office/dev/add-ins/outlook/item-multi-select | Activate your Outlook add-in on multiple messages}.
|
|
13239
|
+
*
|
|
13225
13240
|
* **Errors**:
|
|
13226
13241
|
*
|
|
13227
13242
|
* - `DataExceedsMaximumSize`: The `data` parameter exceeds 5,000 characters.
|
|
@@ -13267,6 +13282,9 @@ declare namespace Office {
|
|
|
13267
13282
|
*
|
|
13268
13283
|
* - The `prependOnSendAsync` method doesn't support inline CSS. Use internal or external CSS instead.
|
|
13269
13284
|
*
|
|
13285
|
+
* - The `prependOnSendAsync` method isn't supported on a message that's currently loaded using the `loadItemByIdAsync` method.
|
|
13286
|
+
* For more information, see {@link https://learn.microsoft.com/office/dev/add-ins/outlook/item-multi-select | Activate your Outlook add-in on multiple messages}.
|
|
13287
|
+
*
|
|
13270
13288
|
* **Errors**:
|
|
13271
13289
|
*
|
|
13272
13290
|
* - `DataExceedsMaximumSize`: The `data` parameter exceeds 5,000 characters.
|
|
@@ -13315,6 +13333,9 @@ declare namespace Office {
|
|
|
13315
13333
|
*
|
|
13316
13334
|
* - The `setAsync` method doesn't support inline CSS. Use internal or external CSS instead.
|
|
13317
13335
|
*
|
|
13336
|
+
* - The `setAsync` method isn't supported on a message that's currently loaded using the `loadItemByIdAsync` method.
|
|
13337
|
+
* For more information, see {@link https://learn.microsoft.com/office/dev/add-ins/outlook/item-multi-select | Activate your Outlook add-in on multiple messages}.
|
|
13338
|
+
*
|
|
13318
13339
|
* **Errors**:
|
|
13319
13340
|
*
|
|
13320
13341
|
* - `DataExceedsMaximumSize`: The data parameter is longer than 1,000,000 characters.
|
|
@@ -13366,6 +13387,9 @@ declare namespace Office {
|
|
|
13366
13387
|
*
|
|
13367
13388
|
* - The `setAsync` method doesn't support inline CSS. Use internal or external CSS instead.
|
|
13368
13389
|
*
|
|
13390
|
+
* - The `setAsync` method isn't supported on a message that's currently loaded using the `loadItemByIdAsync` method.
|
|
13391
|
+
* For more information, see {@link https://learn.microsoft.com/office/dev/add-ins/outlook/item-multi-select | Activate your Outlook add-in on multiple messages}.
|
|
13392
|
+
*
|
|
13369
13393
|
* **Errors**:
|
|
13370
13394
|
*
|
|
13371
13395
|
* - `DataExceedsMaximumSize`: The data parameter is longer than 1,000,000 characters.
|
|
@@ -13402,6 +13426,9 @@ declare namespace Office {
|
|
|
13402
13426
|
*
|
|
13403
13427
|
* - The `setSelectedDataAsync` method doesn't support inline CSS. Use internal or external CSS instead.
|
|
13404
13428
|
*
|
|
13429
|
+
* - The `setSelectedDataAsync` method isn't supported on a message that's currently loaded using the `loadItemByIdAsync` method.
|
|
13430
|
+
* For more information, see {@link https://learn.microsoft.com/office/dev/add-ins/outlook/item-multi-select | Activate your Outlook add-in on multiple messages}.
|
|
13431
|
+
*
|
|
13405
13432
|
* **Errors**:
|
|
13406
13433
|
*
|
|
13407
13434
|
* - `DataExceedsMaximumSize`: The `data` parameter is longer than 1,000,000 characters.
|
|
@@ -13441,6 +13468,9 @@ declare namespace Office {
|
|
|
13441
13468
|
*
|
|
13442
13469
|
* - The `setSelectedDataAsync` method doesn't support inline CSS. Use internal or external CSS instead.
|
|
13443
13470
|
*
|
|
13471
|
+
* - The `setSelectedDataAsync` method isn't supported on a message that's currently loaded using the `loadItemByIdAsync` method.
|
|
13472
|
+
* For more information, see {@link https://learn.microsoft.com/office/dev/add-ins/outlook/item-multi-select | Activate your Outlook add-in on multiple messages}.
|
|
13473
|
+
*
|
|
13444
13474
|
* **Errors**:
|
|
13445
13475
|
*
|
|
13446
13476
|
* - `DataExceedsMaximumSize`: The `data` parameter is longer than 1,000,000 characters.
|
|
@@ -13481,6 +13511,9 @@ declare namespace Office {
|
|
|
13481
13511
|
*
|
|
13482
13512
|
* - The `setSignatureAsync` method doesn't support inline CSS. Use internal or external CSS instead.
|
|
13483
13513
|
*
|
|
13514
|
+
* - The `setSignatureAsync` method isn't supported on a message that's currently loaded using the `loadItemByIdAsync` method.
|
|
13515
|
+
* For more information, see {@link https://learn.microsoft.com/office/dev/add-ins/outlook/item-multi-select | Activate your Outlook add-in on multiple messages}.
|
|
13516
|
+
*
|
|
13484
13517
|
* **Errors**:
|
|
13485
13518
|
*
|
|
13486
13519
|
* - `DataExceedsMaximumSize`: The `data` parameter is longer than 30,000 characters.
|
|
@@ -13525,6 +13558,9 @@ declare namespace Office {
|
|
|
13525
13558
|
*
|
|
13526
13559
|
* - The `setSignatureAsync` method doesn't support inline CSS. Use internal or external CSS instead.
|
|
13527
13560
|
*
|
|
13561
|
+
* - The `setSignatureAsync` method isn't supported on a message that's currently loaded using the `loadItemByIdAsync` method.
|
|
13562
|
+
* For more information, see {@link https://learn.microsoft.com/office/dev/add-ins/outlook/item-multi-select | Activate your Outlook add-in on multiple messages}.
|
|
13563
|
+
*
|
|
13528
13564
|
* **Errors**:
|
|
13529
13565
|
*
|
|
13530
13566
|
* - `DataExceedsMaximumSize`: The `data` parameter is longer than 30,000 characters.
|
|
@@ -13890,6 +13926,9 @@ declare namespace Office {
|
|
|
13890
13926
|
*
|
|
13891
13927
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read
|
|
13892
13928
|
*
|
|
13929
|
+
* **Important**: The `remove` method isn't supported on a message that's currently loaded using the `loadItemByIdAsync` method.
|
|
13930
|
+
* For more information, see {@link https://learn.microsoft.com/office/dev/add-ins/outlook/item-multi-select | Activate your Outlook add-in on multiple messages}.
|
|
13931
|
+
*
|
|
13893
13932
|
* @param name - The `name` of the property to be removed.
|
|
13894
13933
|
*/
|
|
13895
13934
|
remove(name: string): void;
|
|
@@ -13959,6 +13998,9 @@ declare namespace Office {
|
|
|
13959
13998
|
*
|
|
13960
13999
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read
|
|
13961
14000
|
*
|
|
14001
|
+
* **Important**: The `set` method isn't supported on a message that's currently loaded using the `loadItemByIdAsync` method.
|
|
14002
|
+
* For more information, see {@link https://learn.microsoft.com/office/dev/add-ins/outlook/item-multi-select | Activate your Outlook add-in on multiple messages}.
|
|
14003
|
+
*
|
|
13962
14004
|
* @param name - The name of the property to be set.
|
|
13963
14005
|
* @param value - The value of the property to be set.
|
|
13964
14006
|
*/
|
|
@@ -14017,7 +14059,9 @@ declare namespace Office {
|
|
|
14017
14059
|
*
|
|
14018
14060
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
14019
14061
|
*
|
|
14020
|
-
* **Important**:
|
|
14062
|
+
* **Important**:
|
|
14063
|
+
*
|
|
14064
|
+
* - When `item.delayDeliveryTime.setAsync` is used to schedule the delivery of a message, the delay is processed on the server.
|
|
14021
14065
|
* This allows the message to be sent even if the Outlook client isn't running. In classic Outlook on Windows, the message doesn't appear in the
|
|
14022
14066
|
* **Outbox** folder, so you won't be able to edit the message or cancel its delivery after selecting **Send**. You'll only be able to review
|
|
14023
14067
|
* the message from the **Sent Items** folder. In Outlook on the web, on Mac, and in
|
|
@@ -14025,6 +14069,9 @@ declare namespace Office {
|
|
|
14025
14069
|
* until the scheduled delivery time. While it's in the **Drafts** folder, you'll be able to edit the message before it's sent.
|
|
14026
14070
|
* To learn more, see {@link https://learn.microsoft.com/office/dev/add-ins/outlook/delay-delivery | Manage the delivery date and time of a message}.
|
|
14027
14071
|
*
|
|
14072
|
+
* - The `setAsync` method isn't supported on a message that's currently loaded using the `loadItemByIdAsync` method.
|
|
14073
|
+
* For more information, see {@link https://learn.microsoft.com/office/dev/add-ins/outlook/item-multi-select | Activate your Outlook add-in on multiple messages}.
|
|
14074
|
+
*
|
|
14028
14075
|
* **Errors**:
|
|
14029
14076
|
*
|
|
14030
14077
|
* - `InvalidFormatError` - The format of the specified data object is not valid.
|
|
@@ -14046,7 +14093,9 @@ declare namespace Office {
|
|
|
14046
14093
|
*
|
|
14047
14094
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
14048
14095
|
*
|
|
14049
|
-
* **Important**:
|
|
14096
|
+
* **Important**:
|
|
14097
|
+
*
|
|
14098
|
+
* - When `item.delayDeliveryTime.setAsync` is used to schedule the delivery of a message, the delay is processed on the server.
|
|
14050
14099
|
* This allows the message to be sent even if the Outlook client isn't running. In classic Outlook on Windows, the message doesn't appear in the
|
|
14051
14100
|
* **Outbox** folder, so you won't be able to edit the message or cancel its delivery after selecting **Send**. You'll only be able to review
|
|
14052
14101
|
* the message from the **Sent Items** folder. In Outlook on the web, on Mac, and in
|
|
@@ -14054,6 +14103,9 @@ declare namespace Office {
|
|
|
14054
14103
|
* until the scheduled delivery time. While it's in the **Drafts** folder, you'll be able to edit the message before it's sent.
|
|
14055
14104
|
* To learn more, see {@link https://learn.microsoft.com/office/dev/add-ins/outlook/delay-delivery | Manage the delivery date and time of a message}.
|
|
14056
14105
|
*
|
|
14106
|
+
* - The `setAsync` method isn't supported on a message that's currently loaded using the `loadItemByIdAsync` method.
|
|
14107
|
+
* For more information, see {@link https://learn.microsoft.com/office/dev/add-ins/outlook/item-multi-select | Activate your Outlook add-in on multiple messages}.
|
|
14108
|
+
*
|
|
14057
14109
|
* **Errors**:
|
|
14058
14110
|
*
|
|
14059
14111
|
* - `InvalidFormatError` - The format of the specified data object is not valid.
|
|
@@ -14704,10 +14756,15 @@ declare namespace Office {
|
|
|
14704
14756
|
*
|
|
14705
14757
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
14706
14758
|
*
|
|
14707
|
-
* **Important**:
|
|
14759
|
+
* **Important**:
|
|
14760
|
+
*
|
|
14761
|
+
* - The internet headers API is supported in Outlook on Android and on iOS starting in Version 4.2405.0.
|
|
14708
14762
|
* To learn more about features supported in Outlook on mobile devices, see
|
|
14709
14763
|
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
|
|
14710
14764
|
*
|
|
14765
|
+
* - The `removeAsync` method isn't supported on a message that's currently loaded using the `loadItemByIdAsync` method.
|
|
14766
|
+
* For more information, see {@link https://learn.microsoft.com/office/dev/add-ins/outlook/item-multi-select | Activate your Outlook add-in on multiple messages}.
|
|
14767
|
+
*
|
|
14711
14768
|
* @param names - The names of the internet headers to be removed.
|
|
14712
14769
|
* @param options - An object literal that contains one or more of the following properties:-
|
|
14713
14770
|
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
@@ -14727,10 +14784,15 @@ declare namespace Office {
|
|
|
14727
14784
|
*
|
|
14728
14785
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
14729
14786
|
*
|
|
14730
|
-
* **Important**:
|
|
14787
|
+
* **Important**:
|
|
14788
|
+
*
|
|
14789
|
+
* - The internet headers API is supported in Outlook on Android and on iOS starting in Version 4.2405.0.
|
|
14731
14790
|
* To learn more about features supported in Outlook on mobile devices, see
|
|
14732
14791
|
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
|
|
14733
14792
|
*
|
|
14793
|
+
* - The `removeAsync` method isn't supported on a message that's currently loaded using the `loadItemByIdAsync` method.
|
|
14794
|
+
* For more information, see {@link https://learn.microsoft.com/office/dev/add-ins/outlook/item-multi-select | Activate your Outlook add-in on multiple messages}.
|
|
14795
|
+
*
|
|
14734
14796
|
* @param names - The names of the internet headers to be removed.
|
|
14735
14797
|
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter,
|
|
14736
14798
|
* `asyncResult`, of type `Office.AsyncResult`. Any errors encountered are provided in the `asyncResult.error` property.
|
|
@@ -14763,6 +14825,9 @@ declare namespace Office {
|
|
|
14763
14825
|
* {@link https://learn.microsoft.com/office365/servicedescriptions/exchange-online-service-description/exchange-online-limits#message-limits | Exchange Online message limits}
|
|
14764
14826
|
* and {@link https://learn.microsoft.com/exchange/mail-flow/message-size-limits?view=exchserver-2019#types-of-message-size-limits | Exchange Server message limits}.
|
|
14765
14827
|
*
|
|
14828
|
+
* - The `setAsync` method isn't supported on a message that's currently loaded using the `loadItemByIdAsync` method.
|
|
14829
|
+
* For more information, see {@link https://learn.microsoft.com/office/dev/add-ins/outlook/item-multi-select | Activate your Outlook add-in on multiple messages}.
|
|
14830
|
+
*
|
|
14766
14831
|
* @param headers - The names and corresponding values of the headers to be set. This should be a record object with its keys being internet header names
|
|
14767
14832
|
* and values being the corresponding header value strings.
|
|
14768
14833
|
* @param options - An object literal that contains one or more of the following properties:-
|
|
@@ -14798,6 +14863,9 @@ declare namespace Office {
|
|
|
14798
14863
|
* {@link https://learn.microsoft.com/office365/servicedescriptions/exchange-online-service-description/exchange-online-limits#message-limits | Exchange Online message limits}
|
|
14799
14864
|
* and {@link https://learn.microsoft.com/exchange/mail-flow/message-size-limits?view=exchserver-2019#types-of-message-size-limits | Exchange Server message limits}.
|
|
14800
14865
|
*
|
|
14866
|
+
* - The `setAsync` method isn't supported on a message that's currently loaded using the `loadItemByIdAsync` method.
|
|
14867
|
+
* For more information, see {@link https://learn.microsoft.com/office/dev/add-ins/outlook/item-multi-select | Activate your Outlook add-in on multiple messages}.
|
|
14868
|
+
*
|
|
14801
14869
|
* @param headers - The names and corresponding values of the headers to be set. This should be a record object with its keys being internet header names
|
|
14802
14870
|
* and values being the corresponding header value strings.
|
|
14803
14871
|
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter,
|
|
@@ -15342,14 +15410,6 @@ declare namespace Office {
|
|
|
15342
15410
|
* <td>New messages and message replies</td>
|
|
15343
15411
|
* </tr>
|
|
15344
15412
|
* <tr>
|
|
15345
|
-
* <td>IPM.Note.SMIME</td>
|
|
15346
|
-
* <td>Encrypted messages that can also be signed</td>
|
|
15347
|
-
* </tr>
|
|
15348
|
-
* <tr>
|
|
15349
|
-
* <td>IPM.Note.SMIME.MultipartSigned</td>
|
|
15350
|
-
* <td>Clear-signed messages</td>
|
|
15351
|
-
* </tr>
|
|
15352
|
-
* <tr>
|
|
15353
15413
|
* <td>IPM.Schedule.Meeting.Request</td>
|
|
15354
15414
|
* <td>Meeting requests</td>
|
|
15355
15415
|
* </tr>
|
|
@@ -15401,14 +15461,6 @@ declare namespace Office {
|
|
|
15401
15461
|
* <td>New messages and message replies</td>
|
|
15402
15462
|
* </tr>
|
|
15403
15463
|
* <tr>
|
|
15404
|
-
* <td>IPM.Note.SMIME</td>
|
|
15405
|
-
* <td>Encrypted messages that can also be signed</td>
|
|
15406
|
-
* </tr>
|
|
15407
|
-
* <tr>
|
|
15408
|
-
* <td>IPM.Note.SMIME.MultipartSigned</td>
|
|
15409
|
-
* <td>Clear-signed messages</td>
|
|
15410
|
-
* </tr>
|
|
15411
|
-
* <tr>
|
|
15412
15464
|
* <td>IPM.Schedule.Meeting.Request</td>
|
|
15413
15465
|
* <td>Meeting requests</td>
|
|
15414
15466
|
* </tr>
|
|
@@ -15957,14 +16009,6 @@ declare namespace Office {
|
|
|
15957
16009
|
* <td>New messages and message replies</td>
|
|
15958
16010
|
* </tr>
|
|
15959
16011
|
* <tr>
|
|
15960
|
-
* <td>IPM.Note.SMIME</td>
|
|
15961
|
-
* <td>Encrypted messages that can also be signed</td>
|
|
15962
|
-
* </tr>
|
|
15963
|
-
* <tr>
|
|
15964
|
-
* <td>IPM.Note.SMIME.MultipartSigned</td>
|
|
15965
|
-
* <td>Clear-signed messages</td>
|
|
15966
|
-
* </tr>
|
|
15967
|
-
* <tr>
|
|
15968
16012
|
* <td>IPM.Schedule.Meeting.Request</td>
|
|
15969
16013
|
* <td>Meeting requests</td>
|
|
15970
16014
|
* </tr>
|
|
@@ -19256,14 +19300,6 @@ declare namespace Office {
|
|
|
19256
19300
|
* <td>New messages and message replies</td>
|
|
19257
19301
|
* </tr>
|
|
19258
19302
|
* <tr>
|
|
19259
|
-
* <td>IPM.Note.SMIME</td>
|
|
19260
|
-
* <td>Encrypted messages that can also be signed</td>
|
|
19261
|
-
* </tr>
|
|
19262
|
-
* <tr>
|
|
19263
|
-
* <td>IPM.Note.SMIME.MultipartSigned</td>
|
|
19264
|
-
* <td>Clear-signed messages</td>
|
|
19265
|
-
* </tr>
|
|
19266
|
-
* <tr>
|
|
19267
19303
|
* <td>IPM.Schedule.Meeting.Request</td>
|
|
19268
19304
|
* <td>Meeting requests</td>
|
|
19269
19305
|
* </tr>
|
|
@@ -19315,14 +19351,6 @@ declare namespace Office {
|
|
|
19315
19351
|
* <td>New messages and message replies</td>
|
|
19316
19352
|
* </tr>
|
|
19317
19353
|
* <tr>
|
|
19318
|
-
* <td>IPM.Note.SMIME</td>
|
|
19319
|
-
* <td>Encrypted messages that can also be signed</td>
|
|
19320
|
-
* </tr>
|
|
19321
|
-
* <tr>
|
|
19322
|
-
* <td>IPM.Note.SMIME.MultipartSigned</td>
|
|
19323
|
-
* <td>Clear-signed messages</td>
|
|
19324
|
-
* </tr>
|
|
19325
|
-
* <tr>
|
|
19326
19354
|
* <td>IPM.Schedule.Meeting.Request</td>
|
|
19327
19355
|
* <td>Meeting requests</td>
|
|
19328
19356
|
* </tr>
|
|
@@ -20124,14 +20152,6 @@ declare namespace Office {
|
|
|
20124
20152
|
* <td>New messages and message replies</td>
|
|
20125
20153
|
* </tr>
|
|
20126
20154
|
* <tr>
|
|
20127
|
-
* <td>IPM.Note.SMIME</td>
|
|
20128
|
-
* <td>Encrypted messages that can also be signed</td>
|
|
20129
|
-
* </tr>
|
|
20130
|
-
* <tr>
|
|
20131
|
-
* <td>IPM.Note.SMIME.MultipartSigned</td>
|
|
20132
|
-
* <td>Clear-signed messages</td>
|
|
20133
|
-
* </tr>
|
|
20134
|
-
* <tr>
|
|
20135
20155
|
* <td>IPM.Schedule.Meeting.Request</td>
|
|
20136
20156
|
* <td>Meeting requests</td>
|
|
20137
20157
|
* </tr>
|
|
@@ -21187,6 +21207,9 @@ declare namespace Office {
|
|
|
21187
21207
|
* - In compose mode, while the style of each notification type varies on other Outlook clients, notifications in Outlook on Android and on iOS
|
|
21188
21208
|
* all use the same style. The notification message is always prefixed with an informational icon.
|
|
21189
21209
|
*
|
|
21210
|
+
* - The `addAsync` method isn't supported on a message that's currently loaded using the `loadItemByIdAsync` method.
|
|
21211
|
+
* For more information, see {@link https://learn.microsoft.com/office/dev/add-ins/outlook/item-multi-select | Activate your Outlook add-in on multiple messages}.
|
|
21212
|
+
*
|
|
21190
21213
|
* @param key - A developer-specified key used to reference this notification message.
|
|
21191
21214
|
* Developers can use it to modify this message later. It can't be longer than 32 characters.
|
|
21192
21215
|
* @param JSONmessage - A JSON object that contains the notification message to be added to the item.
|
|
@@ -21224,6 +21247,9 @@ declare namespace Office {
|
|
|
21224
21247
|
* - In compose mode, while the style of each notification type varies on other Outlook clients, notifications in Outlook on Android and on iOS
|
|
21225
21248
|
* all use the same style. The notification message is always prefixed with an informational icon.
|
|
21226
21249
|
*
|
|
21250
|
+
* - The `addAsync` method isn't supported on a message that's currently loaded using the `loadItemByIdAsync` method.
|
|
21251
|
+
* For more information, see {@link https://learn.microsoft.com/office/dev/add-ins/outlook/item-multi-select | Activate your Outlook add-in on multiple messages}.
|
|
21252
|
+
*
|
|
21227
21253
|
* @param key - A developer-specified key used to reference this notification message.
|
|
21228
21254
|
* Developers can use it to modify this message later. It can't be longer than 32 characters.
|
|
21229
21255
|
* @param JSONmessage - A JSON object that contains the notification message to be added to the item.
|
|
@@ -21272,6 +21298,9 @@ declare namespace Office {
|
|
|
21272
21298
|
*
|
|
21273
21299
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read
|
|
21274
21300
|
*
|
|
21301
|
+
* **Important**: The `removeAsync` method isn't supported on a message that's currently loaded using the `loadItemByIdAsync` method.
|
|
21302
|
+
* For more information, see {@link https://learn.microsoft.com/office/dev/add-ins/outlook/item-multi-select | Activate your Outlook add-in on multiple messages}.
|
|
21303
|
+
*
|
|
21275
21304
|
* @param key - The key for the notification message to remove.
|
|
21276
21305
|
* @param options - An object literal that contains one or more of the following properties:-
|
|
21277
21306
|
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
@@ -21289,6 +21318,9 @@ declare namespace Office {
|
|
|
21289
21318
|
*
|
|
21290
21319
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read
|
|
21291
21320
|
*
|
|
21321
|
+
* **Important**: The `removeAsync` method isn't supported on a message that's currently loaded using the `loadItemByIdAsync` method.
|
|
21322
|
+
* For more information, see {@link https://learn.microsoft.com/office/dev/add-ins/outlook/item-multi-select | Activate your Outlook add-in on multiple messages}.
|
|
21323
|
+
*
|
|
21292
21324
|
* @param key - The key for the notification message to remove.
|
|
21293
21325
|
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter
|
|
21294
21326
|
* of type `Office.AsyncResult`.
|
|
@@ -21306,6 +21338,9 @@ declare namespace Office {
|
|
|
21306
21338
|
*
|
|
21307
21339
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read
|
|
21308
21340
|
*
|
|
21341
|
+
* **Important**: The `replaceAsync` method isn't supported on a message that's currently loaded using the `loadItemByIdAsync` method.
|
|
21342
|
+
* For more information, see {@link https://learn.microsoft.com/office/dev/add-ins/outlook/item-multi-select | Activate your Outlook add-in on multiple messages}.
|
|
21343
|
+
*
|
|
21309
21344
|
* @param key - The key for the notification message to replace. It can't be longer than 32 characters.
|
|
21310
21345
|
* @param JSONmessage - A JSON object that contains the new notification message to replace the existing message.
|
|
21311
21346
|
* It contains a `NotificationMessageDetails` object.
|
|
@@ -21327,6 +21362,9 @@ declare namespace Office {
|
|
|
21327
21362
|
*
|
|
21328
21363
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read
|
|
21329
21364
|
*
|
|
21365
|
+
* **Important**: The `replaceAsync` method isn't supported on a message that's currently loaded using the `loadItemByIdAsync` method.
|
|
21366
|
+
* For more information, see {@link https://learn.microsoft.com/office/dev/add-ins/outlook/item-multi-select | Activate your Outlook add-in on multiple messages}.
|
|
21367
|
+
*
|
|
21330
21368
|
* @param key - The key for the notification message to replace. It can't be longer than 32 characters.
|
|
21331
21369
|
* @param JSONmessage - A JSON object that contains the new notification message to replace the existing message.
|
|
21332
21370
|
* It contains a `NotificationMessageDetails` object.
|
|
@@ -21486,7 +21524,9 @@ declare namespace Office {
|
|
|
21486
21524
|
*
|
|
21487
21525
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
21488
21526
|
*
|
|
21489
|
-
* **Important**:
|
|
21527
|
+
* **Important**:
|
|
21528
|
+
*
|
|
21529
|
+
* With the `addAsync` method, you can add a maximum of 100 recipients to a mail item in Outlook on the web, on Windows
|
|
21490
21530
|
* ({@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new} and classic), on Mac (classic UI), on Android, and on iOS.
|
|
21491
21531
|
* However, take note of the following:
|
|
21492
21532
|
*
|
|
@@ -21499,6 +21539,9 @@ declare namespace Office {
|
|
|
21499
21539
|
*
|
|
21500
21540
|
* There's no recipient limit if you call `addAsync` in Outlook on Mac (new UI).
|
|
21501
21541
|
*
|
|
21542
|
+
* The `addAsync` method isn't supported on a message that's currently loaded using the `loadItemByIdAsync` method.
|
|
21543
|
+
* For more information, see {@link https://learn.microsoft.com/office/dev/add-ins/outlook/item-multi-select | Activate your Outlook add-in on multiple messages}.
|
|
21544
|
+
*
|
|
21502
21545
|
* **Errors**:
|
|
21503
21546
|
*
|
|
21504
21547
|
* - `NumberOfRecipientsExceeded`: The number of recipients exceeded 100 entries.
|
|
@@ -21521,7 +21564,9 @@ declare namespace Office {
|
|
|
21521
21564
|
*
|
|
21522
21565
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
21523
21566
|
*
|
|
21524
|
-
* **Important**:
|
|
21567
|
+
* **Important**:
|
|
21568
|
+
*
|
|
21569
|
+
* With the `addAsync` method, you can add a maximum of 100 recipients to a mail item in Outlook on the web, on Windows
|
|
21525
21570
|
* ({@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new} and classic), on Mac (classic UI), on Android, and on iOS.
|
|
21526
21571
|
* However, take note of the following:
|
|
21527
21572
|
*
|
|
@@ -21534,6 +21579,9 @@ declare namespace Office {
|
|
|
21534
21579
|
*
|
|
21535
21580
|
* There's no recipient limit if you call `addAsync` in Outlook on Mac (new UI).
|
|
21536
21581
|
*
|
|
21582
|
+
* The `addAsync` method isn't supported on a message that's currently loaded using the `loadItemByIdAsync` method.
|
|
21583
|
+
* For more information, see {@link https://learn.microsoft.com/office/dev/add-ins/outlook/item-multi-select | Activate your Outlook add-in on multiple messages}.
|
|
21584
|
+
*
|
|
21537
21585
|
* **Errors**:
|
|
21538
21586
|
*
|
|
21539
21587
|
* - `NumberOfRecipientsExceeded`: The number of recipients exceeded 100 entries.
|
|
@@ -21655,7 +21703,9 @@ declare namespace Office {
|
|
|
21655
21703
|
*
|
|
21656
21704
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
21657
21705
|
*
|
|
21658
|
-
* **Important**:
|
|
21706
|
+
* **Important**:
|
|
21707
|
+
*
|
|
21708
|
+
* With the `setAsync` method, you can set a maximum of 100 recipients in Outlook on the web, on Windows
|
|
21659
21709
|
* ({@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new} and classic), on Mac (classic UI), on Android, and on iOS.
|
|
21660
21710
|
* However, take note of the following:
|
|
21661
21711
|
*
|
|
@@ -21668,6 +21718,9 @@ declare namespace Office {
|
|
|
21668
21718
|
*
|
|
21669
21719
|
* There's no recipient limit if you call `setAsync` in Outlook on Mac (new UI).
|
|
21670
21720
|
*
|
|
21721
|
+
* The `setAsync` method isn't supported on a message that's currently loaded using the `loadItemByIdAsync` method.
|
|
21722
|
+
* For more information, see {@link https://learn.microsoft.com/office/dev/add-ins/outlook/item-multi-select | Activate your Outlook add-in on multiple messages}.
|
|
21723
|
+
*
|
|
21671
21724
|
* **Errors**:
|
|
21672
21725
|
*
|
|
21673
21726
|
* - `NumberOfRecipientsExceeded`: The number of recipients exceeded 100 entries.
|
|
@@ -21693,7 +21746,9 @@ declare namespace Office {
|
|
|
21693
21746
|
*
|
|
21694
21747
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
21695
21748
|
*
|
|
21696
|
-
* **Important**:
|
|
21749
|
+
* **Important**:
|
|
21750
|
+
*
|
|
21751
|
+
* With the `setAsync` method, you can set a maximum of 100 recipients in Outlook on the web, on Windows
|
|
21697
21752
|
* ({@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new} and classic), on Mac (classic UI), on Android, and on iOS.
|
|
21698
21753
|
* However, take note of the following:
|
|
21699
21754
|
*
|
|
@@ -21706,6 +21761,9 @@ declare namespace Office {
|
|
|
21706
21761
|
*
|
|
21707
21762
|
* There's no recipient limit if you call `setAsync` in Outlook on Mac (new UI).
|
|
21708
21763
|
*
|
|
21764
|
+
* The `setAsync` method isn't supported on a message that's currently loaded using the `loadItemByIdAsync` method.
|
|
21765
|
+
* For more information, see {@link https://learn.microsoft.com/office/dev/add-ins/outlook/item-multi-select | Activate your Outlook add-in on multiple messages}.
|
|
21766
|
+
*
|
|
21709
21767
|
* **Errors**:
|
|
21710
21768
|
*
|
|
21711
21769
|
* - `NumberOfRecipientsExceeded`: The number of recipients exceeded 100 entries.
|
|
@@ -21927,8 +21985,6 @@ declare namespace Office {
|
|
|
21927
21985
|
/**
|
|
21928
21986
|
* Sets the recurrence pattern of an appointment series.
|
|
21929
21987
|
*
|
|
21930
|
-
* **Note**: `setAsync` should only be available for series items and not instance items.
|
|
21931
|
-
*
|
|
21932
21988
|
* @remarks
|
|
21933
21989
|
* [Api set: Mailbox 1.7]
|
|
21934
21990
|
*
|
|
@@ -21936,6 +21992,13 @@ declare namespace Office {
|
|
|
21936
21992
|
*
|
|
21937
21993
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
21938
21994
|
*
|
|
21995
|
+
* **Important**:
|
|
21996
|
+
*
|
|
21997
|
+
* - `setAsync` is only available for series items and not instance items.
|
|
21998
|
+
*
|
|
21999
|
+
* - The `setAsync` method isn't supported on a message that's currently loaded using the `loadItemByIdAsync` method.
|
|
22000
|
+
* For more information, see {@link https://learn.microsoft.com/office/dev/add-ins/outlook/item-multi-select | Activate your Outlook add-in on multiple messages}.
|
|
22001
|
+
*
|
|
21939
22002
|
* **Errors**:
|
|
21940
22003
|
*
|
|
21941
22004
|
* - `InvalidEndTime`: The appointment end time is before its start time.
|
|
@@ -21950,8 +22013,6 @@ declare namespace Office {
|
|
|
21950
22013
|
/**
|
|
21951
22014
|
* Sets the recurrence pattern of an appointment series.
|
|
21952
22015
|
*
|
|
21953
|
-
* **Note**: `setAsync` should only be available for series items and not instance items.
|
|
21954
|
-
*
|
|
21955
22016
|
* @remarks
|
|
21956
22017
|
* [Api set: Mailbox 1.7]
|
|
21957
22018
|
*
|
|
@@ -21959,6 +22020,13 @@ declare namespace Office {
|
|
|
21959
22020
|
*
|
|
21960
22021
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
21961
22022
|
*
|
|
22023
|
+
* **Important**:
|
|
22024
|
+
*
|
|
22025
|
+
* - `setAsync` is only available for series items and not instance items.
|
|
22026
|
+
*
|
|
22027
|
+
* - The `setAsync` method isn't supported on a message that's currently loaded using the `loadItemByIdAsync` method.
|
|
22028
|
+
* For more information, see {@link https://learn.microsoft.com/office/dev/add-ins/outlook/item-multi-select | Activate your Outlook add-in on multiple messages}.
|
|
22029
|
+
*
|
|
21962
22030
|
* **Errors**:
|
|
21963
22031
|
*
|
|
21964
22032
|
* - `InvalidEndTime`: The appointment end time is before its start time.
|
|
@@ -22481,7 +22549,12 @@ declare namespace Office {
|
|
|
22481
22549
|
*
|
|
22482
22550
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
22483
22551
|
*
|
|
22484
|
-
* **Important**:
|
|
22552
|
+
* **Important**:
|
|
22553
|
+
*
|
|
22554
|
+
* - To use the sensitivity label feature in your add-in, you must have a Microsoft 365 E5 subscription.
|
|
22555
|
+
*
|
|
22556
|
+
* - The `setAsync` method isn't supported on a message that's currently loaded using the `loadItemByIdAsync` method.
|
|
22557
|
+
* For more information, see {@link https://learn.microsoft.com/office/dev/add-ins/outlook/item-multi-select | Activate your Outlook add-in on multiple messages}.
|
|
22485
22558
|
*
|
|
22486
22559
|
* **Tip**: To determine the sensitivity labels available for use, call the `Office.context.sensitivityLabelsCatalog.getAsync` method.
|
|
22487
22560
|
*
|
|
@@ -22506,7 +22579,12 @@ declare namespace Office {
|
|
|
22506
22579
|
*
|
|
22507
22580
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
22508
22581
|
*
|
|
22509
|
-
* **Important**:
|
|
22582
|
+
* **Important**:
|
|
22583
|
+
*
|
|
22584
|
+
* - To use the sensitivity label feature in your add-in, you must have a Microsoft 365 E5 subscription.
|
|
22585
|
+
*
|
|
22586
|
+
* - The `setAsync` method isn't supported on a message that's currently loaded using the `loadItemByIdAsync` method.
|
|
22587
|
+
* For more information, see {@link https://learn.microsoft.com/office/dev/add-ins/outlook/item-multi-select | Activate your Outlook add-in on multiple messages}.
|
|
22510
22588
|
*
|
|
22511
22589
|
* **Tip**: To determine the sensitivity labels available for use, call the `Office.context.sensitivityLabelsCatalog.getAsync` method.
|
|
22512
22590
|
*
|
|
@@ -23535,10 +23613,15 @@ declare namespace Office {
|
|
|
23535
23613
|
*
|
|
23536
23614
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
23537
23615
|
*
|
|
23538
|
-
* **Important**:
|
|
23616
|
+
* **Important**:
|
|
23617
|
+
*
|
|
23618
|
+
* - In Outlook on Android and on iOS, this method isn't supported in the Message Compose mode. Only the Appointment Organizer mode is
|
|
23539
23619
|
* supported. For more information on supported APIs in Outlook mobile, see
|
|
23540
23620
|
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
|
|
23541
23621
|
*
|
|
23622
|
+
* - The `setAsync` method isn't supported on a message that's currently loaded using the `loadItemByIdAsync` method.
|
|
23623
|
+
* For more information, see {@link https://learn.microsoft.com/office/dev/add-ins/outlook/item-multi-select | Activate your Outlook add-in on multiple messages}.
|
|
23624
|
+
*
|
|
23542
23625
|
* **Errors**:
|
|
23543
23626
|
*
|
|
23544
23627
|
* - `DataExceedsMaximumSize`: The subject parameter is longer than 255 characters.
|
|
@@ -23563,10 +23646,15 @@ declare namespace Office {
|
|
|
23563
23646
|
*
|
|
23564
23647
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
23565
23648
|
*
|
|
23566
|
-
* **Important**:
|
|
23649
|
+
* **Important**:
|
|
23650
|
+
*
|
|
23651
|
+
* - In Outlook on Android and on iOS, this method isn't supported in the Message Compose mode. Only the Appointment Organizer mode is
|
|
23567
23652
|
* supported. For more information on supported APIs in Outlook mobile, see
|
|
23568
23653
|
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
|
|
23569
23654
|
*
|
|
23655
|
+
* - The `setAsync` method isn't supported on a message that's currently loaded using the `loadItemByIdAsync` method.
|
|
23656
|
+
* For more information, see {@link https://learn.microsoft.com/office/dev/add-ins/outlook/item-multi-select | Activate your Outlook add-in on multiple messages}.
|
|
23657
|
+
*
|
|
23570
23658
|
* **Errors**:
|
|
23571
23659
|
*
|
|
23572
23660
|
* - `DataExceedsMaximumSize`: The subject parameter is longer than 255 characters.
|
office-js/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@types/office-js",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.491",
|
|
4
4
|
"description": "TypeScript definitions for office-js",
|
|
5
5
|
"homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-js",
|
|
6
6
|
"license": "MIT",
|
|
@@ -46,6 +46,6 @@
|
|
|
46
46
|
"scripts": {},
|
|
47
47
|
"dependencies": {},
|
|
48
48
|
"peerDependencies": {},
|
|
49
|
-
"typesPublisherContentHash": "
|
|
49
|
+
"typesPublisherContentHash": "f115d9ec6f7e31953b4d0953094c6a0b2178567c60c82cfaae8acd1ed5fa59a8",
|
|
50
50
|
"typeScriptVersion": "5.1"
|
|
51
51
|
}
|