@types/office-js 1.0.338 → 1.0.340

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, 18 Jul 2023 19:32:54 GMT
+ * Last updated: Fri, 25 Aug 2023 17:33:47 GMT
  * Dependencies: none
  * Global values: `Excel`, `Office`, `OfficeCore`, `OfficeExtension`, `OneNote`, `PowerPoint`, `Visio`, `Word`
 

office-js/index.d.ts

@@ -10649,76 +10649,77 @@ declare namespace Office {
         /**
          * Asynchronously saves an item.
          *
-         * When invoked, this method saves the current message as a draft and returns the item ID via the callback function.
-         * In Outlook on the web or Outlook in online mode, the item is saved to the server.
-         * In Outlook in cached mode, the item is saved to the local cache.
+         * Since appointments have no draft state, if `saveAsync` is called on an appointment in compose mode, the item is saved as a normal
+         * appointment on the user's calendar. For new appointments that haven't been saved before, no invitation is sent.
+         * For existing appointments, an update is sent to added or removed attendees.
          *
-         * Since appointments have no draft state, if `saveAsync` is called on an appointment in compose mode, the item will be saved as a normal
-         * appointment on the user's calendar. For new appointments that have not been saved before, no invitation will be sent.
-         * Saving an existing appointment will send an update to added or removed attendees.
+         * @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/write item**
+         *
+         * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Organizer
+         *
+         * **Important**:
          *
-         * When working with HTML-formatted content, it's important to note that the Outlook client may modify the content. This means that
+         * - In Outlook on the web or Outlook in online mode, the item is saved to the server. In Outlook in cached mode, the item is saved to the local cache.
+         *
+         * - When working with HTML-formatted content, it's important to note that the Outlook client may modify the content. This means that
          * subsequent calls to methods like `Body.getAsync`, `Body.setAsync`, and even `saveAsync` may not result in the same content.
          *
-         * **Note**: If your add-in calls `saveAsync` on an item in compose mode in order to get an item ID to use with EWS or the REST API, be aware
-         * that when Outlook is in cached mode, it may take some time before the item is actually synced to the server.
+         * - If your add-in calls `saveAsync` on an item in compose mode in order to get an item ID to use with EWS or the REST API, be aware that
+         * when Outlook is in cached mode, it may take some time before the item is actually synced to the server.
          * Until the item is synced, using the item ID will return an error.
          *
-         * **Note**: In Outlook on Mac, only build 16.35.308 or later supports saving a meeting.
+         * - In Outlook on Mac, only Build 16.35.308 or later supports saving a meeting.
          * Otherwise, the `saveAsync` method fails when called from a meeting in compose mode.
          * For a workaround, see {@link https://learn.microsoft.com/outlook/troubleshoot/calendars/cannot-save-meeting-as-draft-in-outlook-for-mac | Cannot save a meeting as a draft in Outlook for Mac by using Office JS API}.
          *
-         * @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/write item**
-         *
-         * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Organizer
-         *
          * **Errors**:
          *
          * - `InvalidAttachmentId`: The attachment identifier does not exist.
          *
          * @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
-         *                   type `Office.AsyncResult`.
+         * @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 appointment ID is returned in the `asyncResult.value` property.
          */
         saveAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<string>) => void): void;
         /**
          * Asynchronously saves an item.
          *
-         * When invoked, this method saves the current message as a draft and returns the item ID via the callback function.
-         * In Outlook on the web or Outlook in online mode, the item is saved to the server. In Outlook in cached mode, the item is saved to the local cache.
+         * Since appointments have no draft state, if `saveAsync` is called on an appointment in compose mode, the item is saved as a normal
+         * appointment on the user's calendar. For new appointments that haven't been saved before, no invitation is sent.
+         * For existing appointments, an update is sent to added or removed attendees.
+         *
+         * @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/write item**
+         *
+         * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Organizer
+         *
+         * **Important**:
          *
-         * Since appointments have no draft state, if `saveAsync` is called on an appointment in compose mode, the item will be saved as a normal
-         * appointment on the user's calendar. For new appointments that have not been saved before, no invitation will be sent.
-         * Saving an existing appointment will send an update to added or removed attendees.
+         * - In Outlook on the web or Outlook in online mode, the item is saved to the server. In Outlook in cached mode, the item is saved to the local cache.
          *
-         * When working with HTML-formatted content, it's important to note that the Outlook client may modify the content. This means that
+         * - When working with HTML-formatted content, it's important to note that the Outlook client may modify the content. This means that
          * subsequent calls to methods like `Body.getAsync`, `Body.setAsync`, and even `saveAsync` may not result in the same content.
          *
-         * **Note**: If your add-in calls `saveAsync` on an item in compose mode in order to get an item ID to use with EWS or the REST API, be aware that
+         * - If your add-in calls `saveAsync` on an item in compose mode in order to get an item ID to use with EWS or the REST API, be aware that
          * when Outlook is in cached mode, it may take some time before the item is actually synced to the server.
          * Until the item is synced, using the item ID will return an error.
          *
-         * **Note**: In Outlook on Mac, only build 16.35.308 or later supports saving a meeting.
+         * - In Outlook on Mac, only Build 16.35.308 or later supports saving a meeting.
          * Otherwise, the `saveAsync` method fails when called from a meeting in compose mode.
          * For a workaround, see {@link https://learn.microsoft.com/outlook/troubleshoot/calendars/cannot-save-meeting-as-draft-in-outlook-for-mac | Cannot save a meeting as a draft in Outlook for Mac by using Office JS API}.
          *
-         * @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/write item**
-         *
-         * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Organizer
-         *
          * **Errors**:
          *
          * - `InvalidAttachmentId`: The attachment identifier does not exist.
          *
-         * @param callback - When the method completes, the function passed in the callback parameter is called with a single parameter of
-         *                   type `Office.AsyncResult`.
+         * @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 appointment ID is returned in the `asyncResult.value` property.
          */
         saveAsync(callback: (asyncResult: Office.AsyncResult<string>) => void): void;
         /**
@@ -16145,22 +16146,7 @@ declare namespace Office {
          */
         removeHandlerAsync(eventType: Office.EventType | string, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
         /**
-         * Asynchronously saves an item.
-         *
-         * When invoked, this method saves the current message as a draft and returns the item ID via the callback function.
-         * In Outlook on the web or Outlook in online mode, the item is saved to the server.
-         * In Outlook in cached mode, the item is saved to the local cache.
-         *
-         * Since appointments have no draft state, if `saveAsync` is called on an appointment in compose mode, the item will be saved as a normal
-         * appointment on the user's calendar. For new appointments that have not been saved before, no invitation will be sent.
-         * Saving an existing appointment will send an update to added or removed attendees.
-         *
-         * When working with HTML-formatted content, it's important to note that the Outlook client may modify the content. This means that
-         * subsequent calls to methods like `Body.getAsync`, `Body.setAsync`, and even `saveAsync` may not result in the same content.
-         *
-         * **Note**: If your add-in calls `saveAsync` on an item in compose mode in order to get an item ID to use with EWS or the REST API, be aware
-         * that when Outlook is in cached mode, it may take some time before the item is actually synced to the server.
-         * Until the item is synced, using the itemId will return an error.
+         * Asynchronously saves the current message as a draft.
          *
          * @remarks
          * [Api set: Mailbox 1.3]
@@ -16169,33 +16155,35 @@ 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**:
+         *
+         * - In Outlook on the web or Outlook in online mode, the item is saved to the server. In Outlook in cached mode, the item is saved to the local cache.
+         *
+         * - When working with HTML-formatted content, it's important to note that the Outlook client may modify the content. This means that
+         * subsequent calls to methods like `Body.getAsync`, `Body.setAsync`, and even `saveAsync` may not result in the same content.
+         *
+         * - If your add-in calls `saveAsync` on an item in compose mode in order to get an item ID to use with EWS or the REST API, be aware that
+         * when Outlook is in cached mode, it may take some time before the item is actually synced to the server.
+         * Until the item is synced, using the item ID will return an error.
+         *
+         * - In Outlook on the web, the mailbox account to which a draft is saved varies when `saveAsync` is called on a message that will be sent
+         * from a shared mailbox account. If the sender creates a new message from their personal mailbox and selects the shared mailbox account
+         * in the **From** field, `saveAsync` saves the draft to the **Drafts** folder of the user's personal mailbox. If the sender opens the
+         * shared mailbox account in a separate browser tab (through the **Open another mailbox** option, for example) and creates a new message
+         * there, `saveAsync` saves the draft to the **Drafts** folder of the shared mailbox.
+         *
          * **Errors**:
          *
          * - `InvalidAttachmentId`: The attachment identifier does not exist.
          *
          * @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
-         *                 type `Office.AsyncResult`.
+         * @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 message ID is returned in the `asyncResult.value` property.
          */
         saveAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<string>) => void): void;
         /**
-         * Asynchronously saves an item.
-         *
-         * When invoked, this method saves the current message as a draft and returns the item ID via the callback function.
-         * In Outlook on the web or Outlook in online mode, the item is saved to the server.
-         * In Outlook in cached mode, the item is saved to the local cache.
-         *
-         * Since appointments have no draft state, if `saveAsync` is called on an appointment in compose mode, the item will be saved as a normal
-         * appointment on the user's calendar. For new appointments that have not been saved before, no invitation will be sent.
-         * Saving an existing appointment will send an update to added or removed attendees.
-         *
-         * When working with HTML-formatted content, it's important to note that the Outlook client may modify the content. This means that
-         * subsequent calls to methods like `Body.getAsync`, `Body.setAsync`, and even `saveAsync` may not result in the same content.
-         *
-         * **Note**: If your add-in calls `saveAsync` on an item in compose mode in order to get an item ID to use with EWS or the REST API, be aware
-         * that when Outlook is in cached mode, it may take some time before the item is actually synced to the server.
-         * Until the item is synced, using the `itemId` will return an error.
+         * Asynchronously saves the current message as a draft.
          *
          * @remarks
          * [Api set: Mailbox 1.3]
@@ -16204,12 +16192,29 @@ 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**:
+         *
+         * - In Outlook on the web or Outlook in online mode, the item is saved to the server. In Outlook in cached mode, the item is saved to the local cache.
+         *
+         * - When working with HTML-formatted content, it's important to note that the Outlook client may modify the content. This means that
+         * subsequent calls to methods like `Body.getAsync`, `Body.setAsync`, and even `saveAsync` may not result in the same content.
+         *
+         * - If your add-in calls `saveAsync` on an item in compose mode in order to get an item ID to use with EWS or the REST API, be aware that
+         * when Outlook is in cached mode, it may take some time before the item is actually synced to the server.
+         * Until the item is synced, using the item ID will return an error.
+         *
+         * - In Outlook on the web, the mailbox account to which a draft is saved varies when `saveAsync` is called on a message that will be sent
+         * from a shared mailbox account. If the sender creates a new message from their personal mailbox and selects the shared mailbox account
+         * in the **From** field, `saveAsync` saves the draft to the **Drafts** folder of the user's personal mailbox. If the sender opens the
+         * shared mailbox account in a separate browser tab (through the **Open another mailbox** option, for example) and creates a new message
+         * there, `saveAsync` saves the draft to the **Drafts** folder of the shared mailbox.
+         *
          * **Errors**:
          *
          * - `InvalidAttachmentId`: The attachment identifier does not exist.
          *
-         * @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter of
-         *                 type `Office.AsyncResult`.
+         * @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 message ID is returned in the `asyncResult.value` property.
          */
         saveAsync(callback: (asyncResult: Office.AsyncResult<string>) => void): void;
         /**
@@ -60958,7 +60963,7 @@ declare namespace Excel {
         unsupportedSheet = "UnsupportedSheet",
         invalidOperationInCellEditMode = "InvalidOperationInCellEditMode"
     }
-    module Interfaces {
+    namespace Interfaces {
         /**
         * Provides ways to load properties of only a subset of members of a collection.
         */
