@types/office-js-preview 1.0.612 → 1.0.614

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.
@@ -8,7 +8,7 @@ This package contains type definitions for office-js-preview (https://github.com
8
8
  Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-js-preview.
9
9
 
10
10
  ### Additional Details
11
- * Last updated: Fri, 11 Jul 2025 17:36:19 GMT
11
+ * Last updated: Mon, 14 Jul 2025 19:33:55 GMT
12
12
  * Dependencies: none
13
13
 
14
14
  # Credits
@@ -653,7 +653,7 @@ declare namespace Office {
653
653
  *
654
654
  * - Although Outlook on Mac supports the `InsightMessage` notification type, it currently doesn't support the `InfobarClicked` event.
655
655
  * To determine when the **Dismiss** action is selected from the notification, implement a handler for the `OnInfoBarDismissClicked` event instead.
656
- * For more information, see {@link https://learn.microsoft.com/office/dev/add-ins/outlook/autolaunch#supported-events | Configure your Outlook add-in for event-based activation}.
656
+ * For more information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/event-based-activation#supported-events | Activate add-ins with events}.
657
657
  *
658
658
  * [Api set: Mailbox 1.10]
659
659
  */
@@ -708,7 +708,7 @@ declare namespace Office {
708
708
  * - The `OfficeThemeChanged` event can only be handled in a task pane. Function commands can't register a handler for this event.
709
709
  *
710
710
  * - The `OfficeThemeChanged` event isn't supported in add-ins that implement
711
- * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/autolaunch | event-based activation}.
711
+ * {@link https://learn.microsoft.com/office/dev/add-ins/develop/event-based-activation | event-based activation}.
712
712
  *
713
713
  * [Api set: Mailbox 1.14]
714
714
  */
@@ -3395,7 +3395,7 @@ declare namespace Office {
3395
3395
  * Mailbox 1.5, the `options` parameter is supported in online-meeting provider and note-logging mobile add-ins. For more information on API support in
3396
3396
  * Outlook on mobile devices, see {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
3397
3397
  *
3398
- * - {@link https://learn.microsoft.com/office/dev/add-ins/outlook/autolaunch | Event-based activation} and
3398
+ * - {@link https://learn.microsoft.com/office/dev/add-ins/develop/event-based-activation | Event-based activation} and
3399
3399
  * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/spam-reporting | integrated spam-reporting} add-ins use a different event object to signal when they've
3400
3400
  * completed processing an event. For more information, see {@link https://learn.microsoft.com/javascript/api/outlook/office.mailboxevent | Office.MailboxEvent}.
3401
3401
  *
@@ -3424,7 +3424,7 @@ declare namespace Office {
3424
3424
  * note-logging mobile add-ins. For more information on API support in Outlook on mobile devices, see
3425
3425
  * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
3426
3426
  *
3427
- * - {@link https://learn.microsoft.com/office/dev/add-ins/outlook/autolaunch | Event-based activation} and
3427
+ * - {@link https://learn.microsoft.com/office/dev/add-ins/develop/event-based-activation | Event-based activation} and
3428
3428
  * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/spam-reporting | integrated spam-reporting} add-ins use a different event object to signal when they've
3429
3429
  * completed processing an event. For more information, see {@link https://learn.microsoft.com/javascript/api/outlook/office.mailboxevent | Office.MailboxEvent}.
3430
3430
  */
@@ -5531,7 +5531,7 @@ declare namespace Office {
5531
5531
  *
5532
5532
  * - If a user selects **Deny** from the dialog, the user will be requested for permissions again the next time the add-in requires access to the user's device capabilities.
5533
5533
  *
5534
- * - If your add-in implements {@link https://learn.microsoft.com/office/dev/add-ins/outlook/autolaunch | event-based activation},
5534
+ * - If your add-in implements {@link https://learn.microsoft.com/office/dev/add-ins/develop/event-based-activation | event-based activation},
5535
5535
  * browser permissions to device capabilities aren't inherited and the `requestPermissionsAsync` method isn't supported.
5536
5536
  *
5537
5537
  * @param permissions An array of device capabilities to which an add-in is requesting access.
@@ -5572,7 +5572,7 @@ declare namespace Office {
5572
5572
  *
5573
5573
  * - If a user selects **Deny** from the dialog, the user will be requested for permissions again the next time the add-in requires access to the user's device capabilities.
5574
5574
  *
5575
- * - If your add-in implements {@link https://learn.microsoft.com/office/dev/add-ins/outlook/autolaunch | event-based activation},
5575
+ * - If your add-in implements {@link https://learn.microsoft.com/office/dev/add-ins/develop/event-based-activation | event-based activation},
5576
5576
  * browser permissions to device capabilities aren't inherited and the `requestPermissionsAsync` method isn't supported.
5577
5577
  *
5578
5578
  * @param permissions An array of device capabilities to which an add-in is requesting access.
@@ -7223,7 +7223,7 @@ declare namespace Office {
7223
7223
  *
7224
7224
  * **Important**: In Outlook, the Office theme API is supported starting in
7225
7225
  * {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.14/outlook-requirement-set-1.14 | Mailbox requirement set 1.14}.
7226
- * It isn't supported in Outlook add-ins that implement {@link https://learn.microsoft.com/office/dev/add-ins/outlook/autolaunch | event-based activation}.
7226
+ * It isn't supported in Outlook add-ins that implement {@link https://learn.microsoft.com/office/dev/add-ins/develop/event-based-activation | event-based activation}.
7227
7227
  */
7228
7228
  interface OfficeTheme {
7229
7229
  /**
@@ -7247,7 +7247,11 @@ declare namespace Office {
7247
7247
  *
7248
7248
  * @remarks
7249
7249
  *
7250
- * **Important**: The `isDarkTheme` property isn't yet supported in Outlook.
7250
+ * **Important**: The `isDarkTheme` property isn't supported in Outlook. To determine the current theme in Outlook,
7251
+ * use the `body*Color` and `control*Color` properties instead. To automatically detect theme changes, use the
7252
+ * {@link https://learn.microsoft.com/javascript/api/outlook/office.mailbox#outlook-office-mailbox-addhandlerasync-member(1) | addHandlerAsync}
7253
+ * method to create an event handler for the {@link https://learn.microsoft.com/javascript/api/office/office.eventtype#fields | OfficeThemeChanged}
7254
+ * event.
7251
7255
  */
7252
7256
  isDarkTheme: boolean;
7253
7257
  /**
@@ -7255,7 +7259,11 @@ declare namespace Office {
7255
7259
  *
7256
7260
  * @remarks
7257
7261
  *
7258
- * **Important**: The `themeId` property isn't yet supported in Outlook.
7262
+ * **Important**: The `themeId` property isn't supported in Outlook. To determine the current theme in Outlook,
7263
+ * use the `body*Color` and `control*Color` properties instead. To automatically detect theme changes, use the
7264
+ * {@link https://learn.microsoft.com/javascript/api/outlook/office.mailbox#outlook-office-mailbox-addhandlerasync-member(1) | addHandlerAsync}
7265
+ * method to create an event handler for the {@link https://learn.microsoft.com/javascript/api/office/office.eventtype#fields | OfficeThemeChanged}
7266
+ * event.
7259
7267
  */
7260
7268
  themeId: ThemeId;
7261
7269
  }
@@ -8788,7 +8796,7 @@ declare namespace Office {
8788
8796
  *
8789
8797
  * - The URL that's returned points to the location of the JavaScript file that classic Outlook on Windows uses to handle event-based activation
8790
8798
  * and integrated spam reporting. To learn more about these features, see
8791
- * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/autolaunch | Configure your Outlook add-in for event-based activation} and
8799
+ * {@link https://learn.microsoft.com/office/dev/add-ins/develop/event-based-activation | Activate add-ins with events} and
8792
8800
  * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/spam-reporting | Implement an integrated spam-reporting add-in}.
8793
8801
  *
8794
8802
  * - In Outlook on the web and {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows},
@@ -11571,7 +11579,7 @@ declare namespace Office {
11571
11579
  * **Important**:
11572
11580
  *
11573
11581
  * - The `sendAsync` method is only supported in task pane and function command implementations. It isn't supported in
11574
- * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/autolaunch | event-based handlers} or
11582
+ * {@link https://learn.microsoft.com/office/dev/add-ins/develop/event-based-activation | event-based handlers} or
11575
11583
  * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/item-multi-select | item multi-select scenarios}.
11576
11584
  *
11577
11585
  * - In a function command implementation, the value returned in `asyncResult.status` may not reflect whether the appointment being composed is successfully sent.
@@ -11606,7 +11614,7 @@ declare namespace Office {
11606
11614
  * **Important**:
11607
11615
  *
11608
11616
  * - The `sendAsync` method is only supported in task pane and function command implementations. It isn't supported in
11609
- * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/autolaunch | event-based handlers} or
11617
+ * {@link https://learn.microsoft.com/office/dev/add-ins/develop/event-based-activation | event-based handlers} or
11610
11618
  * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/item-multi-select | item multi-select scenarios}.
11611
11619
  *
11612
11620
  * - In a function command implementation, the value returned in `asyncResult.status` may not reflect whether the appointment being composed is successfully sent.
@@ -13047,6 +13055,9 @@ declare namespace Office {
13047
13055
  * @remarks
13048
13056
  * [Api set: Mailbox 1.1]
13049
13057
  *
13058
+ * To learn how to get or set the body of a mail item, see
13059
+ * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/insert-data-in-the-body | Get or set the body of a message or appointment in Outlook}.
13060
+ *
13050
13061
  * **Known issue with HTML table border colors**
13051
13062
  *
13052
13063
  * Outlook on Windows: If you're setting various cell borders to different colors in an HTML table in Compose mode, a cell's borders may not reflect
@@ -13173,7 +13184,7 @@ declare namespace Office {
13173
13184
  * - In Outlook on the web and new Outlook on Windows, users can organize their messages as conversations or individual messages in **Settings** > **Mail** > **Layout** > **Message organization**
13174
13185
  * (see {@link https://support.microsoft.com/office/57fe0cd8-e90b-4b1b-91e4-a0ba658c0042 | Change how the message list is displayed in Outlook}).
13175
13186
  * This setting affects how much of a message's body is displayed to the user (that is, the entire conversation thread of a message or just the current message).
13176
- * In Message Compose mode, particulary for replies to a conversation thread with more than one message, if you want the returned body to reflect the user's setting,
13187
+ * In Message Compose mode, particularly for replies to a conversation thread with more than one message, if you want the returned body to reflect the user's setting,
13177
13188
  * specify the `bodyMode: Office.MailboxEnums.BodyMode.HostConfig` parameter in your `getAsync` call. If messages are grouped by conversation,
13178
13189
  * only the body of the current reply is returned. Conversely, if messages are displayed individually, the entire conversation thread is returned.
13179
13190
  *
@@ -13213,7 +13224,7 @@ declare namespace Office {
13213
13224
  * - In Outlook on the web and new Outlook on Windows, users can organize their messages as conversations or individual messages in **Settings** > **Mail** > **Layout** > **Message organization**
13214
13225
  * (see {@link https://support.microsoft.com/office/57fe0cd8-e90b-4b1b-91e4-a0ba658c0042 | Change how the message list is displayed in Outlook}).
13215
13226
  * This setting affects how much of a message's body is displayed to the user (that is, the entire conversation thread of a message or just the current message).
13216
- * In Message Compose mode, particulary for replies to a conversation thread with more than one message, if you want the returned body to reflect the user's setting,
13227
+ * In Message Compose mode, particularly for replies to a conversation thread with more than one message, if you want the returned body to reflect the user's setting,
13217
13228
  * specify the `bodyMode: Office.MailboxEnums.BodyMode.HostConfig` parameter in your `getAsync` call. If messages are grouped by conversation,
13218
13229
  * only the body of the current reply is returned. Conversely, if messages are displayed individually, the entire conversation thread is returned.
13219
13230
  *
@@ -13495,7 +13506,7 @@ declare namespace Office {
13495
13506
  * - In Outlook on the web and new Outlook on Windows, users can organize their messages as conversations or individual messages in **Settings** > **Mail** > **Layout** > **Message organization**
13496
13507
  * (see {@link https://support.microsoft.com/office/57fe0cd8-e90b-4b1b-91e4-a0ba658c0042 | Change how the message list is displayed in Outlook}).
13497
13508
  * This setting affects how much of a message's body is displayed to the user (that is, the entire conversation thread of a message or just the current message).
13498
- * In Message Compose mode, particulary for replies to a conversation thread with more than one message, if you want to honor the user's settings when
13509
+ * In Message Compose mode, particularly for replies to a conversation thread with more than one message, if you want to honor the user's settings when
13499
13510
  * setting the body of a message, specify the `bodyMode: Office.MailboxEnums.BodyMode.HostConfig` parameter in your `setAsync` call. If messages are grouped by conversation,
13500
13511
  * only the body of the current reply is set. Conversely, if messages are displayed individually, the entire body, including previous messages
13501
13512
  * in the conversation thread, is replaced.
@@ -13565,7 +13576,7 @@ declare namespace Office {
13565
13576
  * - In Outlook on the web and new Outlook on Windows, users can organize their messages as conversations or individual messages in **Settings** > **Mail** > **Layout** > **Message organization**
13566
13577
  * (see {@link https://support.microsoft.com/office/57fe0cd8-e90b-4b1b-91e4-a0ba658c0042 | Change how the message list is displayed in Outlook}).
13567
13578
  * This setting affects how much of a message's body is displayed to the user (that is, the entire conversation thread of a message or just the current message).
13568
- * In Message Compose mode, particulary for replies in a conversation thread with more than one message, if you want to honor the user's settings when
13579
+ * In Message Compose mode, particularly for replies in a conversation thread with more than one message, if you want to honor the user's settings when
13569
13580
  * setting the body of a message, specify the `bodyMode: Office.MailboxEnums.BodyMode.HostConfig` parameter in your `setAsync` call. If messages are grouped by conversation,
13570
13581
  * only the body of the current reply is set. Conversely, if messages are displayed individually, the entire body, including previous messages
13571
13582
  * in the conversation thread, is replaced.
@@ -13688,7 +13699,7 @@ declare namespace Office {
13688
13699
  * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
13689
13700
  *
13690
13701
  * - The behavior of `setSignatureAsync` differs if you call it in the event handler of an add-in that implements the
13691
- * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/autolaunch | event-based activation feature using LaunchEvent in the manifest}.
13702
+ * {@link https://learn.microsoft.com/office/dev/add-ins/develop/event-based-activation | event-based activation feature using LaunchEvent in the manifest}.
13692
13703
  * When the user composes a new item (including reply or forward), the signature is set but doesn't modify the form. This means
13693
13704
  * if the user closes the form without making other edits, they won't be prompted to save changes.
13694
13705
  *
@@ -13735,7 +13746,7 @@ declare namespace Office {
13735
13746
  * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
13736
13747
  *
13737
13748
  * - The behavior of `setSignatureAsync` differs if you call it in the event handler of an add-in that implements the
13738
- * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/autolaunch | event-based activation feature using LaunchEvent in the manifest}.
13749
+ * {@link https://learn.microsoft.com/office/dev/add-ins/develop/event-based-activation | event-based activation feature using LaunchEvent in the manifest}.
13739
13750
  * When the user composes a new item (including reply or forward), the signature is set but doesn't modify the form. This means
13740
13751
  * if the user closes the form without making other edits, they won't be prompted to save changes.
13741
13752
  *
@@ -18484,7 +18495,7 @@ declare namespace Office {
18484
18495
  }
18485
18496
  /**
18486
18497
  * The `MailboxEvent` object is passed as an argument to the event handler of an add-in that implements
18487
- * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/autolaunch | event-based activation}, including
18498
+ * {@link https://learn.microsoft.com/office/dev/add-ins/develop/event-based-activation | event-based activation}, including
18488
18499
  * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/onmessagesend-onappointmentsend-events | Smart Alerts},
18489
18500
  * or the {@link https://learn.microsoft.com/office/dev/add-ins/outlook/spam-reporting | integrated spam-reporting feature}.
18490
18501
  * It allows the add-in to signify to the Outlook client that it has completed processing an event.
@@ -19364,7 +19375,7 @@ declare namespace Office {
19364
19375
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose
19365
19376
  *
19366
19377
  * **Important**: The `closeAsync` method is only supported in task pane and function command implementations. It isn't supported in
19367
- * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/autolaunch | event-based handlers} or
19378
+ * {@link https://learn.microsoft.com/office/dev/add-ins/develop/event-based-activation | event-based handlers} or
19368
19379
  * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/item-multi-select | item multi-select scenarios}.
19369
19380
  *
19370
19381
  * **Errors**:
@@ -19400,7 +19411,7 @@ declare namespace Office {
19400
19411
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose
19401
19412
  *
19402
19413
  * **Important**: The `closeAsync` method is only supported in task pane and function command implementations. It isn't supported in
19403
- * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/autolaunch | event-based handlers} or
19414
+ * {@link https://learn.microsoft.com/office/dev/add-ins/develop/event-based-activation | event-based handlers} or
19404
19415
  * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/item-multi-select | item multi-select scenarios}.
19405
19416
  *
19406
19417
  * **Errors**:
@@ -20284,7 +20295,7 @@ declare namespace Office {
20284
20295
  * **Important**:
20285
20296
  *
20286
20297
  * - The `sendAsync` method is only supported in task pane and function command implementations. It isn't supported in
20287
- * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/autolaunch | event-based handlers} or
20298
+ * {@link https://learn.microsoft.com/office/dev/add-ins/develop/event-based-activation | event-based handlers} or
20288
20299
  * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/item-multi-select | item multi-select scenarios}.
20289
20300
  *
20290
20301
  * - In a function command implementation, the value returned in `asyncResult.status` may not reflect whether the appointment being composed is successfully sent.
@@ -20319,7 +20330,7 @@ declare namespace Office {
20319
20330
  * **Important**:
20320
20331
  *
20321
20332
  * - The `sendAsync` method is only supported in task pane and function command implementations. It isn't supported in
20322
- * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/autolaunch | event-based handlers} or
20333
+ * {@link https://learn.microsoft.com/office/dev/add-ins/develop/event-based-activation | event-based handlers} or
20323
20334
  * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/item-multi-select | item multi-select scenarios}.
20324
20335
  *
20325
20336
  * - In a function command implementation, the value returned in `asyncResult.status` may not reflect whether the appointment being composed is successfully sent.
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@types/office-js-preview",
3
- "version": "1.0.612",
3
+ "version": "1.0.614",
4
4
  "description": "TypeScript definitions for office-js-preview",
5
5
  "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-js-preview",
6
6
  "license": "MIT",
@@ -46,7 +46,7 @@
46
46
  "scripts": {},
47
47
  "dependencies": {},
48
48
  "peerDependencies": {},
49
- "typesPublisherContentHash": "b889add30a0d5805b1cd1bdb16560067c1d2717c22cb26f28c02d95fc1ea02be",
49
+ "typesPublisherContentHash": "621442741d63d6651910ad8b6cfc522562cd7706e53d5b49fdac984f28b16936",
50
50
  "typeScriptVersion": "5.1",
51
51
  "nonNpm": true
52
52
  }