@types/office-js-preview 1.0.444 → 1.0.446

office-js-preview/README.md

@@ -8,7 +8,7 @@ This package contains type definitions for office-js-preview (https://github.com
 Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-js-preview.
 
 ### Additional Details
- * Last updated: Fri, 26 Jan 2024 00:50:36 GMT
+ * Last updated: Fri, 26 Jan 2024 16:07:24 GMT
  * Dependencies: none
 
 # Credits

office-js-preview/index.d.ts

@@ -13656,7 +13656,7 @@ declare namespace Office {
      */
     interface DisplayedBody {
         /**
-         * Temporarily sets the content displayed in the body of a message in read mode. The set content will remain visible until the user switches to a different messsage or
+         * Temporarily sets the content displayed in the body of a message in read mode. The set content remains visible until the user switches to a different message or
          * closes the window of the current message.
          *
          * @remarks
@@ -13670,6 +13670,17 @@ declare namespace Office {
          * {@link https://learn.microsoft.com/javascript/api/outlook/office.body#outlook-office-body-gettypeasync-member(1) | Office.context.mailbox.item.body.getTypeAsync},
          * then pass the returned value to the `options.coercionType` parameter.
          *
+         * **Important**:
+         *
+         * - If multiple add-ins that implement `setAsync` run simultaneously, the content set by the last add-in that completes the `setAsync` operation is displayed in the body.
+         *
+         * - The content set by the `setAsync` method is only displayed while the user is viewing the item. It isn't cached in Outlook and doesn't sync with other
+         * Outlook clients.
+         *
+         * - If you save a message after calling `setAsync`, the original contents of the message body appear in the saved item.
+         *
+         * - The `setAsync` method isn't supported on multiple selected messages.
+         *
          * @param data - The string to be temporarily displayed in the body of a message. The string is limited to 1,000,000 characters.
          * @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.
@@ -13681,7 +13692,7 @@ declare namespace Office {
          */
         setAsync(data: string, options: Office.AsyncContextOptions & CoercionTypeOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
         /**
-         * Temporarily sets the content displayed in the body of a message in read mode. The set content will remain visible until the user switches to a different messsage or
+         * Temporarily sets the content displayed in the body of a message in read mode. The set content will remain visible until the user switches to a different message or
          * closes the window of the current message.
          *
          * @remarks
@@ -13691,6 +13702,17 @@ declare namespace Office {
          *
          * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read
          *
+         * **Important**:
+         *
+         * - If multiple add-ins that implement `setAsync` run simultaneously, the content set by the last add-in that completes the `setAsync` operation is displayed in the body.
+         *
+         * - The content set by the `setAsync` method is only displayed while the user is viewing the item. It isn't cached in Outlook and doesn't sync with other
+         * Outlook clients.
+         *
+         * - If you save a message after calling `setAsync`, the original contents of the message body appear in the saved item.
+         *
+         * - The `setAsync` method isn't supported on multiple selected messages.
+         *
          * @param data - The string to be temporarily displayed in the body of a message. The string is limited to 1,000,000 characters.
          * @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. Any errors encountered will be provided in the `asyncResult.error` property.
@@ -13713,7 +13735,7 @@ declare namespace Office {
      */
     interface DisplayedSubject {
         /**
-         * Temporarily sets the content displayed in the subject of a message in read mode. The set content will remain visible until the user switches to a different messsage or
+         * Temporarily sets the content displayed in the subject of a message in read mode. The set content will remain visible until the user switches to a different message or
          * closes the window of the current message.
          *
          * @remarks
@@ -13723,15 +13745,29 @@ declare namespace Office {
          *
          * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read
          *
+         * **Important**:
+         *
+         * - If multiple add-ins that implement `setAsync` run simultaneously, the content set by the last add-in that completes the `setAsync` operation is displayed in the
+         * subject field.
+         *
+         * - The content set by the `setAsync` method is only displayed while the user is viewing the item. It isn't cached in Outlook and doesn't sync with other
+         * Outlook clients.
+         *
+         * - If you save a message after calling `setAsync`, the original subject appears in the saved item.
+         *
+         * - The `setAsync` method isn't supported on multiple selected messages.
+         *
          * @param data - The string to be temporarily displayed in the subject of a message. The string is limited to 255 characters.
          * @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, `asyncResult`,
          *        which is an `Office.AsyncResult` object. Any errors encountered will be provided in the `asyncResult.error` property.
+         *
+         * @beta
          */
         setAsync(data: string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
         /**
-         * Temporarily sets the content displayed in the subject of a message in read mode. The set content will remain visible until the user switches to a different messsage or
+         * Temporarily sets the content displayed in the subject of a message in read mode. The set content will remain visible until the user switches to a different message or
          * closes the window of the current message.
          *
          * @remarks
@@ -13741,9 +13777,23 @@ declare namespace Office {
          *
          * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read
          *
+         * **Important**:
+         *
+         * - If multiple add-ins that implement `setAsync` run simultaneously, the content set by the last add-in that completes the `setAsync` operation is displayed in the
+         * subject field.
+         *
+         * - The content set by the `setAsync` method is only displayed while the user is viewing the item. It isn't cached in Outlook and doesn't sync with other
+         * Outlook clients.
+         *
+         * - If you save a message after calling `setAsync`, the original subject appears in the saved item.
+         *
+         * - The `setAsync` method isn't supported on multiple selected messages.
+         *
          * @param data - The string to be temporarily displayed in the subject of a message. The string is limited to 255 characters.
          * @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. Any errors encountered will be provided in the `asyncResult.error` property.
+         *
+         * @beta
          */
         setAsync(data: string, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
     }
@@ -16055,7 +16105,7 @@ declare namespace Office {
          *
          * **Important**:
          *
-         * - Adding an inline Base64 file to a messsage in compose mode is supported in Outlook on Android and on iOS. For more information on supported APIs in
+         * - Adding an inline Base64 file to a message in compose mode is supported in Outlook on Android and 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}.
          *
          * - 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.
@@ -16101,7 +16151,7 @@ declare namespace Office {
          *
          * **Important**:
          *
-         * - Adding an inline Base64 file to a messsage in compose mode is supported in Outlook on Android and on iOS. For more information on supported APIs in
+         * - Adding an inline Base64 file to a message in compose mode is supported in Outlook on Android and 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}.
          *
          * - 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.

office-js-preview/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@types/office-js-preview",
-    "version": "1.0.444",
+    "version": "1.0.446",
     "description": "TypeScript definitions for office-js-preview",
     "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-js-preview",
     "license": "MIT",
@@ -45,6 +45,6 @@
     },
     "scripts": {},
     "dependencies": {},
-    "typesPublisherContentHash": "e1dff5d5a002d193a56a8d62f7bbbe47c724881e2ac457526efba759aed2fb6b",
+    "typesPublisherContentHash": "1addb0e5673dceaafc334bccb0c7a31410d95f665c7df75f930dc8f385e73211",
     "typeScriptVersion": "4.6"
 }