@types/office-js 1.0.330 → 1.0.332

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, 13 Jun 2023 23:02:49 GMT
+ * Last updated: Tue, 20 Jun 2023 17:32:40 GMT
  * Dependencies: none
  * Global values: `Excel`, `Office`, `OfficeCore`, `OfficeExtension`, `OneNote`, `PowerPoint`, `Visio`, `Word`
 

office-js/index.d.ts

@@ -1546,11 +1546,9 @@ declare namespace Office {
          *
          * **Important**:
          *
-         * - In Outlook, this API isn't supported in the following scenarios.
+         * - In Outlook, this API isn't supported if you load an add-in in an Outlook.com or Gmail mailbox.
          *
-         *   - If the add-in is loaded in an Outlook.com or Gmail mailbox.
-         *
-         *   - If the add-in is loaded in Outlook on the web in the Safari browser. This results in error 13001 ("The user is not signed into Office").
+         * - In Outlook on the web, this API isn't supported if you use the Safari browser. This results in error 13001 ("The user is not signed into Office").
          *
          * - In Outlook on the web, if you use the
          * {@link https://learn.microsoft.com/javascript/api/office/office.ui#office-office-ui-displaydialogasync-member(1) | displayDialogAsync}
@@ -12229,13 +12227,10 @@ declare namespace Office {
          *
          * **Important**:
          *
-         * - After the content is prepended, the position of the cursor depends on which client the add-in is running.
-         * 
-         *   - **Windows, Web**: The cursor position remains the same in the pre-existing content of the body. For example, if the cursor was positioned at the beginning
-         * of the body prior to the `prependAsync` call, it will appear between the prepended content and the pre-existing content of the body after the call.
-         *
-         *   - **Mac**: The cursor position isn't preserved. The cursor disappears after the `prependAsync` call and only reappears when the user selects something in the
-         * body of the mail item.
+         * - After the content is prepended, the position of the cursor depends on which client the add-in is running. In Outlook on Windows and on the web, the cursor
+         * position remains the same in the pre-existing content of the body. For example, if the cursor was positioned at the beginning of the body prior to the
+         * `prependAsync` call, it will appear between the prepended content and the pre-existing content of the body after the call. In Outlook on Mac, the cursor
+         * position isn't preserved. The cursor disappears after the `prependAsync` call and only reappears when the user selects something in the body of the mail item.
          *
          * - When working with HTML-formatted bodies, it's important to note that the client may modify the value passed to `prependAsync` to
          * make it render efficiently with its rendering engine. This means that the value returned from a subsequent call to the `Body.getAsync` method
@@ -12270,13 +12265,10 @@ declare namespace Office {
          *
          * **Important**:
          *
-         * - After the content is prepended, the position of the cursor depends on which client the add-in is running.
-         * 
-         *   - **Windows, Web**: The cursor position remains the same in the pre-existing content of the body. For example, if the cursor was positioned at the beginning
-         * of the body prior to the `prependAsync` call, it will appear between the prepended content and the pre-existing content of the body after the call.
-         *
-         *   - **Mac**: The cursor position isn't preserved. The cursor disappears after the `prependAsync` call and only reappears when the user selects something in the
-         * body of the mail item.
+         * - After the content is prepended, the position of the cursor depends on which client the add-in is running. In Outlook on Windows and on the web, the cursor
+         * position remains the same in the pre-existing content of the body. For example, if the cursor was positioned at the beginning of the body prior to the
+         * `prependAsync` call, it will appear between the prepended content and the pre-existing content of the body after the call. In Outlook on Mac, the cursor
+         * position isn't preserved. The cursor disappears after the `prependAsync` call and only reappears when the user selects something in the body of the mail item.
          *
          * - When working with HTML-formatted bodies, it's important to note that the client may modify the value passed to `prependAsync` to
          * make it render efficiently with its rendering engine. This means that the value returned from a subsequent call to the `Body.getAsync` method
@@ -12387,14 +12379,10 @@ declare namespace Office {
          *
          * **Important**:
          *
-         * - After the body is replaced with the specified content, the position of the cursor depends on which client the add-in is running.
-         * 
-         *   - **Windows**: The cursor appears at the beginning of the body of the mail item.
-         *
-         *   - **Mac**: The cursor position isn't preserved. The cursor disappears after the `prependAsync` call and only reappears when the user selects something in the
-         * body of the mail item.
-         *
-         *   - **Web**: The cursor appears at the end of the body of the mail item.
+         * - After the body is replaced with the specified content, the position of the cursor depends on which client the add-in is running. In Outlook on Windows,
+         * the cursor appears at the beginning of the body of the mail item, while in Outlook on the web, the cursor appears at the end of the body of the mail item.
+         * In Outlook on Mac, the cursor position isn't preserved. The cursor disappears after the `prependAsync` call and only reappears when the user selects
+         * something in the body of the mail item.
          *
          * - When working with HTML-formatted bodies, it's important to note that the value returned by the `Body.getAsync` method won't necessarily
          * be the exact same value that was previously passed in the `Body.setAsync` method. The client may modify the value passed to `setAsync` to make it
@@ -12433,14 +12421,10 @@ declare namespace Office {
          *
          * **Important**:
          *
-         * - After the body is replaced with the specified content, the position of the cursor depends on which client the add-in is running.
-         * 
-         *   - **Windows**: The cursor appears at the beginning of the body of the mail item.
-         *
-         *   - **Mac**: The cursor position isn't preserved. The cursor disappears after the `prependAsync` call and only reappears when the user selects something in the
-         * body of the mail item.
-         *
-         *   - **Web**: The cursor appears at the end of the body of the mail item.
+         * - After the body is replaced with the specified content, the position of the cursor depends on which client the add-in is running. In Outlook on Windows,
+         * the cursor appears at the beginning of the body of the mail item, while in Outlook on the web, the cursor appears at the end of the body of the mail item.
+         * In Outlook on Mac, the cursor position isn't preserved. The cursor disappears after the `prependAsync` call and only reappears when the user selects
+         * something in the body of the mail item.
          *
          * - When working with HTML-formatted bodies, it's important to note that the value returned by the `Body.getAsync` method won't necessarily
          * be the exact same value that was previously passed in the `Body.setAsync` method. The client may modify the value passed to `setAsync` to make it
@@ -14649,11 +14633,11 @@ declare namespace Office {
          * @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,
-         *        `asyncResult`, which is an `Office.AsyncResult` object. The properties of the selected messages are returned as an array of JSON objects in the
-         *        `asyncResult.value` property. These properties include the item ID, subject, item type (`Message` is the only supported type at this time), and item mode
-         *        (`Read` or `Compose`). The objects in the array follow the order in which messages were selected.
+         *        `asyncResult`, which is an `Office.AsyncResult` object. The properties of the selected messages, such as the item ID and subject, are returned as an array of
+         *        {@link Office.SelectedItemDetails | SelectedItemDetails} objects in the `asyncResult.value` property. The objects in the array follow the order in which
+         *        messages were selected.
          */
-        getSelectedItemsAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<object[]>) => void): void;
+        getSelectedItemsAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<SelectedItemDetails[]>) => void): void;
         /**
          * Gets currently selected messages on which an add-in can activate and perform operations. An add-in can activate on a maximum of 100 messages at a time.
          * To learn more about item multi-select, see
@@ -14671,11 +14655,11 @@ declare namespace Office {
          * @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,
-         *        `asyncResult`, which is an `Office.AsyncResult` object. The properties of the selected messages are returned as an array of JSON objects in the
-         *        `asyncResult.value` property. These properties include the item ID, subject, item type (`Message` is the only supported type at this time), and item mode
-         *        (`Read` or `Compose`). The objects in the array follow the order in which messages were selected.
+         *        `asyncResult`, which is an `Office.AsyncResult` object. The properties of the selected messages, such as the item ID and subject, are returned as an array of
+         *        {@link Office.SelectedItemDetails | SelectedItemDetails} objects in the `asyncResult.value` property. The objects in the array follow the order in which
+         *        messages were selected.
          */
-        getSelectedItemsAsync(callback: (asyncResult: Office.AsyncResult<object[]>) => void): void;
+        getSelectedItemsAsync(callback: (asyncResult: Office.AsyncResult<SelectedItemDetails[]>) => void): void;
         /**
          * Gets a token identifying the user and the Office Add-in.
          *
@@ -18252,6 +18236,34 @@ declare namespace Office {
          */
         set(name: string, value: any): void;
     }
+    /**
+     * Represents the properties of a message that's currently selected in Outlook.
+     *
+     * @remarks
+     * [Api set: Mailbox 1.13]
+     *
+     * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write mailbox**
+     *
+     * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose, Message Read
+     */
+    interface SelectedItemDetails {
+        /**
+         * The Exchange Web Services (EWS) item identifier of the message that's currently selected.
+         */
+        itemId: string;
+        /**
+         * The Outlook mode (`Read` or `Compose`) of the message that's currently selected.
+         */
+        itemMode: string;
+        /**
+         * The type of the item that's currently selected. `Message` is the only supported type at this time.
+         */
+        itemType: MailboxEnums.ItemType | string;
+        /**
+         * The description that appears in the subject field of the message that's currently selected.
+         */
+        subject: string;
+    }
     /**
      * Provides methods to get or set the sensitivity label of a message or appointment. For more information on sensitivity labels, see
      * {@link https://learn.microsoft.com/microsoft-365/compliance/sensitivity-labels | Learn about sensitivity labels}.

office-js/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@types/office-js",
-    "version": "1.0.330",
+    "version": "1.0.332",
     "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": "964ad412f7aa9567890052670913dde4959ac0111bf4bd09072782388c86c511",
+    "typesPublisherContentHash": "61674515026554e09af1050e92f1b97b947a10aa8f521972b005f82f364489cc",
     "typeScriptVersion": "4.3"
 }