@@ -93894,7 +93899,7 @@ declare namespace Word {
         searchDialogIsOpen = "SearchDialogIsOpen",
         searchStringInvalidOrTooLong = "SearchStringInvalidOrTooLong",
     }
-    module Interfaces {
+    namespace Interfaces {
         /**
         * Provides ways to load properties of only a subset of members of a collection.
         */
@@ -104648,7 +104653,7 @@ declare namespace OneNote {
         notSupported = "NotSupported",
         operationAborted = "OperationAborted",
     }
-    module Interfaces {
+    namespace Interfaces {
         /**
         * Provides ways to load properties of only a subset of members of a collection.
         */
@@ -109726,7 +109731,7 @@ declare namespace Visio {
         notImplemented = "NotImplemented",
         unsupportedOperation = "UnsupportedOperation",
     }
-    module Interfaces {
+    namespace Interfaces {
         /**
         * Provides ways to load properties of only a subset of members of a collection.
         */
@@ -114231,7 +114236,7 @@ declare namespace PowerPoint {
     enum ErrorCodes {
         generalException = "GeneralException",
     }
-    module Interfaces {
+    namespace Interfaces {
         /**
         * Provides ways to load properties of only a subset of members of a collection.
         */

office-js/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@types/office-js",
-    "version": "1.0.338",
+    "version": "1.0.340",
     "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": "9040baab563352bddc683c5d233454e8180b3cdfcfd6908ed3f989100b6a0b12",
+    "typesPublisherContentHash": "fbbf75bbbe0a56a921785db0e31b99fa3afcd7bcb2f861d9c32917fe678a5e63",
     "typeScriptVersion": "4.3"
 }