@types/office-js 1.0.487 → 1.0.489

office-js/README.md

@@ -8,7 +8,7 @@ This package contains type definitions for office-js (https://github.com/OfficeD
 Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-js.
 
 ### Additional Details
- * Last updated: Tue, 01 Apr 2025 18:39:20 GMT
+ * Last updated: Mon, 14 Apr 2025 18:02:23 GMT
  * Dependencies: none
 
 # Credits

office-js/index.d.ts

@@ -10368,6 +10368,9 @@ declare namespace Office {
          * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
          *
          * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Organizer
+         *
+         * **Important**: This property isn't supported in Outlook on Android or on iOS. For more information on supported APIs in Outlook mobile, see
+         * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
          */
         notificationMessages: NotificationMessages;
         /**
@@ -11933,6 +11936,9 @@ declare namespace Office {
          * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
          *
          * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee
+         *
+         * **Important**: This property isn't supported in Outlook on Android or on iOS. For more information on supported APIs in Outlook mobile, see
+         * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
          */
         notificationMessages: NotificationMessages;
         /**
@@ -12757,6 +12763,21 @@ declare namespace Office {
     interface AttachmentDetailsCompose {
         /**
          * Gets a value that indicates the attachment's type.
+         *
+         * @remarks
+         *
+         * **Important**:
+         *
+         * - In Outlook on the web and new Outlook on Windows, a message or appointment that's locally saved then attached using
+         * drag-and-drop or the **Attach Item** option is of type `Office.MailboxEnums.AttachmentType.File`. The file name extension is
+         * returned in the `name` property. However, a message or appointment that's attached using the **Forward as Attachment** option
+         * is of type `Office.MailboxEnums.AttachmentType.Item`. In this case, an extension isn't returned in the `name` property.
+         *
+         * - In classic Outlook on Windows, a message or appointment that's attached using drag-and-drop, **Attach File**, or 
+         * **Forward as Attachment** is of type `Office.MailboxEnums.AttachmentType.Item`. A file name extension isn't returned in the `name` property.
+         *
+         * - In Outlook on Mac, a message or appointment that's attached using drag-and-drop, **Attach Item**, or **Forward as Attachment** is of type
+         * `Office.MailboxEnums.AttachmentType.File`. The file name extension is returned in the `name` property.
          */
         attachmentType: MailboxEnums.AttachmentType | string;
         /**
@@ -12770,8 +12791,23 @@ declare namespace Office {
         /**
          * Gets the name of the attachment.
          *
-         * **Important**: For message or appointment items that were attached by drag-and-drop or "Attach Item",
-         * `name` includes a file extension in Outlook on Mac, but excludes the extension on the web or on Windows.
+         * @remarks
+         *
+         * **Important**:
+         *
+         * - An attachment of type `Office.MailboxEnums.AttachmentType.Item` doesn't return a file name extension in the `name` property.
+         *
+         * - In Outlook on the web and new Outlook on Windows, a message or appointment that's locally saved then attached using
+         * drag-and-drop or the **Attach Item** option is of type `Office.MailboxEnums.AttachmentType.File`. The file name extension is
+         * returned in the `name` property. However, a message or appointment that's attached using the **Forward as Attachment** option
+         * is of type `Office.MailboxEnums.AttachmentType.Item`. In this case, an extension isn't returned in the `name` property.
+         *
+         * - In classic Outlook on Windows, a message or appointment that's attached using drag-and-drop, **Attach Item**, or 
+         * **Forward as Attachment** is of type `Office.MailboxEnums.AttachmentType.Item`. A file name extension isn't returned in the `name` property.
+         * A calendar item that's attached 
+         *
+         * - In Outlook on Mac, a message or appointment that's attached using drag-and-drop, **Attach Item**, or **Forward as Attachment** is of type
+         * `Office.MailboxEnums.AttachmentType.File`. The file name extension is returned in the `name` property.
          */
         name: string;
         /**
@@ -12822,8 +12858,9 @@ declare namespace Office {
         /**
          * Gets the name of the attachment.
          *
-         * **Important**: For message or appointment items that were attached by drag-and-drop or "Attach Item",
-         * `name` includes a file extension in Outlook on Mac, but excludes the extension on the web or on Windows.
+         * @remarks
+         *
+         * **Important**: An attachment of type `Office.MailboxEnums.AttachmentType.Item` doesn't return a file name extension in the `name` property.
          */
         name: string;
         /**
@@ -21033,6 +21070,10 @@ declare namespace Office {
          *
          * - To retrieve the JSON data, call `Office.context.mailboxitem.getInitializationContextAsync`. If you create a JSON string using
          * `JSON.stringify()` and assign it to the `contextData` property, you must parse the string using `JSON.parse()` once you retrieve it.
+         *
+         * - To prevent the task pane of a notification message from relaunching if it's already open, implement a handler for the `Office.EventType.InitializationContextChanged` event.
+         * You can then pass the {@link https://learn.microsoft.com/javascript/api/outlook/office.initializationcontextchangedeventargs?view=outlook-js-1.15&preserve-view=true | event arguments}
+         * to the `contextData` property.
          */
         contextData: any;
     }
@@ -21054,21 +21095,30 @@ declare namespace Office {
         /**
          * Specifies the `ItemNotificationMessageType` of message.
          *
-         * If type is `ProgressIndicator` or `ErrorMessage`, an icon is automatically supplied
-         * and the message is not persistent. Therefore the icon and persistent properties are not valid for these types of messages.
+         * @remarks
+         *
+         * **Important**:
+         *
+         * - For the `ProgressIndicator` or `ErrorMessage` types, an icon is automatically supplied
+         * and the message isn't persistent. Therefore, the icon and persistent properties aren't valid for these types of messages.
          * Including them will result in an `ArgumentException`.
          *
-         * If type is `ProgressIndicator`, the developer should remove or replace the progress indicator when the action is complete.
-         * 
-         * **Important**: Only the `InformationalMessage` type is supported in Outlook on Android and on iOS.
+         * - For the `ProgressIndicator` type, you should remove or replace the progress indicator when the action is complete.
+         *
+         * - In Outlook on Android and on iOS, only the `ProgressIndicator`, `InformationalMessage`, and `ErrorMessage` notification types are supported.
+         *
+         * - In compose mode, while the style of each notification type varies on other Outlook clients, notifications in Outlook on Android and on iOS
+         * all use the same style. The notification message is always prefixed with an informational icon.
          */
         type: MailboxEnums.ItemNotificationMessageType | string;
         /**
-         * A reference to an icon that is defined in the manifest. It appears in the infobar area.
-         * It is applicable if the type is `InformationalMessage`, and is required if the type is `InsightMessage`.
+         * A reference to an icon that's defined in the manifest. It appears in the infobar area.
+         * It's applicable if the type is `InformationalMessage`, and is required if the type is `InsightMessage`.
          * Specifying this parameter for an unsupported type results in an exception.
          *
-         * **Note**: At present, the custom icon is displayed in Outlook on Windows only and not on other clients (e.g., Mac, web browser).
+         * @remarks
+         *
+         * **Important**: Currently, the custom icon is only displayed in classic Outlook on Windows.
          */
         icon?: string;
         /**
@@ -21113,8 +21163,6 @@ declare namespace Office {
         /**
          * Adds a notification to an item.
          *
-         * There are a maximum of 5 notifications per message. Setting more will return a `NumberOfNotificationMessagesExceeded` error.
-         *
          * @remarks
          * [Api set: Mailbox 1.3]
          *
@@ -21124,13 +21172,20 @@ declare namespace Office {
          *
          * **Important**:
          *
+         * - In Outlook on the web, on Windows (new and classic), and on Mac, you can set a maximum of five notifications per message.
+         * Setting more returns a `NumberOfNotificationMessagesExceeded` error. In Outlook on Android and on iOS, you can only set one notification per message.
+         * Setting an additional notification replaces the previous one.
+         *
          * - Only one notification of type {@link https://learn.microsoft.com/javascript/api/outlook/office.mailboxenums.itemnotificationmessagetype#fields | InsightMessage}
          * is allowed per add-in. Attempting to add more will throw an error.
          *
          * - In modern Outlook on the web and {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows},
          * you can add an `InsightMessage` notification only in Compose mode.
          *
-         * - Only the `InformationalMessage` type is supported in Outlook on Android and on iOS.
+         * - In Outlook on Android and on iOS, only the `ProgressIndicator`, `InformationalMessage`, and `ErrorMessage` notification types are supported.
+         *
+         * - In compose mode, while the style of each notification type varies on other Outlook clients, notifications in Outlook on Android and on iOS
+         * all use the same style. The notification message is always prefixed with an informational icon.
          *
          * @param key - A developer-specified key used to reference this notification message.
          *             Developers can use it to modify this message later. It can't be longer than 32 characters.
@@ -21145,8 +21200,6 @@ declare namespace Office {
         /**
          * Adds a notification to an item.
          *
-         * There are a maximum of 5 notifications per message. Setting more will return a `NumberOfNotificationMessagesExceeded` error.
-         *
          * @remarks
          * [Api set: Mailbox 1.3]
          *
@@ -21156,13 +21209,20 @@ declare namespace Office {
          *
          * **Important**:
          *
+         * - In Outlook on the web, on Windows (new and classic), and on Mac, you can set a maximum of five notifications per message.
+         * Setting more returns a `NumberOfNotificationMessagesExceeded` error. In Outlook on Android and on iOS, you can only set one notification per message.
+         * Setting an additional notification replaces the previous one.
+         *
          * - Only one notification of type {@link https://learn.microsoft.com/javascript/api/outlook/office.mailboxenums.itemnotificationmessagetype#fields | InsightMessage}
          * is allowed per add-in. Attempting to add more will throw an error.
          *
          * - In modern Outlook on the web and {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows},
          * you can add an `InsightMessage` notification only in Compose mode.
          *
-         * - Only the `InformationalMessage` type is supported in Outlook on Android and on iOS.
+         * - In Outlook on Android and on iOS, only the `ProgressIndicator`, `InformationalMessage`, and `ErrorMessage` notification types are supported.
+         *
+         * - In compose mode, while the style of each notification type varies on other Outlook clients, notifications in Outlook on Android and on iOS
+         * all use the same style. The notification message is always prefixed with an informational icon.
          *
          * @param key - A developer-specified key used to reference this notification message.
          *             Developers can use it to modify this message later. It can't be longer than 32 characters.
@@ -23119,6 +23179,10 @@ declare namespace Office {
          *
          * - When you configure a button in the Smart Alerts dialog to run a function, a button for the function is also added to the ribbon or action bar of the Outlook client.
          * Use the `contextData` option to distinguish when a user runs the function from the Smart Alerts dialog.
+         *
+         * - To prevent the task pane of a Smart Alerts add-in from relaunching if it's already open, implement a handler for the `Office.EventType.InitializationContextChanged` event.
+         * You can then pass the {@link https://learn.microsoft.com/javascript/api/outlook/office.initializationcontextchangedeventargs?view=outlook-js-1.15&preserve-view=true | event arguments}
+         * to the `contextData` property.
          */
         contextData?: any;
         /**
@@ -23298,6 +23362,10 @@ declare namespace Office {
          *
          * - If you implement a task pane to open after a reported message is processed, when the `event.completed` call occurs, any task pane that's open or pinned is closed.
          *
+         * - To prevent the task pane of a spam-reporting add-in from relaunching if it's already open, implement a handler for the `Office.EventType.InitializationContextChanged` event.
+         * You can then pass the {@link https://learn.microsoft.com/javascript/api/outlook/office.initializationcontextchangedeventargs?view=outlook-js-1.15&preserve-view=true | event arguments}
+         * to the `contextData` property.
+         *
          * - To retrieve the value of the `contextData` property, you must call `Office.context.mailbox.item.getInitializationContextAsync` in the JavaScript implementation
          * of your task pane. If you create a JSON string using `JSON.stringify()` and assign it to the `contextData` property, you must parse the string using
          * `JSON.parse()` once you retrieve it.

office-js/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@types/office-js",
-    "version": "1.0.487",
+    "version": "1.0.489",
     "description": "TypeScript definitions for office-js",
     "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-js",
     "license": "MIT",
@@ -46,6 +46,6 @@
     "scripts": {},
     "dependencies": {},
     "peerDependencies": {},
-    "typesPublisherContentHash": "24f3ecc1bfac4591486e788bb5c5f4ed9a9344d0013e671c9c24eb84385cf12c",
+    "typesPublisherContentHash": "baef25f87a885143e94e10938b818e7528f5520c6e1aff719d3b78361dd91333",
     "typeScriptVersion": "5.1"
 }