@types/office-js 1.0.334 → 1.0.336

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: Wed, 05 Jul 2023 22:32:45 GMT
+ * Last updated: Wed, 12 Jul 2023 17:32:58 GMT
  * Dependencies: none
  * Global values: `Excel`, `Office`, `OfficeCore`, `OfficeExtension`, `OneNote`, `PowerPoint`, `Visio`, `Word`
 

office-js/index.d.ts

@@ -8781,6 +8781,8 @@ declare namespace Office {
             InformationalMessage = "informationalMessage",
             /**
              * The notification message is an error message.
+             * 
+             * **Important**: Only the `InformationalMessage` type is supported in Outlook on Android and on iOS.
              */
             ErrorMessage = "errorMessage",
             /**
@@ -12514,15 +12516,6 @@ declare namespace Office {
         /**
          * Adds or replaces the signature of the item body.
          *
-         * **Important**: In Outlook on the web, `setSignatureAsync` only works on messages.
-         *
-         * **Important**: If your add-in implements the 
-         * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/autolaunch | event-based activation feature using `LaunchEvent` in the manifest},
-         * and calls `setSignatureAsync` in the event handler, the following behavior applies.
-         *
-         * - When the user composes a new item (including reply or forward), the signature is set but doesn't modify the form. This means
-         * if the user closes the form without making other edits, they won't be prompted to save changes.
-         *
          * @remarks
          * [Api set: Mailbox 1.10]
          *
@@ -12530,6 +12523,18 @@ declare namespace Office {
          *
          * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
          *
+         * **Important**:
+         *
+         * - In Outlook on the web, `setSignatureAsync` only works on messages.
+         * 
+         * - This method is supported in Message Compose on Outlook on Android and on iOS. For a sample scenario, see
+         * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/mobile-event-based | Implement event-based activation in Outlook mobile add-ins}.
+         * 
+         * - The behavior of `setSignatureAsync` differs if you call it in the event handler of an add-in that implements the
+         * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/autolaunch | event-based activation feature using `LaunchEvent` in the manifest}.
+         * When the user composes a new item (including reply or forward), the signature is set but doesn't modify the form. This means
+         * if the user closes the form without making other edits, they won't be prompted to save changes.
+         *
          * **Errors**:
          *
          * - `DataExceedsMaximumSize`: The `data` parameter is longer than 30,000 characters.
@@ -12548,15 +12553,6 @@ declare namespace Office {
         /**
          * Adds or replaces the signature of the item body.
          *
-         * **Important**: In Outlook on the web, `setSignatureAsync` only works on messages.
-         *
-         * **Important**: If your add-in implements the 
-         * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/autolaunch | event-based activation feature using `LaunchEvent` in the manifest},
-         * and calls `setSignatureAsync` in the event handler, the following behavior applies.
-         *
-         * - When the user composes a new item (including reply or forward), the signature is set but doesn't modify the form. This means
-         * if the user closes the form without making other edits, they won't be prompted to save changes.
-         *
          * @remarks
          * [Api set: Mailbox 1.10]
          *
@@ -12564,6 +12560,18 @@ declare namespace Office {
          *
          * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
          *
+         * **Important**:
+         *
+         * - In Outlook on the web, `setSignatureAsync` only works on messages.
+         * 
+         * - This method is supported in Message Compose on Outlook on Android and on iOS. For a sample scenario, see
+         * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/mobile-event-based | Implement event-based activation in Outlook mobile add-ins}.
+         * 
+         * - The behavior of `setSignatureAsync` differs if you call it in the event handler of an add-in that implements the
+         * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/autolaunch | event-based activation feature using `LaunchEvent` in the manifest}.
+         * When the user composes a new item (including reply or forward), the signature is set but doesn't modify the form. This means
+         * if the user closes the form without making other edits, they won't be prompted to save changes.
+         *
          * **Errors**:
          *
          * - `DataExceedsMaximumSize`: The `data` parameter is longer than 30,000 characters.
@@ -13347,6 +13355,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}**: Compose
+     *
+     * **Important**: This interface is supported in Outlook on Android and on iOS. For a sample scenario, see
+     * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/mobile-event-based | Implement event-based activation in Outlook mobile add-ins}.
      */
     interface From {
         /**
@@ -13363,7 +13374,12 @@ declare namespace Office {
          *
          * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
          *
-         * **Important**: A `recipientType` property value isn't returned by the getAsync method.
+         * **Important**:
+         *
+         * - This method is supported in Outlook on Android and on iOS. For a sample scenario, see
+         * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/mobile-event-based | Implement event-based activation in Outlook mobile add-ins}.
+         * 
+         * - A `recipientType` property value isn't returned by the `getAsync` method.
          * The email sender is always a user whose email address is on the Exchange server.
          *
          * @param options - An object literal that contains one or more of the following properties:-
@@ -13387,7 +13403,12 @@ declare namespace Office {
          *
          * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
          * 
-         * **Important**: A `recipientType` property value isn't returned by the getAsync method.
+         * **Important**:
+         *
+         * - This method is supported in Outlook on Android and on iOS. For a sample scenario, see
+         * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/mobile-event-based | Implement event-based activation in Outlook mobile add-ins}.
+         * 
+         * - A `recipientType` property value isn't returned by the `getAsync` method.
          * The email sender is always a user whose email address is on the Exchange server.
          *
          * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter,
@@ -13442,7 +13463,7 @@ declare namespace Office {
     }
     /**
      * The `InternetHeaders` object represents custom internet headers that are preserved after the message item leaves Exchange
-     * and is converted to a MIME message. These headers are stored as x-headers in the MIME message.
+     * and is converted to a MIME message.
      *
      * Internet headers are stored as string key-value pairs on a per-item basis.
      *
@@ -13475,7 +13496,7 @@ declare namespace Office {
     interface InternetHeaders {
         /**
          * Given an array of internet header names, this method returns a record containing those internet headers and their values.
-         * If the add-in requests an x-header that isn't available, that x-header will not be returned in the results.
+         * If the add-in requests a header that isn't available, that header won't be returned in the results.
          *
          * **Note**: This method is intended to return the values of the custom headers you set using the `setAsync` method.
          *
@@ -13496,7 +13517,7 @@ declare namespace Office {
         getAsync(names: string[], options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<Record<string, string>>) => void): void;
         /**
          * Given an array of internet header names, this method returns a record containing those internet headers and their values.
-         * If the add-in requests an x-header that isn't available, that x-header will not be returned in the results.
+         * If the add-in requests a header that isn't available, that header won't be returned in the results.
          *
          * **Note**: This method is intended to return the values of the custom headers you set using the `setAsync` method.
          *
@@ -15074,6 +15095,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}**: Message Compose
+         *
+         * **Important**: This property is supported in Outlook on Android and on iOS. For a sample scenario, see
+         * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/mobile-event-based | Implement event-based activation in Outlook mobile add-ins}.
          */
         from: From;
         /**
@@ -15277,9 +15301,6 @@ declare namespace Office {
          *
          * You can subsequently use the identifier with the `removeAttachmentAsync` method to remove the attachment in the same session.
          *
-         * **Note**: If you're using a data URL API (e.g., `readAsDataURL`), you need to strip out the data URL prefix then send the rest of the string to this API.
-         * For example, if the full string is represented by `data:image/svg+xml;base64,<rest of Base64 string>`, remove `data:image/svg+xml;base64,`.
-         *
          * @remarks
          * [Api set: Mailbox 1.8]
          *
@@ -15287,6 +15308,18 @@ declare namespace Office {
          *
          * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose
          *
+         * **Important**:
+         *
+         * - Adding an inline Base64 file to a messsage in compose mode is supported in Outlook on Android and on iOS.
+         *
+         * - If you're using a data URL API (for example, `readAsDataURL`), you need to strip out the data URL prefix, then send the rest of the string to this API.
+         * For example, if the full string is represented by `data:image/svg+xml;base64,<rest of Base64 string>`, remove `data:image/svg+xml;base64,`.
+         *
+         * - If you're adding an inline Base64 image to the body of a message or appointment being composed, you must first get the current item body using the
+         * {@link https://learn.microsoft.com/javascript/api/outlook/office.body#outlook-office-body-getasync-member(1) | Office.context.mailbox.item.body.getAsync} 
+         * method before inserting the image using `addFileAttachmentFromBase64Async`. Otherwise, the image won't render in the body once it's inserted.
+         * For further guidance, see {@link https://learn.microsoft.com/office/dev/add-ins/outlook/add-and-remove-attachments-to-an-item-in-a-compose-form#attach-a-file | Attach a file}.
+         *
          * **Errors**:
          *
          * - `AttachmentSizeExceeded`: The attachment is larger than allowed.
@@ -15295,11 +15328,6 @@ declare namespace Office {
          *
          * - `NumberOfAttachmentsExceeded`: The message or appointment has too many attachments.
          *
-         * **Note**: If you're adding an inline Base64 image to the body of a message or appointment being composed, you must first get the current item body using the
-         * {@link https://learn.microsoft.com/javascript/api/outlook/office.body#outlook-office-body-getasync-member(1) | Office.context.mailbox.item.body.getAsync} 
-         * method before inserting the image using `addFileAttachmentFromBase64Async`. Otherwise, the image won't render in the body once it's inserted.
-         * For further guidance, see {@link https://learn.microsoft.com/office/dev/add-ins/outlook/add-and-remove-attachments-to-an-item-in-a-compose-form#attach-a-file | Attach a file}.
-         *
          * @param base64File - The Base64-encoded content of an image or file to be added to an email or event. The maximum length of the encoded string is 27,892,122 characters (about 25 MB).
          * @param attachmentName - The name of the attachment that is shown while the attachment is uploading. The maximum length is 255 characters.
          * @param options - An object literal that contains one or more of the following properties:-
@@ -15318,9 +15346,6 @@ declare namespace Office {
          *
          * You can subsequently use the identifier with the `removeAttachmentAsync` method to remove the attachment in the same session.
          *
-         * **Note**: If you're using a data URL API (e.g., `readAsDataURL`), you need to strip out the data URL prefix then send the rest of the string to this API.
-         * For example, if the full string is represented by `data:image/svg+xml;base64,<rest of Base64 string>`, remove `data:image/svg+xml;base64,`.
-         *
          * @remarks
          * [Api set: Mailbox 1.8]
          *
@@ -15328,6 +15353,18 @@ declare namespace Office {
          *
          * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose
          *
+         * **Important**:
+         *
+         * - Adding an inline Base64 file to a messsage in compose mode is supported in Outlook on Android and on iOS.
+         *
+         * - If you're using a data URL API (for example, `readAsDataURL`), you need to strip out the data URL prefix, then send the rest of the string to this API.
+         * For example, if the full string is represented by `data:image/svg+xml;base64,<rest of Base64 string>`, remove `data:image/svg+xml;base64,`.
+         *
+         * - If you're adding an inline Base64 image to the body of a message or appointment being composed, you must first get the current item body using the
+         * {@link https://learn.microsoft.com/javascript/api/outlook/office.body#outlook-office-body-getasync-member(1) | Office.context.mailbox.item.body.getAsync} 
+         * method before inserting the image using `addFileAttachmentFromBase64Async`. Otherwise, the image won't render in the body once it's inserted.
+         * For further guidance, see {@link https://learn.microsoft.com/office/dev/add-ins/outlook/add-and-remove-attachments-to-an-item-in-a-compose-form#attach-a-file | Attach a file}.
+         *
          * **Errors**:
          *
          * - `AttachmentSizeExceeded`: The attachment is larger than allowed.
@@ -15336,11 +15373,6 @@ declare namespace Office {
          *
          * - `NumberOfAttachmentsExceeded`: The message or appointment has too many attachments.
          *
-         * **Note**: If you're adding an inline Base64 image to the body of a message or appointment being composed, you must first get the current item body using the
-         * {@link https://learn.microsoft.com/javascript/api/outlook/office.body#outlook-office-body-getasync-member(1) | Office.context.mailbox.item.body.getAsync} 
-         * method before inserting the image using `addFileAttachmentFromBase64Async`. Otherwise, the image won't render in the body once it's inserted.
-         * For further guidance, see {@link https://learn.microsoft.com/office/dev/add-ins/outlook/add-and-remove-attachments-to-an-item-in-a-compose-form#attach-a-file | Attach a file}.
-         *
          * @param base64File - The Base64-encoded content of an image or file to be added to an email or event. The maximum length of the encoded string is 27,892,122 characters (about 25 MB).
          * @param attachmentName - The name of the attachment that is shown while the attachment is uploading. The maximum length is 255 characters.
          * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter of
@@ -15478,10 +15510,15 @@ declare namespace Office {
         /**
          * Disables the Outlook client signature.
          *
-         * For Windows and Mac rich clients, this API sets the signature under the "New Message" and "Replies/Forwards" sections
-         * for the sending account to "(none)", effectively disabling the signature.
-         * For Outlook on the web, the API should disable the signature option for new mails, replies, and forwards.
-         * If the signature is selected, this API call should disable it.
+         * The behavior of this method depends on which client the add-in is running.
+         *
+         * - In Outlook on Windows and on Mac, the signature under the **New messages** and **Replies/forwards** sections
+         * of the sending account is set to **(none)**.
+         *
+         * - In Outlook on the web, the signature option for new mails, replies, and forwards is disabled.
+         * A signature that's selected is also disabled by the method.
+         * 
+         * - In Outlook on Android and on iOS, the signature saved on the mobile device is cleared.
          *
          * @remarks
          * [Api set: Mailbox 1.10]
@@ -15490,6 +15527,8 @@ declare namespace Office {
          *
          * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose
          *
+         * **Important**: This method is supported in Message Compose in Outlook on Android and on iOS.
+         *
          * @param options - An object literal that contains one or more of the following properties:-
          *        `asyncContext`: Developers can provide any object they wish to access in the callback function.
          * @param callback - Optional. When the method completes, the function passed in the callback parameter is called with a single parameter,
@@ -15499,10 +15538,15 @@ declare namespace Office {
         /**
          * Disables the Outlook client signature.
          *
-         * For Windows and Mac rich clients, this API sets the signature under the "New Message" and "Replies/Forwards" sections
-         * for the sending account to "(none)", effectively disabling the signature.
-         * For Outlook on the web, the API should disable the signature option for new mails, replies, and forwards.
-         * If the signature is selected, this API call should disable it.
+         * The behavior of this method depends on which client the add-in is running.
+         *
+         * - In Outlook on Windows and on Mac, the signature under the **New messages** and **Replies/forwards** sections
+         * of the sending account is set to **(none)**.
+         *
+         * - In Outlook on the web, the signature option for new mails, replies, and forwards is disabled.
+         * A signature that's selected is also disabled by the method.
+         * 
+         * - In Outlook on Android and on iOS, the signature saved on the mobile device is cleared.
          *
          * @remarks
          * [Api set: Mailbox 1.10]
@@ -15511,6 +15555,8 @@ declare namespace Office {
          *
          * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose
          *
+         * **Important**: This method is supported in Message Compose on Outlook on Android and on iOS.
+         *
          * @param callback - Optional. When the method completes, the function passed in the callback parameter is called with a single parameter,
          *                `asyncResult`, which is an `Office.AsyncResult` object.
          */
@@ -15618,6 +15664,8 @@ declare namespace Office {
          *
          * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose
          *
+         * **Important**: This method is supported in Outlook on Android and on iOS.
+         *
          * @param options - An object literal that contains one or more of the following properties:-
          *        `asyncContext`: Developers can provide any object they wish to access in the callback function.
          * @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter of
@@ -15639,6 +15687,8 @@ declare namespace Office {
          *
          * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose
          *
+         * **Important**: This method is supported in Outlook on Android and on iOS.
+         *
          * @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter of
          *                 type `Office.AsyncResult`. On success, the `asyncResult.value` property contains an object with the item's compose type
          *                 and coercion type.
@@ -17215,6 +17265,8 @@ declare namespace Office {
          * 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.
          */
         type: MailboxEnums.ItemNotificationMessageType | string;
         /**
@@ -17268,6 +17320,13 @@ declare namespace Office {
          *
          * There are a maximum of 5 notifications per message. Setting more will return a `NumberOfNotificationMessagesExceeded` error.
          *
+         * @remarks
+         * [Api set: Mailbox 1.3]
+         *
+         * **{@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}**: Compose or Read
+         *
          * **Important**:
          *
          * - Only one notification of type {@link https://learn.microsoft.com/javascript/api/outlook/office.mailboxenums.itemnotificationmessagetype#fields | InsightMessage}
@@ -17275,12 +17334,7 @@ declare namespace Office {
          *
          * - In modern Outlook on the web, you can add an `InsightMessage` notification only in Compose mode.
          *
-         * @remarks
-         * [Api set: Mailbox 1.3]
-         *
-         * **{@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}**: Compose or Read
+         * - Only the `InformationalMessage` type is supported in Outlook on Android and on iOS.
          *
          * @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.
@@ -17297,6 +17351,13 @@ declare namespace Office {
          *
          * There are a maximum of 5 notifications per message. Setting more will return a `NumberOfNotificationMessagesExceeded` error.
          *
+         * @remarks
+         * [Api set: Mailbox 1.3]
+         *
+         * **{@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}**: Compose or Read
+         *
          * **Important**:
          *
          * - Only one notification of type {@link https://learn.microsoft.com/javascript/api/outlook/office.mailboxenums.itemnotificationmessagetype#fields | InsightMessage}
@@ -17304,12 +17365,7 @@ declare namespace Office {
          *
          * - In modern Outlook on the web, you can add an `InsightMessage` notification only in Compose mode.
          *
-         * @remarks
-         * [Api set: Mailbox 1.3]
-         *
-         * **{@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}**: Compose or Read
+         * - Only the `InformationalMessage` type is supported in Outlook on Android and on iOS.
          *
          * @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.

office-js/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@types/office-js",
-    "version": "1.0.334",
+    "version": "1.0.336",
     "description": "TypeScript definitions for Office.js",
     "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-js",
     "license": "MIT",
@@ -45,6 +45,6 @@
     },
     "scripts": {},
     "dependencies": {},
-    "typesPublisherContentHash": "2428e1df634be62898a3b56a33fbb8a4f129d6bfdaa95ab4fb9131c5a7f4409a",
+    "typesPublisherContentHash": "1e85acad9690151d9aeca195ff57c60a76e842f71ef2ce5b520bc46bab04fd6a",
     "typeScriptVersion": "4.3"
 }