@types/office-js 1.0.411 → 1.0.412

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: Thu, 08 Aug 2024 16:08:15 GMT
+ * Last updated: Mon, 12 Aug 2024 18:39:04 GMT
  * Dependencies: none
 
 # Credits

office-js/index.d.ts

@@ -12588,18 +12588,6 @@ declare namespace Office {
          * To use `appendOnSendAsync`, you must specify a supplementary permission in the manifest. Details vary with the type of manifest. See {@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Understanding Outlook add-in permissions}. To learn more
          * about append-on-send and its configuration, see
          * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/append-on-send | Implement append-on-send in your Outlook add-in}.
-         * 
-         * **Important**: If the {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-on-send-addins?tabs=windows | on-send feature}
-         * is implemented with append-on-send, the following apply.
-         * 
-         * - If the user is running add-ins that implement the on-send feature using `ItemSend` in the manifest, append-on-send runs before on-send functionality.
-         *
-         * - If your add-in implements the on-send feature and calls `appendOnSendAsync` in the `ItemSend` handler,
-         * the `appendOnSendAsync` call returns an error as this scenario isn't supported.
-         *
-         * **Recommended**: Call `getTypeAsync` then pass the returned value to the `options.coercionType` parameter.
-         *
-         * **Note**: To clear data from a previous `appendOnSendAsync` call, you can call it again with the `data` parameter set to `null`.
          *
          * @remarks
          * [Api set: Mailbox 1.9]
