@types/office-js 1.0.514 → 1.0.516

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 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: Thu, 26 Jun 2025 21:02:18 GMT
11
+ * Last updated: Fri, 11 Jul 2025 18:02:44 GMT
12
12
  * Dependencies: none
13
13
 
14
14
  # Credits
office-js/index.d.ts CHANGED
@@ -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
  */
@@ -3393,7 +3393,7 @@ declare namespace Office {
3393
3393
  * 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
3394
3394
  * 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}.
3395
3395
  *
3396
- * - {@link https://learn.microsoft.com/office/dev/add-ins/outlook/autolaunch | Event-based activation} and
3396
+ * - {@link https://learn.microsoft.com/office/dev/add-ins/develop/event-based-activation | Event-based activation} and
3397
3397
  * {@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
3398
3398
  * completed processing an event. For more information, see {@link https://learn.microsoft.com/javascript/api/outlook/office.mailboxevent | Office.MailboxEvent}.
3399
3399
  *
@@ -3422,7 +3422,7 @@ declare namespace Office {
3422
3422
  * note-logging mobile add-ins. For more information on API support in Outlook on mobile devices, see
3423
3423
  * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
3424
3424
  *
3425
- * - {@link https://learn.microsoft.com/office/dev/add-ins/outlook/autolaunch | Event-based activation} and
3425
+ * - {@link https://learn.microsoft.com/office/dev/add-ins/develop/event-based-activation | Event-based activation} and
3426
3426
  * {@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
3427
3427
  * completed processing an event. For more information, see {@link https://learn.microsoft.com/javascript/api/outlook/office.mailboxevent | Office.MailboxEvent}.
3428
3428
  */
@@ -5479,7 +5479,7 @@ declare namespace Office {
5479
5479
  *
5480
5480
  * - 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.
5481
5481
  *
5482
- * - If your add-in implements {@link https://learn.microsoft.com/office/dev/add-ins/outlook/autolaunch | event-based activation},
5482
+ * - If your add-in implements {@link https://learn.microsoft.com/office/dev/add-ins/develop/event-based-activation | event-based activation},
5483
5483
  * browser permissions to device capabilities aren't inherited and the `requestPermissionsAsync` method isn't supported.
5484
5484
  *
5485
5485
  * @param permissions An array of device capabilities to which an add-in is requesting access.
@@ -5520,7 +5520,7 @@ declare namespace Office {
5520
5520
  *
5521
5521
  * - 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.
5522
5522
  *
5523
- * - If your add-in implements {@link https://learn.microsoft.com/office/dev/add-ins/outlook/autolaunch | event-based activation},
5523
+ * - If your add-in implements {@link https://learn.microsoft.com/office/dev/add-ins/develop/event-based-activation | event-based activation},
5524
5524
  * browser permissions to device capabilities aren't inherited and the `requestPermissionsAsync` method isn't supported.
5525
5525
  *
5526
5526
  * @param permissions An array of device capabilities to which an add-in is requesting access.
@@ -7171,7 +7171,7 @@ declare namespace Office {
7171
7171
  *
7172
7172
  * **Important**: In Outlook, the Office theme API is supported starting in
7173
7173
  * {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.14/outlook-requirement-set-1.14 | Mailbox requirement set 1.14}.
7174
- * It isn't supported in Outlook add-ins that implement {@link https://learn.microsoft.com/office/dev/add-ins/outlook/autolaunch | event-based activation}.
7174
+ * 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}.
7175
7175
  */
7176
7176
  interface OfficeTheme {
7177
7177
  /**
@@ -8736,7 +8736,7 @@ declare namespace Office {
8736
8736
  *
8737
8737
  * - The URL that's returned points to the location of the JavaScript file that classic Outlook on Windows uses to handle event-based activation
8738
8738
  * and integrated spam reporting. To learn more about these features, see
8739
- * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/autolaunch | Configure your Outlook add-in for event-based activation} and
8739
+ * {@link https://learn.microsoft.com/office/dev/add-ins/develop/event-based-activation | Activate add-ins with events} and
8740
8740
  * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/spam-reporting | Implement an integrated spam-reporting add-in}.
8741
8741
  *
8742
8742
  * - In Outlook on the web and {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows},
@@ -11480,7 +11480,7 @@ declare namespace Office {
11480
11480
  * **Important**:
11481
11481
  *
11482
11482
  * - The `sendAsync` method is only supported in task pane and function command implementations. It isn't supported in
11483
- * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/autolaunch | event-based handlers} or
11483
+ * {@link https://learn.microsoft.com/office/dev/add-ins/develop/event-based-activation | event-based handlers} or
11484
11484
  * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/item-multi-select | item multi-select scenarios}.
11485
11485
  *
11486
11486
  * - In a function command implementation, the value returned in `asyncResult.status` may not reflect whether the appointment being composed is successfully sent.
@@ -11515,7 +11515,7 @@ declare namespace Office {
11515
11515
  * **Important**:
11516
11516
  *
11517
11517
  * - The `sendAsync` method is only supported in task pane and function command implementations. It isn't supported in
11518
- * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/autolaunch | event-based handlers} or
11518
+ * {@link https://learn.microsoft.com/office/dev/add-ins/develop/event-based-activation | event-based handlers} or
11519
11519
  * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/item-multi-select | item multi-select scenarios}.
11520
11520
  *
11521
11521
  * - In a function command implementation, the value returned in `asyncResult.status` may not reflect whether the appointment being composed is successfully sent.
@@ -13525,7 +13525,7 @@ declare namespace Office {
13525
13525
  * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
13526
13526
  *
13527
13527
  * - The behavior of `setSignatureAsync` differs if you call it in the event handler of an add-in that implements the
13528
- * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/autolaunch | event-based activation feature using LaunchEvent in the manifest}.
13528
+ * {@link https://learn.microsoft.com/office/dev/add-ins/develop/event-based-activation | event-based activation feature using LaunchEvent in the manifest}.
13529
13529
  * When the user composes a new item (including reply or forward), the signature is set but doesn't modify the form. This means
13530
13530
  * if the user closes the form without making other edits, they won't be prompted to save changes.
13531
13531
  *
@@ -13572,7 +13572,7 @@ declare namespace Office {
13572
13572
  * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
13573
13573
  *
13574
13574
  * - The behavior of `setSignatureAsync` differs if you call it in the event handler of an add-in that implements the
13575
- * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/autolaunch | event-based activation feature using LaunchEvent in the manifest}.
13575
+ * {@link https://learn.microsoft.com/office/dev/add-ins/develop/event-based-activation | event-based activation feature using LaunchEvent in the manifest}.
13576
13576
  * When the user composes a new item (including reply or forward), the signature is set but doesn't modify the form. This means
13577
13577
  * if the user closes the form without making other edits, they won't be prompted to save changes.
13578
13578
  *
@@ -15593,7 +15593,7 @@ declare namespace Office {
15593
15593
  *
15594
15594
  * 3. The delegate opens the draft from the shared folder then continues composing.
15595
15595
  *
15596
- * b. **Shared mailbox (applies to classic Outlook on Windows only)**
15596
+ * b. **Shared mailbox opened in the same panel as the user's primary mailbox (web, classic Windows) or shared mailbox that hasn't been promoted to a full account (new Windows)**
15597
15597
  *
15598
15598
  * 1. The shared mailbox user starts a message. This can be a new message, a reply, or a forward.
15599
15599
  *
@@ -15601,8 +15601,14 @@ declare namespace Office {
15601
15601
  *
15602
15602
  * 3. Another shared mailbox user opens the draft from the shared mailbox then continues composing.
15603
15603
  *
15604
- * The message is now in a shared context and add-ins that support these shared scenarios can get the item's shared properties.
15605
- * After the message has been sent, it's usually found in the sender's **Sent Items** folder.
15604
+ * Once these conditions are met, the message becomes available in a shared context and add-ins that support these shared scenarios can get the item's shared properties.
15605
+ * After the message is sent, it's usually found in the **Sent Items** folder of the sender's personal mailbox.
15606
+ *
15607
+ * The `getSharedPropertiesAsync` method is supported on the following platforms without additional conditions.
15608
+ *
15609
+ * - Outlook on the web when the shared mailbox is opened in a separate tab or window using the **Open another mailbox** option.
15610
+ *
15611
+ * - New Outlook on Windows when the shared mailbox is promoted to a full account.
15606
15612
  *
15607
15613
  * @param options - An object literal that contains one or more of the following properties:-
15608
15614
  * `asyncContext`: Developers can provide any object they wish to access in the callback function.
@@ -15634,7 +15640,7 @@ declare namespace Office {
15634
15640
  *
15635
15641
  * 3. The delegate opens the draft from the shared folder then continues composing.
15636
15642
  *
15637
- * b. **Shared mailbox (applies to Outlook on Windows only)**
15643
+ * b. **Shared mailbox opened in the same panel as the user's primary mailbox (web, classic Windows) or shared mailbox that hasn't been promoted to a full account (new Windows)**
15638
15644
  *
15639
15645
  * 1. The shared mailbox user starts a message. This can be a new message, a reply, or a forward.
15640
15646
  *
@@ -15642,8 +15648,14 @@ declare namespace Office {
15642
15648
  *
15643
15649
  * 3. Another shared mailbox user opens the draft from the shared mailbox then continues composing.
15644
15650
  *
15645
- * The message is now in a shared context and add-ins that support these shared scenarios can get the item's shared properties.
15646
- * After the message has been sent, it's usually found in the sender's **Sent Items** folder.
15651
+ * Once these conditions are met, the message becomes available in a shared context and add-ins that support these shared scenarios can get the item's shared properties.
15652
+ * After the message is sent, it's usually found in the **Sent Items** folder of the sender's personal mailbox.
15653
+ *
15654
+ * The `getSharedPropertiesAsync` method is supported on the following platforms without additional conditions.
15655
+ *
15656
+ * - Outlook on the web when the shared mailbox is opened in a separate tab or window using the **Open another mailbox** option.
15657
+ *
15658
+ * - New Outlook on Windows when the shared mailbox is promoted to a full account.
15647
15659
  *
15648
15660
  * @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter, `asyncResult`, which is an
15649
15661
  * `Office.AsyncResult` object. The `asyncResult.value` property provides the properties of the shared item.
@@ -18102,7 +18114,7 @@ declare namespace Office {
18102
18114
  }
18103
18115
  /**
18104
18116
  * The `MailboxEvent` object is passed as an argument to the event handler of an add-in that implements
18105
- * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/autolaunch | event-based activation}, including
18117
+ * {@link https://learn.microsoft.com/office/dev/add-ins/develop/event-based-activation | event-based activation}, including
18106
18118
  * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/onmessagesend-onappointmentsend-events | Smart Alerts},
18107
18119
  * or the {@link https://learn.microsoft.com/office/dev/add-ins/outlook/spam-reporting | integrated spam-reporting feature}.
18108
18120
  * It allows the add-in to signify to the Outlook client that it has completed processing an event.
@@ -18983,7 +18995,7 @@ declare namespace Office {
18983
18995
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose
18984
18996
  *
18985
18997
  * **Important**: The `closeAsync` method is only supported in task pane and function command implementations. It isn't supported in
18986
- * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/autolaunch | event-based handlers} or
18998
+ * {@link https://learn.microsoft.com/office/dev/add-ins/develop/event-based-activation | event-based handlers} or
18987
18999
  * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/item-multi-select | item multi-select scenarios}.
18988
19000
  *
18989
19001
  * **Errors**:
@@ -19019,7 +19031,7 @@ declare namespace Office {
19019
19031
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose
19020
19032
  *
19021
19033
  * **Important**: The `closeAsync` method is only supported in task pane and function command implementations. It isn't supported in
19022
- * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/autolaunch | event-based handlers} or
19034
+ * {@link https://learn.microsoft.com/office/dev/add-ins/develop/event-based-activation | event-based handlers} or
19023
19035
  * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/item-multi-select | item multi-select scenarios}.
19024
19036
  *
19025
19037
  * **Errors**:
@@ -19562,7 +19574,7 @@ declare namespace Office {
19562
19574
  *
19563
19575
  * 3. The delegate opens the draft from the shared folder then continues composing.
19564
19576
  *
19565
- * b. **Shared mailbox**
19577
+ * b. **Shared mailbox opened in the same panel as the user's primary mailbox (web, classic Windows) or shared mailbox that hasn't been promoted to a full account (new Windows)**
19566
19578
  *
19567
19579
  * 1. The shared mailbox user starts a message. This can be a new message, a reply, or a forward.
19568
19580
  *
@@ -19570,8 +19582,14 @@ declare namespace Office {
19570
19582
  *
19571
19583
  * 3. Another shared mailbox user opens the draft from the shared mailbox then continues composing.
19572
19584
  *
19573
- * The message is now in a shared context and add-ins that support these shared scenarios can get the item's shared properties.
19574
- * After the message has been sent, it's usually found in the sender's **Sent Items** folder.
19585
+ * Once these conditions are met, the message becomes available in a shared context and add-ins that support these shared scenarios can get the item's shared properties.
19586
+ * After the message is sent, it's usually found in the **Sent Items** folder of the sender's personal mailbox.
19587
+ *
19588
+ * The `getSharedPropertiesAsync` method is supported on the following platforms without additional conditions.
19589
+ *
19590
+ * - Outlook on the web when the shared mailbox is opened in a separate tab or window using the **Open another mailbox** option.
19591
+ *
19592
+ * - New Outlook on Windows when the shared mailbox is promoted to a full account.
19575
19593
  *
19576
19594
  * @param options - An object literal that contains one or more of the following properties:-
19577
19595
  * `asyncContext`: Developers can provide any object they wish to access in the callback function.
@@ -19605,7 +19623,7 @@ declare namespace Office {
19605
19623
  *
19606
19624
  * 3. The delegate opens the draft from the shared folder then continues composing.
19607
19625
  *
19608
- * b. **Shared mailbox**
19626
+ * b. **Shared mailbox opened in the same panel as the user's primary mailbox (web, classic Windows) or shared mailbox that hasn't been promoted to a full account (new Windows)**
19609
19627
  *
19610
19628
  * 1. The shared mailbox user starts a message. This can be a new message, a reply, or a forward.
19611
19629
  *
@@ -19613,8 +19631,14 @@ declare namespace Office {
19613
19631
  *
19614
19632
  * 3. Another shared mailbox user opens the draft from the shared mailbox then continues composing.
19615
19633
  *
19616
- * The message is now in a shared context and add-ins that support these shared scenarios can get the item's shared properties.
19617
- * After the message has been sent, it's usually found in the sender's **Sent Items** folder.
19634
+ * Once these conditions are met, the message becomes available in a shared context and add-ins that support these shared scenarios can get the item's shared properties.
19635
+ * After the message is sent, it's usually found in the **Sent Items** folder of the sender's personal mailbox.
19636
+ *
19637
+ * The `getSharedPropertiesAsync` method is supported on the following platforms without additional conditions.
19638
+ *
19639
+ * - Outlook on the web when the shared mailbox is opened in a separate tab or window using the **Open another mailbox** option.
19640
+ *
19641
+ * - New Outlook on Windows when the shared mailbox is promoted to a full account.
19618
19642
  *
19619
19643
  * @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter, `asyncResult`, which is an
19620
19644
  * `Office.AsyncResult` object. The `asyncResult.value` property provides the properties of the shared item.
@@ -19891,7 +19915,7 @@ declare namespace Office {
19891
19915
  * **Important**:
19892
19916
  *
19893
19917
  * - The `sendAsync` method is only supported in task pane and function command implementations. It isn't supported in
19894
- * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/autolaunch | event-based handlers} or
19918
+ * {@link https://learn.microsoft.com/office/dev/add-ins/develop/event-based-activation | event-based handlers} or
19895
19919
  * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/item-multi-select | item multi-select scenarios}.
19896
19920
  *
19897
19921
  * - In a function command implementation, the value returned in `asyncResult.status` may not reflect whether the appointment being composed is successfully sent.
@@ -19926,7 +19950,7 @@ declare namespace Office {
19926
19950
  * **Important**:
19927
19951
  *
19928
19952
  * - The `sendAsync` method is only supported in task pane and function command implementations. It isn't supported in
19929
- * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/autolaunch | event-based handlers} or
19953
+ * {@link https://learn.microsoft.com/office/dev/add-ins/develop/event-based-activation | event-based handlers} or
19930
19954
  * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/item-multi-select | item multi-select scenarios}.
19931
19955
  *
19932
19956
  * - In a function command implementation, the value returned in `asyncResult.status` may not reflect whether the appointment being composed is successfully sent.
office-js/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@types/office-js",
3
- "version": "1.0.514",
3
+ "version": "1.0.516",
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": "9fee624c29009ad589318f8b86bcda4e007ceff3571cea131fd7904f811fb906",
49
+ "typesPublisherContentHash": "1dad0807b345836b799ccea2adf99ba9219788034d194c76deef98d5c3911e62",
50
50
  "typeScriptVersion": "5.1"
51
51
  }