@types/office-js 1.0.489 → 1.0.490
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 -16
- 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: Mon, 14 Apr 2025
|
|
11
|
+
* Last updated: Mon, 14 Apr 2025 22:37:06 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,
|
|
@@ -21187,6 +21255,9 @@ declare namespace Office {
|
|
|
21187
21255
|
* - In compose mode, while the style of each notification type varies on other Outlook clients, notifications in Outlook on Android and on iOS
|
|
21188
21256
|
* all use the same style. The notification message is always prefixed with an informational icon.
|
|
21189
21257
|
*
|
|
21258
|
+
* - The `addAsync` method isn't supported on a message that's currently loaded using the `loadItemByIdAsync` method.
|
|
21259
|
+
* 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}.
|
|
21260
|
+
*
|
|
21190
21261
|
* @param key - A developer-specified key used to reference this notification message.
|
|
21191
21262
|
* Developers can use it to modify this message later. It can't be longer than 32 characters.
|
|
21192
21263
|
* @param JSONmessage - A JSON object that contains the notification message to be added to the item.
|
|
@@ -21224,6 +21295,9 @@ declare namespace Office {
|
|
|
21224
21295
|
* - In compose mode, while the style of each notification type varies on other Outlook clients, notifications in Outlook on Android and on iOS
|
|
21225
21296
|
* all use the same style. The notification message is always prefixed with an informational icon.
|
|
21226
21297
|
*
|
|
21298
|
+
* - The `addAsync` method isn't supported on a message that's currently loaded using the `loadItemByIdAsync` method.
|
|
21299
|
+
* 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}.
|
|
21300
|
+
*
|
|
21227
21301
|
* @param key - A developer-specified key used to reference this notification message.
|
|
21228
21302
|
* Developers can use it to modify this message later. It can't be longer than 32 characters.
|
|
21229
21303
|
* @param JSONmessage - A JSON object that contains the notification message to be added to the item.
|
|
@@ -21272,6 +21346,9 @@ declare namespace Office {
|
|
|
21272
21346
|
*
|
|
21273
21347
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read
|
|
21274
21348
|
*
|
|
21349
|
+
* **Important**: The `removeAsync` method isn't supported on a message that's currently loaded using the `loadItemByIdAsync` method.
|
|
21350
|
+
* 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}.
|
|
21351
|
+
*
|
|
21275
21352
|
* @param key - The key for the notification message to remove.
|
|
21276
21353
|
* @param options - An object literal that contains one or more of the following properties:-
|
|
21277
21354
|
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
@@ -21289,6 +21366,9 @@ declare namespace Office {
|
|
|
21289
21366
|
*
|
|
21290
21367
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read
|
|
21291
21368
|
*
|
|
21369
|
+
* **Important**: The `removeAsync` method isn't supported on a message that's currently loaded using the `loadItemByIdAsync` method.
|
|
21370
|
+
* 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}.
|
|
21371
|
+
*
|
|
21292
21372
|
* @param key - The key for the notification message to remove.
|
|
21293
21373
|
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter
|
|
21294
21374
|
* of type `Office.AsyncResult`.
|
|
@@ -21306,6 +21386,9 @@ declare namespace Office {
|
|
|
21306
21386
|
*
|
|
21307
21387
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read
|
|
21308
21388
|
*
|
|
21389
|
+
* **Important**: The `replaceAsync` method isn't supported on a message that's currently loaded using the `loadItemByIdAsync` method.
|
|
21390
|
+
* 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}.
|
|
21391
|
+
*
|
|
21309
21392
|
* @param key - The key for the notification message to replace. It can't be longer than 32 characters.
|
|
21310
21393
|
* @param JSONmessage - A JSON object that contains the new notification message to replace the existing message.
|
|
21311
21394
|
* It contains a `NotificationMessageDetails` object.
|
|
@@ -21327,6 +21410,9 @@ declare namespace Office {
|
|
|
21327
21410
|
*
|
|
21328
21411
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read
|
|
21329
21412
|
*
|
|
21413
|
+
* **Important**: The `replaceAsync` method isn't supported on a message that's currently loaded using the `loadItemByIdAsync` method.
|
|
21414
|
+
* 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}.
|
|
21415
|
+
*
|
|
21330
21416
|
* @param key - The key for the notification message to replace. It can't be longer than 32 characters.
|
|
21331
21417
|
* @param JSONmessage - A JSON object that contains the new notification message to replace the existing message.
|
|
21332
21418
|
* It contains a `NotificationMessageDetails` object.
|
|
@@ -21486,7 +21572,9 @@ declare namespace Office {
|
|
|
21486
21572
|
*
|
|
21487
21573
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
21488
21574
|
*
|
|
21489
|
-
* **Important**:
|
|
21575
|
+
* **Important**:
|
|
21576
|
+
*
|
|
21577
|
+
* With the `addAsync` method, you can add a maximum of 100 recipients to a mail item in Outlook on the web, on Windows
|
|
21490
21578
|
* ({@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new} and classic), on Mac (classic UI), on Android, and on iOS.
|
|
21491
21579
|
* However, take note of the following:
|
|
21492
21580
|
*
|
|
@@ -21499,6 +21587,9 @@ declare namespace Office {
|
|
|
21499
21587
|
*
|
|
21500
21588
|
* There's no recipient limit if you call `addAsync` in Outlook on Mac (new UI).
|
|
21501
21589
|
*
|
|
21590
|
+
* The `addAsync` method isn't supported on a message that's currently loaded using the `loadItemByIdAsync` method.
|
|
21591
|
+
* 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}.
|
|
21592
|
+
*
|
|
21502
21593
|
* **Errors**:
|
|
21503
21594
|
*
|
|
21504
21595
|
* - `NumberOfRecipientsExceeded`: The number of recipients exceeded 100 entries.
|
|
@@ -21521,7 +21612,9 @@ declare namespace Office {
|
|
|
21521
21612
|
*
|
|
21522
21613
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
21523
21614
|
*
|
|
21524
|
-
* **Important**:
|
|
21615
|
+
* **Important**:
|
|
21616
|
+
*
|
|
21617
|
+
* With the `addAsync` method, you can add a maximum of 100 recipients to a mail item in Outlook on the web, on Windows
|
|
21525
21618
|
* ({@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new} and classic), on Mac (classic UI), on Android, and on iOS.
|
|
21526
21619
|
* However, take note of the following:
|
|
21527
21620
|
*
|
|
@@ -21534,6 +21627,9 @@ declare namespace Office {
|
|
|
21534
21627
|
*
|
|
21535
21628
|
* There's no recipient limit if you call `addAsync` in Outlook on Mac (new UI).
|
|
21536
21629
|
*
|
|
21630
|
+
* The `addAsync` method isn't supported on a message that's currently loaded using the `loadItemByIdAsync` method.
|
|
21631
|
+
* 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}.
|
|
21632
|
+
*
|
|
21537
21633
|
* **Errors**:
|
|
21538
21634
|
*
|
|
21539
21635
|
* - `NumberOfRecipientsExceeded`: The number of recipients exceeded 100 entries.
|
|
@@ -21655,7 +21751,9 @@ declare namespace Office {
|
|
|
21655
21751
|
*
|
|
21656
21752
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
21657
21753
|
*
|
|
21658
|
-
* **Important**:
|
|
21754
|
+
* **Important**:
|
|
21755
|
+
*
|
|
21756
|
+
* With the `setAsync` method, you can set a maximum of 100 recipients in Outlook on the web, on Windows
|
|
21659
21757
|
* ({@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new} and classic), on Mac (classic UI), on Android, and on iOS.
|
|
21660
21758
|
* However, take note of the following:
|
|
21661
21759
|
*
|
|
@@ -21668,6 +21766,9 @@ declare namespace Office {
|
|
|
21668
21766
|
*
|
|
21669
21767
|
* There's no recipient limit if you call `setAsync` in Outlook on Mac (new UI).
|
|
21670
21768
|
*
|
|
21769
|
+
* The `setAsync` method isn't supported on a message that's currently loaded using the `loadItemByIdAsync` method.
|
|
21770
|
+
* 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}.
|
|
21771
|
+
*
|
|
21671
21772
|
* **Errors**:
|
|
21672
21773
|
*
|
|
21673
21774
|
* - `NumberOfRecipientsExceeded`: The number of recipients exceeded 100 entries.
|
|
@@ -21693,7 +21794,9 @@ declare namespace Office {
|
|
|
21693
21794
|
*
|
|
21694
21795
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
21695
21796
|
*
|
|
21696
|
-
* **Important**:
|
|
21797
|
+
* **Important**:
|
|
21798
|
+
*
|
|
21799
|
+
* With the `setAsync` method, you can set a maximum of 100 recipients in Outlook on the web, on Windows
|
|
21697
21800
|
* ({@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new} and classic), on Mac (classic UI), on Android, and on iOS.
|
|
21698
21801
|
* However, take note of the following:
|
|
21699
21802
|
*
|
|
@@ -21706,6 +21809,9 @@ declare namespace Office {
|
|
|
21706
21809
|
*
|
|
21707
21810
|
* There's no recipient limit if you call `setAsync` in Outlook on Mac (new UI).
|
|
21708
21811
|
*
|
|
21812
|
+
* The `setAsync` method isn't supported on a message that's currently loaded using the `loadItemByIdAsync` method.
|
|
21813
|
+
* 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}.
|
|
21814
|
+
*
|
|
21709
21815
|
* **Errors**:
|
|
21710
21816
|
*
|
|
21711
21817
|
* - `NumberOfRecipientsExceeded`: The number of recipients exceeded 100 entries.
|
|
@@ -21927,8 +22033,6 @@ declare namespace Office {
|
|
|
21927
22033
|
/**
|
|
21928
22034
|
* Sets the recurrence pattern of an appointment series.
|
|
21929
22035
|
*
|
|
21930
|
-
* **Note**: `setAsync` should only be available for series items and not instance items.
|
|
21931
|
-
*
|
|
21932
22036
|
* @remarks
|
|
21933
22037
|
* [Api set: Mailbox 1.7]
|
|
21934
22038
|
*
|
|
@@ -21936,6 +22040,13 @@ declare namespace Office {
|
|
|
21936
22040
|
*
|
|
21937
22041
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
21938
22042
|
*
|
|
22043
|
+
* **Important**:
|
|
22044
|
+
*
|
|
22045
|
+
* - `setAsync` is only available for series items and not instance items.
|
|
22046
|
+
*
|
|
22047
|
+
* - The `setAsync` method isn't supported on a message that's currently loaded using the `loadItemByIdAsync` method.
|
|
22048
|
+
* 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}.
|
|
22049
|
+
*
|
|
21939
22050
|
* **Errors**:
|
|
21940
22051
|
*
|
|
21941
22052
|
* - `InvalidEndTime`: The appointment end time is before its start time.
|
|
@@ -21950,8 +22061,6 @@ declare namespace Office {
|
|
|
21950
22061
|
/**
|
|
21951
22062
|
* Sets the recurrence pattern of an appointment series.
|
|
21952
22063
|
*
|
|
21953
|
-
* **Note**: `setAsync` should only be available for series items and not instance items.
|
|
21954
|
-
*
|
|
21955
22064
|
* @remarks
|
|
21956
22065
|
* [Api set: Mailbox 1.7]
|
|
21957
22066
|
*
|
|
@@ -21959,6 +22068,13 @@ declare namespace Office {
|
|
|
21959
22068
|
*
|
|
21960
22069
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
21961
22070
|
*
|
|
22071
|
+
* **Important**:
|
|
22072
|
+
*
|
|
22073
|
+
* - `setAsync` is only available for series items and not instance items.
|
|
22074
|
+
*
|
|
22075
|
+
* - The `setAsync` method isn't supported on a message that's currently loaded using the `loadItemByIdAsync` method.
|
|
22076
|
+
* 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}.
|
|
22077
|
+
*
|
|
21962
22078
|
* **Errors**:
|
|
21963
22079
|
*
|
|
21964
22080
|
* - `InvalidEndTime`: The appointment end time is before its start time.
|
|
@@ -22481,7 +22597,12 @@ declare namespace Office {
|
|
|
22481
22597
|
*
|
|
22482
22598
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
22483
22599
|
*
|
|
22484
|
-
* **Important**:
|
|
22600
|
+
* **Important**:
|
|
22601
|
+
*
|
|
22602
|
+
* - To use the sensitivity label feature in your add-in, you must have a Microsoft 365 E5 subscription.
|
|
22603
|
+
*
|
|
22604
|
+
* - The `setAsync` method isn't supported on a message that's currently loaded using the `loadItemByIdAsync` method.
|
|
22605
|
+
* 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
22606
|
*
|
|
22486
22607
|
* **Tip**: To determine the sensitivity labels available for use, call the `Office.context.sensitivityLabelsCatalog.getAsync` method.
|
|
22487
22608
|
*
|
|
@@ -22506,7 +22627,12 @@ declare namespace Office {
|
|
|
22506
22627
|
*
|
|
22507
22628
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
22508
22629
|
*
|
|
22509
|
-
* **Important**:
|
|
22630
|
+
* **Important**:
|
|
22631
|
+
*
|
|
22632
|
+
* - To use the sensitivity label feature in your add-in, you must have a Microsoft 365 E5 subscription.
|
|
22633
|
+
*
|
|
22634
|
+
* - The `setAsync` method isn't supported on a message that's currently loaded using the `loadItemByIdAsync` method.
|
|
22635
|
+
* 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
22636
|
*
|
|
22511
22637
|
* **Tip**: To determine the sensitivity labels available for use, call the `Office.context.sensitivityLabelsCatalog.getAsync` method.
|
|
22512
22638
|
*
|
|
@@ -23535,10 +23661,15 @@ declare namespace Office {
|
|
|
23535
23661
|
*
|
|
23536
23662
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
23537
23663
|
*
|
|
23538
|
-
* **Important**:
|
|
23664
|
+
* **Important**:
|
|
23665
|
+
*
|
|
23666
|
+
* - In Outlook on Android and on iOS, this method isn't supported in the Message Compose mode. Only the Appointment Organizer mode is
|
|
23539
23667
|
* supported. For more information on supported APIs in Outlook mobile, see
|
|
23540
23668
|
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
|
|
23541
23669
|
*
|
|
23670
|
+
* - The `setAsync` method isn't supported on a message that's currently loaded using the `loadItemByIdAsync` method.
|
|
23671
|
+
* 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}.
|
|
23672
|
+
*
|
|
23542
23673
|
* **Errors**:
|
|
23543
23674
|
*
|
|
23544
23675
|
* - `DataExceedsMaximumSize`: The subject parameter is longer than 255 characters.
|
|
@@ -23563,10 +23694,15 @@ declare namespace Office {
|
|
|
23563
23694
|
*
|
|
23564
23695
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
23565
23696
|
*
|
|
23566
|
-
* **Important**:
|
|
23697
|
+
* **Important**:
|
|
23698
|
+
*
|
|
23699
|
+
* - In Outlook on Android and on iOS, this method isn't supported in the Message Compose mode. Only the Appointment Organizer mode is
|
|
23567
23700
|
* supported. For more information on supported APIs in Outlook mobile, see
|
|
23568
23701
|
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
|
|
23569
23702
|
*
|
|
23703
|
+
* - The `setAsync` method isn't supported on a message that's currently loaded using the `loadItemByIdAsync` method.
|
|
23704
|
+
* 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}.
|
|
23705
|
+
*
|
|
23570
23706
|
* **Errors**:
|
|
23571
23707
|
*
|
|
23572
23708
|
* - `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.490",
|
|
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": "911ee1c530e3798c50136faf3bed570ecff0a41cd31148cb026769a535982082",
|
|
50
50
|
"typeScriptVersion": "5.1"
|
|
51
51
|
}
|