@@ -12608,6 +12596,22 @@ declare namespace Office {
          *
          * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
          *
+         * **Recommended**: Call `getTypeAsync`, then pass its returned value to the `options.coercionType` parameter.
+         *
+         *  **Important**:
+         *
+         * - If the user is running add-ins that implement the {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-on-send-addins | on-send feature}
+         * using `ItemSend` in the manifest, append-on-send runs before on-send functionality.
+         *
+         * - If your add-in implements the on-send feature and calls `appendOnSendAsync` in the `ItemSend` handler,
+         * the `appendOnSendAsync` call returns an error as this scenario isn't supported.
+         *
+         * - To clear data from a previous `appendOnSendAsync` call, you can call it again with the `data` parameter set to `null`.
+         *
+         * - SVG files aren't supported. Use JPG or PNG files instead.
+         *
+         * - The `appendOnSendAsync` method doesn't support inline CSS. Use internal or external CSS instead.
+         *
          * **Errors**:
          *
          * - `DataExceedsMaximumSize`: The `data` parameter is longer than 5,000 characters.
@@ -12628,18 +12632,6 @@ declare namespace Office {
          * To use `appendOnSendAsync`, you must specify a supplementary permission in the manifest. Details vary with the type of manifest. See {@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Understanding Outlook add-in permissions}. To learn more
          * about append-on-send and its configuration, see
          * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/append-on-send | Implement append-on-send in your Outlook add-in}.
-         * 
-         * **Important**: If the {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-on-send-addins?tabs=windows | on-send feature}
-         * is implemented with append-on-send, the following apply.
-         * 
-         * - If the user is running add-ins that implement the on-send feature using `ItemSend` in the manifest, append-on-send runs before on-send functionality.
-         *
-         * - If your add-in implements the on-send feature and calls `appendOnSendAsync` in the `ItemSend` handler,
-         * the `appendOnSendAsync` call returns an error as this scenario isn't supported.
-         *
-         * **Recommended**: Call `getTypeAsync` then pass the returned value to the `options.coercionType` parameter.
-         *
-         * **Note**: To clear data from a previous `appendOnSendAsync` call, you can call it again with the `data` parameter set to `null`.
          *
          * @remarks
          * [Api set: Mailbox 1.9]
@@ -12648,6 +12640,22 @@ declare namespace Office {
          *
          * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
          *
+         * **Recommended**: Call `getTypeAsync`, then pass its returned value to the `options.coercionType` parameter.
+         *
+         * **Important**:
+         *
+         * - If the user is running add-ins that implement the {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-on-send-addins | on-send feature}
+         * using `ItemSend` in the manifest, append-on-send runs before on-send functionality.
+         *
+         * - If your add-in implements the on-send feature and calls `appendOnSendAsync` in the `ItemSend` handler,
+         * the `appendOnSendAsync` call returns an error as this scenario isn't supported.
+         *
+         * - To clear data from a previous `appendOnSendAsync` call, you can call it again with the `data` parameter set to `null`.
+         *
+         * - SVG files aren't supported. Use JPG or PNG files instead.
+         *
+         * - The `appendOnSendAsync` method doesn't support inline CSS. Use internal or external CSS instead.
+         *
          * **Errors**:
          *
          * - `DataExceedsMaximumSize`: The `data` parameter is longer than 5,000 characters.
@@ -12753,6 +12761,8 @@ declare namespace Office {
          *
          * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
          *
+         * **Recommended**: Call `getTypeAsync`, then pass the returned value to the `options.coercionType` parameter.
+         *
          * **Important**:
          *
          * - After the content is prepended, the position of the cursor depends on which client the add-in is running. In Outlook on the web and on Windows
@@ -12772,7 +12782,9 @@ declare namespace Office {
          * supported. 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}.
          *
-         * **Recommended**: Call `getTypeAsync`, then pass the returned value to the `options.coercionType` parameter. 
+         * - SVG files aren't supported. Use JPG or PNG files instead.
+         *
+         * - The `prependAsync` method doesn't support inline CSS. Use internal or external CSS instead.
          *
          * **Errors**:
          *
@@ -12796,6 +12808,8 @@ declare namespace Office {
          *
          * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
          *
+         * **Recommended**: Call `getTypeAsync`, then pass the returned value to the `options.coercionType` parameter.
+         *
          * **Important**:
          *
          * - After the content is prepended, the position of the cursor depends on which client the add-in is running. In Outlook on the web and on Windows
@@ -12815,7 +12829,9 @@ declare namespace Office {
          * supported. 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}.
          *
-         * **Recommended**: Call `getTypeAsync`, then pass the returned value to the `options.coercionType` parameter. 
+         * - SVG files aren't supported. Use JPG or PNG files instead.
+         *
+         * - The `prependAsync` method doesn't support inline CSS. Use internal or external CSS instead.
          *
          * **Errors**:
          *
@@ -12828,37 +12844,41 @@ declare namespace Office {
         prependAsync(data: string, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
         /**
          * Prepends HTML or plain text to the beginning of a message or appointment body when the mail item is sent.
-         * 
+         *
          * To use `prependOnSendAsync`, you must specify a supplementary permission in the manifest. Details vary with the type of manifest. For guidance,
          * see {@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Understanding Outlook add-in permissions}.
-         * 
+         *
          * @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 item**
          *
          * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
-         * 
+         *
          * **Recommended**: Call `getTypeAsync`, then pass its returned value to the `options.coercionType` parameter.
-         * 
+         *
          * **Important**: When implementing `prependOnSendAsync`, keep the following in mind.
-         * 
+         *
          * - In a {@link https://learn.microsoft.com/office/dev/add-ins/outlook/onmessagesend-onappointmentsend-events | Smart Alerts add-in},
          * the prepend-on-send feature runs first.
-         * 
+         *
          * - A new line is added after the prepended content.
-         * 
+         *
          * - If multiple active add-ins call `prependOnSendAsync`, the order of the inserted content depends on the order in which the add-in runs.
          * The content of the last run add-in appears above previously prepended content.
-         * 
+         *
          * - If the add-in attempts to insert HTML into a plain text body, the content won't be prepended. Conversely, plain text will be inserted into an HTML body.
-         * 
+         *
+         * - SVG files aren't supported. Use JPG or PNG files instead.
+         *
+         * - The `prependOnSendAsync` method doesn't support inline CSS. Use internal or external CSS instead.
+         *
          * **Errors**:
-         * 
+         *
          * - `DataExceedsMaximumSize`: The `data` parameter exceeds 5,000 characters.
-         * 
+         *
          * - `InvalidFormatError`: The `options.coercionType` parameter is set to `Office.CoercionType.Html`, but the item body is in plain text format.
-         * 
+         *
          * @param data - The string to be prepended to the beginning of the message or appointment body. The string is limited to 5,000 characters.
          * @param options - An object literal that contains one or more of the following properties:-
          *        `asyncContext`: Any object that can be accessed in the callback function.
@@ -12869,37 +12889,41 @@ declare namespace Office {
         prependOnSendAsync(data: string, options: Office.AsyncContextOptions & CoercionTypeOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
         /**
          * Prepends HTML or plain text to the beginning of a message or appointment body when the mail item is sent.
-         * 
+         *
          * To use `prependOnSendAsync`, you must specify a supplementary permission in the manifest. Details vary with the type of manifest. For guidance,
          * see {@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Understanding Outlook add-in permissions}.
-         * 
+         *
          * @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 item**
          *
          * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
-         * 
+         *
          * **Recommended**: Call `getTypeAsync`, then pass its returned value to the `options.coercionType` parameter.
-         * 
+         *
          * **Important**: When implementing `prependOnSendAsync`, keep the following in mind.
-         * 
+         *
          * - In a {@link https://learn.microsoft.com/office/dev/add-ins/outlook/onmessagesend-onappointmentsend-events | Smart Alerts add-in},
          * the prepend-on-send feature runs first.
-         * 
+         *
          * - A new line is added after the prepended content.
-         * 
+         *
          * - If multiple active add-ins call `prependOnSendAsync`, the order of the inserted content depends on the order in which the add-in runs.
          * The content of the last run add-in appears above previously prepended content.
-         * 
+         *
          * - If the add-in attempts to insert HTML into a plain text body, the content won't be prepended. Conversely, plain text will be inserted into an HTML body.
-         * 
+         *
+         * - SVG files aren't supported. Use JPG or PNG files instead.
+         *
+         * - The `prependOnSendAsync` method doesn't support inline CSS. Use internal or external CSS instead.
+         *
          * **Errors**:
-         * 
+         *
          * - `DataExceedsMaximumSize`: The `data` parameter exceeds 5,000 characters.
-         * 
+         *
          * - `InvalidFormatError`: The `options.coercionType` parameter is set to `Office.CoercionType.Html`, but the item body is in plain text format.
-         * 
+         *
          * @param data - The string to be prepended to the beginning of the message or appointment body. The string is limited to 5,000 characters.
          * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter
          *                             of type `Office.AsyncResult`. Any errors encountered will be provided in the `asyncResult.error` property.
@@ -12915,6 +12939,8 @@ declare namespace Office {
          *
          * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
          *
+         * **Recommended**: Call `getTypeAsync`, then pass the returned value to the `options.coercionType` parameter.
+         *
          * **Important**:
          *
          * - After the body is replaced with the specified content, the position of the cursor depends on which client the add-in is running.
@@ -12936,7 +12962,9 @@ declare namespace Office {
          * supported. 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}.
          *
-         * **Recommended**: Call `getTypeAsync`, then pass the returned value to the `options.coercionType` parameter. 
+         * - SVG files aren't supported. Use JPG or PNG files instead.
+         *
+         * - The `setAsync` method doesn't support inline CSS. Use internal or external CSS instead.
          *
          * **Errors**:
          *
@@ -12962,6 +12990,8 @@ declare namespace Office {
          *
          * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
          *
+         * **Recommended**: Call `getTypeAsync`, then pass the returned value to the `options.coercionType` parameter.
+         *
          * **Important**:
          *
          * - After the body is replaced with the specified content, the position of the cursor depends on which client the add-in is running.
@@ -12983,7 +13013,9 @@ declare namespace Office {
          * supported. 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}.
          *
-         * **Recommended**: Call `getTypeAsync`, then pass the returned value to the `options.coercionType` parameter. 
+         * - SVG files aren't supported. Use JPG or PNG files instead.
+         *
+         * - The `setAsync` method doesn't support inline CSS. Use internal or external CSS instead.
          *
          * **Errors**:
          *
@@ -13003,11 +13035,6 @@ declare namespace Office {
          * the editor, it replaces the selected text. If the cursor was never in the body of the item, or if the body of the item lost focus in the
          * UI, the string will be inserted at the top of the body content. After insertion, the cursor is placed at the end of the inserted content.
          *
-         * When including links in HTML markup, you can disable online link preview by setting the `id` attribute on the anchor (\<a\>) to "LPNoLP"
-         * (see the **Examples** section for a sample).
-         *
-         * **Recommended**: Call `getTypeAsync` then pass the returned value to the `options.coercionType` parameter.
-         *
          * @remarks
          * [Api set: Mailbox 1.1]
          *
@@ -13015,6 +13042,17 @@ declare namespace Office {
          *
          * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
          *
+         * **Recommended**: Call `getTypeAsync` then pass the returned value to the `options.coercionType` parameter.
+         *
+         * **Important*:
+         *
+         * - When including links in HTML markup, you can disable online link preview by setting the `id` attribute on the anchor (\<a\>) to "LPNoLP"
+         * (see the **Examples** section for a sample).
+         *
+         * - SVG files aren't supported. Use JPG or PNG files instead.
+         *
+         * - The `setSelectedDataAsync` method doesn't support inline CSS. Use internal or external CSS instead.
+         *
          * **Errors**:
          *
          * - `DataExceedsMaximumSize`: The `data` parameter is longer than 1,000,000 characters.
@@ -13036,11 +13074,6 @@ declare namespace Office {
          * the editor, it replaces the selected text. If the cursor was never in the body of the item, or if the body of the item lost focus in the
          * UI, the string will be inserted at the top of the body content. After insertion, the cursor is placed at the end of the inserted content.
          *
-         * When including links in HTML markup, you can disable online link preview by setting the `id` attribute on the anchor (\<a\>) to "LPNoLP"
-         * (see the **Examples** section for a sample).
-         *
-         * **Recommended**: Call `getTypeAsync` then pass the returned value to the `options.coercionType` parameter.
-         *
          * @remarks
          * [Api set: Mailbox 1.1]
          *
@@ -13048,6 +13081,17 @@ declare namespace Office {
          *
          * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
          *
+         * **Recommended**: Call `getTypeAsync` then pass the returned value to the `options.coercionType` parameter.
+         *
+         * **Important*:
+         *
+         * - When including links in HTML markup, you can disable online link preview by setting the `id` attribute on the anchor (\<a\>) to "LPNoLP"
+         * (see the **Examples** section for a sample).
+         *
+         * - SVG files aren't supported. Use JPG or PNG files instead.
+         *
+         * - The `setSelectedDataAsync` method doesn't support inline CSS. Use internal or external CSS instead.
+         *
          * **Errors**:
          *
          * - `DataExceedsMaximumSize`: The `data` parameter is longer than 1,000,000 characters.
@@ -13084,6 +13128,10 @@ declare namespace Office {
          * 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.
          *
+         * - SVG files aren't supported in mail signatures. Use JPG or PNG files instead.
+         *
+         * - The `setSignatureAsync` method doesn't support inline CSS. Use internal or external CSS instead.
+         *
          * **Errors**:
          *
          * - `DataExceedsMaximumSize`: The `data` parameter is longer than 30,000 characters.
@@ -13124,6 +13172,10 @@ declare namespace Office {
          * 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.
          *
+         * - SVG files aren't supported in mail signatures. Use JPG or PNG files instead.
+         *
+         * - The `setSignatureAsync` method doesn't support inline CSS. Use internal or external CSS instead.
+         *
          * **Errors**:
          *
          * - `DataExceedsMaximumSize`: The `data` parameter is longer than 30,000 characters.

office-js/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@types/office-js",
-    "version": "1.0.411",
+    "version": "1.0.412",
     "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": "294aa411a4ab747a5fafc736077f6b749a4ee0ae4328b51d3ce5b0a9fa46aaaf",
+    "typesPublisherContentHash": "5b233252e5b8991ddebae66b8e74df96960f11a01f7639737e9e43263d38c9a9",
     "typeScriptVersion": "4.8"
 }