@types/office-js-preview 1.0.580 → 1.0.581

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: Mon, 07 Apr 2025 19:02:16 GMT
11
+ * Last updated: Mon, 14 Apr 2025 18:02:23 GMT
12
12
  * Dependencies: none
13
13
 
14
14
  # Credits
@@ -10433,6 +10433,9 @@ declare namespace Office {
10433
10433
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
10434
10434
  *
10435
10435
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Organizer
10436
+ *
10437
+ * **Important**: This property isn't supported in Outlook on Android or on iOS. For more information on supported APIs in Outlook mobile, see
10438
+ * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
10436
10439
  */
10437
10440
  notificationMessages: NotificationMessages;
10438
10441
  /**
@@ -12007,6 +12010,9 @@ declare namespace Office {
12007
12010
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
12008
12011
  *
12009
12012
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee
12013
+ *
12014
+ * **Important**: This property isn't supported in Outlook on Android or on iOS. For more information on supported APIs in Outlook mobile, see
12015
+ * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
12010
12016
  */
12011
12017
  notificationMessages: NotificationMessages;
12012
12018
  /**
@@ -21554,21 +21560,30 @@ declare namespace Office {
21554
21560
  /**
21555
21561
  * Specifies the `ItemNotificationMessageType` of message.
21556
21562
  *
21557
- * If type is `ProgressIndicator` or `ErrorMessage`, an icon is automatically supplied
21558
- * and the message is not persistent. Therefore the icon and persistent properties are not valid for these types of messages.
21563
+ * @remarks
21564
+ *
21565
+ * **Important**:
21566
+ *
21567
+ * - For the `ProgressIndicator` or `ErrorMessage` types, an icon is automatically supplied
21568
+ * and the message isn't persistent. Therefore, the icon and persistent properties aren't valid for these types of messages.
21559
21569
  * Including them will result in an `ArgumentException`.
21560
21570
  *
21561
- * If type is `ProgressIndicator`, the developer should remove or replace the progress indicator when the action is complete.
21571
+ * - For the `ProgressIndicator` type, you should remove or replace the progress indicator when the action is complete.
21562
21572
  *
21563
- * **Important**: Only the `InformationalMessage` type is supported in Outlook on Android and on iOS.
21573
+ * - In Outlook on Android and on iOS, only the `ProgressIndicator`, `InformationalMessage`, and `ErrorMessage` notification types are supported.
21574
+ *
21575
+ * - In compose mode, while the style of each notification type varies on other Outlook clients, notifications in Outlook on Android and on iOS
21576
+ * all use the same style. The notification message is always prefixed with an informational icon.
21564
21577
  */
21565
21578
  type: MailboxEnums.ItemNotificationMessageType | string;
21566
21579
  /**
21567
- * A reference to an icon that is defined in the manifest. It appears in the infobar area.
21568
- * It is applicable if the type is `InformationalMessage`, and is required if the type is `InsightMessage`.
21580
+ * A reference to an icon that's defined in the manifest. It appears in the infobar area.
21581
+ * It's applicable if the type is `InformationalMessage`, and is required if the type is `InsightMessage`.
21569
21582
  * Specifying this parameter for an unsupported type results in an exception.
21570
21583
  *
21571
- * **Note**: At present, the custom icon is displayed in Outlook on Windows only and not on other clients (e.g., Mac, web browser).
21584
+ * @remarks
21585
+ *
21586
+ * **Important**: Currently, the custom icon is only displayed in classic Outlook on Windows.
21572
21587
  */
21573
21588
  icon?: string;
21574
21589
  /**
@@ -21613,8 +21628,6 @@ declare namespace Office {
21613
21628
  /**
21614
21629
  * Adds a notification to an item.
21615
21630
  *
21616
- * There are a maximum of 5 notifications per message. Setting more will return a `NumberOfNotificationMessagesExceeded` error.
21617
- *
21618
21631
  * @remarks
21619
21632
  * [Api set: Mailbox 1.3]
21620
21633
  *
@@ -21624,13 +21637,20 @@ declare namespace Office {
21624
21637
  *
21625
21638
  * **Important**:
21626
21639
  *
21640
+ * - In Outlook on the web, on Windows (new and classic), and on Mac, you can set a maximum of five notifications per message.
21641
+ * Setting more returns a `NumberOfNotificationMessagesExceeded` error. In Outlook on Android and on iOS, you can only set one notification per message.
21642
+ * Setting an additional notification replaces the previous one.
21643
+ *
21627
21644
  * - Only one notification of type {@link https://learn.microsoft.com/javascript/api/outlook/office.mailboxenums.itemnotificationmessagetype#fields | InsightMessage}
21628
21645
  * is allowed per add-in. Attempting to add more will throw an error.
21629
21646
  *
21630
21647
  * - In modern Outlook on the web and {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows},
21631
21648
  * you can add an `InsightMessage` notification only in Compose mode.
21632
21649
  *
21633
- * - Only the `InformationalMessage` type is supported in Outlook on Android and on iOS.
21650
+ * - In Outlook on Android and on iOS, only the `ProgressIndicator`, `InformationalMessage`, and `ErrorMessage` notification types are supported.
21651
+ *
21652
+ * - In compose mode, while the style of each notification type varies on other Outlook clients, notifications in Outlook on Android and on iOS
21653
+ * all use the same style. The notification message is always prefixed with an informational icon.
21634
21654
  *
21635
21655
  * - The `addAsync` method isn't supported on a message that's currently loaded using the `loadItemByIdAsync` method.
21636
21656
  * 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}.
@@ -21648,8 +21668,6 @@ declare namespace Office {
21648
21668
  /**
21649
21669
  * Adds a notification to an item.
21650
21670
  *
21651
- * There are a maximum of 5 notifications per message. Setting more will return a `NumberOfNotificationMessagesExceeded` error.
21652
- *
21653
21671
  * @remarks
21654
21672
  * [Api set: Mailbox 1.3]
21655
21673
  *
@@ -21659,13 +21677,20 @@ declare namespace Office {
21659
21677
  *
21660
21678
  * **Important**:
21661
21679
  *
21680
+ * - In Outlook on the web, on Windows (new and classic), and on Mac, you can set a maximum of five notifications per message.
21681
+ * Setting more returns a `NumberOfNotificationMessagesExceeded` error. In Outlook on Android and on iOS, you can only set one notification per message.
21682
+ * Setting an additional notification replaces the previous one.
21683
+ *
21662
21684
  * - Only one notification of type {@link https://learn.microsoft.com/javascript/api/outlook/office.mailboxenums.itemnotificationmessagetype#fields | InsightMessage}
21663
21685
  * is allowed per add-in. Attempting to add more will throw an error.
21664
21686
  *
21665
21687
  * - In modern Outlook on the web and {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows},
21666
21688
  * you can add an `InsightMessage` notification only in Compose mode.
21667
21689
  *
21668
- * - Only the `InformationalMessage` type is supported in Outlook on Android and on iOS.
21690
+ * - In Outlook on Android and on iOS, only the `ProgressIndicator`, `InformationalMessage`, and `ErrorMessage` notification types are supported.
21691
+ *
21692
+ * - In compose mode, while the style of each notification type varies on other Outlook clients, notifications in Outlook on Android and on iOS
21693
+ * all use the same style. The notification message is always prefixed with an informational icon.
21669
21694
  *
21670
21695
  * - The `addAsync` method isn't supported on a message that's currently loaded using the `loadItemByIdAsync` method.
21671
21696
  * 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}.
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@types/office-js-preview",
3
- "version": "1.0.580",
3
+ "version": "1.0.581",
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": "b544b621420d74839b7f9239bc4c72dfbd4b77d83bed4b7dfc25fd3c2c532bff",
49
+ "typesPublisherContentHash": "8d7daadd2fa671c5c307604df6832d22c441817c290570338e4564253191c58d",
50
50
  "typeScriptVersion": "5.1",
51
51
  "nonNpm": true
52
52
  }