Merge pull request #2136 from OfficeDev/main

[Admin] Publish
OfficeDev · Nov 15, 2024 · e0c8588 · e0c8588
2 parents 635e0a0 + 19c6cdf
commit e0c8588
Show file tree

Hide file tree

Showing 55 changed files with 8,673 additions and 785 deletions.
diff --git a/docs/docs-ref-autogen/outlook/outlook.yml b/docs/docs-ref-autogen/outlook/outlook.yml
@@ -37,6 +37,8 @@ interfaces:
   - 'outlook!Office.Item:interface'
   - 'outlook!Office.ItemCompose:interface'
   - 'outlook!Office.ItemRead:interface'
+  - 'outlook!Office.LoadedMessageCompose:interface'
+  - 'outlook!Office.LoadedMessageRead:interface'
   - 'outlook!Office.LocalClientTime:interface'
   - 'outlook!Office.Location:interface'
   - 'outlook!Office.LocationDetails:interface'

diff --git a/docs/docs-ref-autogen/outlook/outlook/office.body.yml b/docs/docs-ref-autogen/outlook/outlook/office.body.yml
@@ -127,6 +127,11 @@ methods:
       - The `appendOnSendAsync` method doesn't support inline CSS. Use internal or external CSS instead.
 
 
+      - The `appendOnSendAsync` method isn't supported on a message that's currently loaded using the
+      `loadItemByIdAsync` method. For more information, see [Activate your Outlook add-in on multiple
+      messages](https://learn.microsoft.com/office/dev/add-ins/outlook/item-multi-select)<!-- -->.
+
+
       **Errors**:
 
 
@@ -252,6 +257,11 @@ methods:
       - The `appendOnSendAsync` method doesn't support inline CSS. Use internal or external CSS instead.
 
 
+      - The `appendOnSendAsync` method isn't supported on a message that's currently loaded using the
+      `loadItemByIdAsync` method. For more information, see [Activate your Outlook add-in on multiple
+      messages](https://learn.microsoft.com/office/dev/add-ins/outlook/item-multi-select)<!-- -->.
+
+
       **Errors**:
 
 
@@ -623,6 +633,11 @@ methods:
       - The `prependAsync` method doesn't support inline CSS. Use internal or external CSS instead.
 
 
+      - The `prependAsync` method isn't supported on a message that's currently loaded using the `loadItemByIdAsync`
+      method. For more information, see [Activate your Outlook add-in on multiple
+      messages](https://learn.microsoft.com/office/dev/add-ins/outlook/item-multi-select)<!-- -->.
+
+
       **Errors**:
 
 
@@ -752,6 +767,11 @@ methods:
       - The `prependAsync` method doesn't support inline CSS. Use internal or external CSS instead.
 
 
+      - The `prependAsync` method isn't supported on a message that's currently loaded using the `loadItemByIdAsync`
+      method. For more information, see [Activate your Outlook add-in on multiple
+      messages](https://learn.microsoft.com/office/dev/add-ins/outlook/item-multi-select)<!-- -->.
+
+
       **Errors**:
 
 
@@ -828,6 +848,11 @@ methods:
       - The `prependOnSendAsync` method doesn't support inline CSS. Use internal or external CSS instead.
 
 
+      - The `prependOnSendAsync` method isn't supported on a message that's currently loaded using the
+      `loadItemByIdAsync` method. For more information, see [Activate your Outlook add-in on multiple
+      messages](https://learn.microsoft.com/office/dev/add-ins/outlook/item-multi-select)<!-- -->.
+
+
       **Errors**:
 
 
@@ -957,6 +982,11 @@ methods:
       - The `prependOnSendAsync` method doesn't support inline CSS. Use internal or external CSS instead.
 
 
+      - The `prependOnSendAsync` method isn't supported on a message that's currently loaded using the
+      `loadItemByIdAsync` method. For more information, see [Activate your Outlook add-in on multiple
+      messages](https://learn.microsoft.com/office/dev/add-ins/outlook/item-multi-select)<!-- -->.
+
+
       **Errors**:
 
 
@@ -1028,8 +1058,8 @@ methods:
       anchor (<!-- -->&lt;<!-- -->a<!-- -->&gt;<!-- -->) to "LPNoLP" (see the **Examples** section for a sample).
 
 
-      - In Outlook on Windows and on Mac, the add-in user isn't able to revert this action with the **Undo**
-      command.
+      - In Outlook on Windows (classic) and on Mac, the add-in user isn't able to revert this action with the
+      **Undo** command.
 
 
       - In Outlook on Android and on iOS, this method isn't supported in the Message Compose mode. Only the Appointment
@@ -1044,6 +1074,11 @@ methods:
       - The `setAsync` method doesn't support inline CSS. Use internal or external CSS instead.
 
 
+      - The `setAsync` method isn't supported on a message that's currently loaded using the `loadItemByIdAsync` method.
+      For more information, see [Activate your Outlook add-in on multiple
+      messages](https://learn.microsoft.com/office/dev/add-ins/outlook/item-multi-select)<!-- -->.
+
+
       **Errors**:
 
 
@@ -1195,8 +1230,8 @@ methods:
       anchor (<!-- -->&lt;<!-- -->a<!-- -->&gt;<!-- -->) to "LPNoLP" (see the **Examples** section for a sample).
 
 
-      - In Outlook on Windows and on Mac, the add-in user isn't able to revert this action with the **Undo**
-      command.
+      - In Outlook on Windows (classic) and on Mac, the add-in user isn't able to revert this action with the
+      **Undo** command.
 
 
       - In Outlook on Android and on iOS, this method isn't supported in the Message Compose mode. Only the Appointment
@@ -1211,6 +1246,11 @@ methods:
       - The `setAsync` method doesn't support inline CSS. Use internal or external CSS instead.
 
 
+      - The `setAsync` method isn't supported on a message that's currently loaded using the `loadItemByIdAsync` method.
+      For more information, see [Activate your Outlook add-in on multiple
+      messages](https://learn.microsoft.com/office/dev/add-ins/outlook/item-multi-select)<!-- -->.
+
+
       **Errors**:
 
 
@@ -1265,7 +1305,7 @@ methods:
       **Recommended**: Call `getTypeAsync` then pass the returned value to the `options.coercionType` parameter.
 
 
-      **Important*:
+      **Important**:
 
 
       - When including links in HTML markup, you can disable online link preview by setting the `id` attribute on the
@@ -1278,6 +1318,11 @@ methods:
       - The `setSelectedDataAsync` method doesn't support inline CSS. Use internal or external CSS instead.
 
 
+      - The `setSelectedDataAsync` method isn't supported on a message that's currently loaded using the
+      `loadItemByIdAsync` method. For more information, see [Activate your Outlook add-in on multiple
+      messages](https://learn.microsoft.com/office/dev/add-ins/outlook/item-multi-select)<!-- -->.
+
+
       **Errors**:
 
 
@@ -1382,7 +1427,7 @@ methods:
       **Recommended**: Call `getTypeAsync` then pass the returned value to the `options.coercionType` parameter.
 
 
-      **Important*:
+      **Important**:
 
 
       - When including links in HTML markup, you can disable online link preview by setting the `id` attribute on the
@@ -1395,6 +1440,11 @@ methods:
       - The `setSelectedDataAsync` method doesn't support inline CSS. Use internal or external CSS instead.
 
 
+      - The `setSelectedDataAsync` method isn't supported on a message that's currently loaded using the
+      `loadItemByIdAsync` method. For more information, see [Activate your Outlook add-in on multiple
+      messages](https://learn.microsoft.com/office/dev/add-ins/outlook/item-multi-select)<!-- -->.
+
+
       **Errors**:
 
 
@@ -1469,6 +1519,11 @@ methods:
       - The `setSignatureAsync` method doesn't support inline CSS. Use internal or external CSS instead.
 
 
+      - The `setSignatureAsync` method isn't supported on a message that's currently loaded using the
+      `loadItemByIdAsync` method. For more information, see [Activate your Outlook add-in on multiple
+      messages](https://learn.microsoft.com/office/dev/add-ins/outlook/item-multi-select)<!-- -->.
+
+
       **Errors**:
 
 
@@ -1611,6 +1666,11 @@ methods:
       - The `setSignatureAsync` method doesn't support inline CSS. Use internal or external CSS instead.
 
 
+      - The `setSignatureAsync` method isn't supported on a message that's currently loaded using the
+      `loadItemByIdAsync` method. For more information, see [Activate your Outlook add-in on multiple
+      messages](https://learn.microsoft.com/office/dev/add-ins/outlook/item-multi-select)<!-- -->.
+
+
       **Errors**:
 
 

diff --git a/docs/docs-ref-autogen/outlook/outlook/office.categories.yml b/docs/docs-ref-autogen/outlook/outlook/office.categories.yml
@@ -38,11 +38,6 @@ methods:
     summary: >-
       Adds categories to an item. Each category must be in the categories master list on that mailbox and so must have a
       unique name but multiple categories can use the same color.
-
-
-      **Important**: In Outlook on the web and [new Outlook on
-      Windows](https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627)<!-- -->, you can't use the API
-      to manage categories applied to a message or appointment item in Compose mode.
     remarks: >-
       \[ [API set: Mailbox 1.8](/javascript/api/requirement-sets/outlook/outlook-api-requirement-sets) \]
 
@@ -57,6 +52,11 @@ methods:
       -->**: Compose or Read
 
 
+      **Important**: In Outlook on the web and [new Outlook on
+      Windows](https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627)<!-- -->, you can't use the API
+      to manage categories applied to a message or appointment item in Compose mode.
+
+
       **Errors**:
 
 
@@ -129,11 +129,6 @@ methods:
     summary: >-
       Adds categories to an item. Each category must be in the categories master list on that mailbox and so must have a
       unique name but multiple categories can use the same color.
-
-
-      **Important**: In Outlook on the web and [new Outlook on
-      Windows](https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627)<!-- -->, you can't use the API
-      to manage categories applied to a message or appointment item in Compose mode.
     remarks: >-
       \[ [API set: Mailbox 1.8](/javascript/api/requirement-sets/outlook/outlook-api-requirement-sets) \]
 
@@ -148,6 +143,11 @@ methods:
       -->**: Compose or Read
 
 
+      **Important**: In Outlook on the web and [new Outlook on
+      Windows](https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627)<!-- -->, you can't use the API
+      to manage categories applied to a message or appointment item in Compose mode.
+
+
       **Errors**:
 
 
@@ -297,13 +297,7 @@ methods:
     uid: 'outlook!Office.Categories#removeAsync:member(1)'
     package: outlook!
     fullName: 'removeAsync(categories, options, callback)'
-    summary: >-
-      Removes categories from an item.
-
-
-      **Important**: In Outlook on the web and [new Outlook on
-      Windows](https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627)<!-- -->, you can't use the API
-      to manage categories applied to a message in Compose mode.
+    summary: Removes categories from an item.
     remarks: >-
       \[ [API set: Mailbox 1.8](/javascript/api/requirement-sets/outlook/outlook-api-requirement-sets) \]
 
@@ -318,6 +312,11 @@ methods:
       -->**: Compose or Read
 
 
+      **Important**: In Outlook on the web and [new Outlook on
+      Windows](https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627)<!-- -->, you can't use the API
+      to manage categories applied to a message or appointment item in Compose mode.
+
+
       #### Examples
 
 
@@ -377,13 +376,7 @@ methods:
     uid: 'outlook!Office.Categories#removeAsync:member(2)'
     package: outlook!
     fullName: 'removeAsync(categories, callback)'
-    summary: >-
-      Removes categories from an item.
-
-
-      **Important**: In Outlook on the web and [new Outlook on
-      Windows](https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627)<!-- -->, you can't use the API
-      to manage categories applied to a message in Compose mode.
+    summary: Removes categories from an item.
     remarks: >-
       \[ [API set: Mailbox 1.8](/javascript/api/requirement-sets/outlook/outlook-api-requirement-sets) \]
 
@@ -396,6 +389,11 @@ methods:
       **[Applicable Outlook
       mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)<!--
       -->**: Compose or Read
+
+
+      **Important**: In Outlook on the web and [new Outlook on
+      Windows](https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627)<!-- -->, you can't use the API
+      to manage categories applied to a message or appointment item in Compose mode.
     isPreview: false
     isDeprecated: false
     syntax:

diff --git a/docs/docs-ref-autogen/outlook/outlook/office.customproperties.yml b/docs/docs-ref-autogen/outlook/outlook/office.customproperties.yml
@@ -168,6 +168,11 @@ methods:
       -->**: Compose or Read
 
 
+      **Important**: The `remove` method isn't supported on a message that's currently loaded using the
+      `loadItemByIdAsync` method. For more information, see [Activate your Outlook add-in on multiple
+      messages](https://learn.microsoft.com/office/dev/add-ins/outlook/item-multi-select)<!-- -->.
+
+
       #### Examples
 
 
@@ -315,9 +320,9 @@ methods:
       persist on the mail item, you must call the `saveAsync` method.
 
 
-      The `set` method creates a new property if the specified property does not already exist; otherwise, the existing
-      value is replaced with the new value. The `value` parameter can be of any type; however, it is always passed to
-      the server as a string.
+      The `set` method creates a new property if the specified property doesn't already exist; otherwise, the existing
+      value is replaced with the new value. The `value` parameter can be of any type; however, it's always passed to the
+      server as a string.
     remarks: >-
       \[ [API set: Mailbox 1.1](/javascript/api/requirement-sets/outlook/outlook-api-requirement-sets) \]
 
@@ -332,6 +337,11 @@ methods:
       -->**: Compose or Read
 
 
+      **Important**: The `set` method isn't supported on a message that's currently loaded using the
+      `loadItemByIdAsync` method. For more information, see [Activate your Outlook add-in on multiple
+      messages](https://learn.microsoft.com/office/dev/add-ins/outlook/item-multi-select)<!-- -->.
+
+
       #### Examples
 
 

diff --git a/docs/docs-ref-autogen/outlook/outlook/office.delaydeliverytime.yml b/docs/docs-ref-autogen/outlook/outlook/office.delaydeliverytime.yml
@@ -139,17 +139,25 @@ methods:
       -->**: Compose
 
 
-      **Important**: When `item.delayDeliveryTime.setAsync` is used to schedule the delivery of a message, the delay
-      is processed on the server. This allows the message to be sent even if the Outlook client isn't running. In
-      classic Outlook on Windows, the message doesn't appear in the **Outbox** folder, so you won't be able to edit
-      the message or cancel its delivery after selecting **Send**. You'll only be able to review the message from
-      the **Sent Items** folder. In Outlook on the web, on Mac, and in [new Outlook on
+      **Important**:
+
+
+      - When `item.delayDeliveryTime.setAsync` is used to schedule the delivery of a message, the delay is processed on
+      the server. This allows the message to be sent even if the Outlook client isn't running. In classic Outlook on
+      Windows, the message doesn't appear in the **Outbox** folder, so you won't be able to edit the message or
+      cancel its delivery after selecting **Send**. You'll only be able to review the message from the **Sent
+      Items** folder. In Outlook on the web, on Mac, and in [new Outlook on
       Windows](https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627)<!-- -->, the message appears
       in the **Drafts** folder until the scheduled delivery time. While it's in the **Drafts** folder, you'll be
       able to edit the message before it's sent. To learn more, see [Manage the delivery date and time of a
       message](https://learn.microsoft.com/office/dev/add-ins/outlook/delay-delivery)<!-- -->.
 
 
+      - The `setAsync` method isn't supported on a message that's currently loaded using the `loadItemByIdAsync` method.
+      For more information, see [Activate your Outlook add-in on multiple
+      messages](https://learn.microsoft.com/office/dev/add-ins/outlook/item-multi-select)<!-- -->.
+
+
       **Errors**:
 
 
@@ -197,17 +205,25 @@ methods:
       -->**: Compose
 
 
-      **Important**: When `item.delayDeliveryTime.setAsync` is used to schedule the delivery of a message, the delay
-      is processed on the server. This allows the message to be sent even if the Outlook client isn't running. In
-      classic Outlook on Windows, the message doesn't appear in the **Outbox** folder, so you won't be able to edit
-      the message or cancel its delivery after selecting **Send**. You'll only be able to review the message from
-      the **Sent Items** folder. In Outlook on the web, on Mac, and in [new Outlook on
+      **Important**:
+
+
+      - When `item.delayDeliveryTime.setAsync` is used to schedule the delivery of a message, the delay is processed on
+      the server. This allows the message to be sent even if the Outlook client isn't running. In classic Outlook on
+      Windows, the message doesn't appear in the **Outbox** folder, so you won't be able to edit the message or
+      cancel its delivery after selecting **Send**. You'll only be able to review the message from the **Sent
+      Items** folder. In Outlook on the web, on Mac, and in [new Outlook on
       Windows](https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627)<!-- -->, the message appears
       in the **Drafts** folder until the scheduled delivery time. While it's in the **Drafts** folder, you'll be
       able to edit the message before it's sent. To learn more, see [Manage the delivery date and time of a
       message](https://learn.microsoft.com/office/dev/add-ins/outlook/delay-delivery)<!-- -->.
 
 
+      - The `setAsync` method isn't supported on a message that's currently loaded using the `loadItemByIdAsync` method.
+      For more information, see [Activate your Outlook add-in on multiple
+      messages](https://learn.microsoft.com/office/dev/add-ins/outlook/item-multi-select)<!-- -->.
+
+
       **Errors**: