From 4b76a2b9de6221096568867a336c115c0acd3650 Mon Sep 17 00:00:00 2001 From: Sam Ramon <15154970+samantharamon@users.noreply.github.com> Date: Wed, 14 Aug 2024 22:52:24 -0700 Subject: [PATCH] Document new multi-select APIs --- .../office.context.mailbox.md | 3 +- .../outlook-requirement-set-preview.md | 48 ++++++++++++++----- 2 files changed, 39 insertions(+), 12 deletions(-) diff --git a/docs/requirement-sets/outlook/preview-requirement-set/office.context.mailbox.md b/docs/requirement-sets/outlook/preview-requirement-set/office.context.mailbox.md index 287017b77..2135a9642 100644 --- a/docs/requirement-sets/outlook/preview-requirement-set/office.context.mailbox.md +++ b/docs/requirement-sets/outlook/preview-requirement-set/office.context.mailbox.md @@ -1,7 +1,7 @@ --- title: Office.context.mailbox - preview requirement set description: Outlook Mailbox API preview requirement set version of the Mailbox object model. -ms.date: 05/20/2024 +ms.date: 08/15/2024 ms.localizationpriority: medium --- @@ -51,6 +51,7 @@ Provides access to the Outlook add-in object model for Microsoft Outlook. | [getCallbackTokenAsync(callback, [userContext])](/javascript/api/outlook/office.mailbox?view=outlook-js-preview&preserve-view=true#outlook-office-mailbox-getcallbacktokenasync-member(2)) | **read item** | Compose
Read | [1.3](../requirement-set-1.3/outlook-requirement-set-1.3.md)
[1.1](../requirement-set-1.1/outlook-requirement-set-1.1.md) | | [getSelectedItemsAsync([options], callback)](/javascript/api/outlook/office.mailbox?view=outlook-js-preview&preserve-view=true#outlook-office-mailbox-getselecteditemsasync-member(1)) | **read/write mailbox** | Compose
Read | [1.13](../requirement-set-1.13/outlook-requirement-set-1.13.md) | | [getUserIdentityTokenAsync(callback, [userContext])](/javascript/api/outlook/office.mailbox?view=outlook-js-preview&preserve-view=true#outlook-office-mailbox-getuseridentitytokenasync-member(1)) | **read item** | Compose
Read | [1.1](../requirement-set-1.1/outlook-requirement-set-1.1.md) | +| [loadItemByIdAsync(itemId, [options], callback)](/javascript/api/outlook/office.mailbox?view=outlook-js-preview&preserve-view=true#outlook-office-mailbox-loaditembyidasync-member(1)) | **read/write item** | Compose
Read | [Preview](outlook-requirement-set-preview.md) | | [makeEwsRequestAsync(data, callback, [userContext])](/javascript/api/outlook/office.mailbox?view=outlook-js-preview&preserve-view=true#outlook-office-mailbox-makeewsrequestasync-member(1)) | **read/write mailbox** | Compose
Read | [1.1](../requirement-set-1.1/outlook-requirement-set-1.1.md) | | [removeHandlerAsync(eventType, [options], [callback])](/javascript/api/outlook/office.mailbox?view=outlook-js-preview&preserve-view=true#outlook-office-mailbox-removehandlerasync-member(1)) | **read item** | Compose
Read | [1.5](../requirement-set-1.5/outlook-requirement-set-1.5.md) | diff --git a/docs/requirement-sets/outlook/preview-requirement-set/outlook-requirement-set-preview.md b/docs/requirement-sets/outlook/preview-requirement-set/outlook-requirement-set-preview.md index 9bcb631be..72f44a8fd 100644 --- a/docs/requirement-sets/outlook/preview-requirement-set/outlook-requirement-set-preview.md +++ b/docs/requirement-sets/outlook/preview-requirement-set/outlook-requirement-set-preview.md @@ -1,7 +1,7 @@ --- title: Outlook add-in API preview requirement set description: Features and APIs that are currently in preview for Outlook add-ins. -ms.date: 06/25/2024 +ms.date: 08/15/2024 ms.topic: whats-new ms.localizationpriority: medium --- @@ -35,19 +35,19 @@ The following features are in preview. Added events to activate an event-based add-in on a message in read mode when it contains certain attachment types or custom internet headers. -**Available in**: Outlook on Windows (Microsoft 365 subscription) +**Available in**: Classic Outlook on Windows (Microsoft 365 subscription) #### [HeaderName attribute in the LaunchEvent element](../../../manifest/launchevent.md#attributes) Added an attribute to the **\** XML element to specify the internet header name on which the `OnMessageReadWithCustomHeader` event occurs. -**Available in**: Outlook on Windows (Microsoft 365 subscription) +**Available in**: Classic Outlook on Windows (Microsoft 365 subscription) #### [MessageAttachments element](../../../manifest/messageattachments.md) Added an XML element to specify the file extension of the attachment included in a message on which the `OnMessageReadWithCustomAttachment` event occurs. -**Available in**: Outlook on Windows (Microsoft 365 subscription) +**Available in**: Classic Outlook on Windows (Microsoft 365 subscription)
@@ -61,13 +61,39 @@ Added an XML element to specify the file extension of the attachment included in Added a new object that represents the all-day event property of an appointment in compose mode. -**Available in**: Outlook on Windows (Microsoft 365 subscription) +**Available in**: Classic Outlook on Windows (Microsoft 365 subscription) #### [Office.context.mailbox.item.isAllDayEvent](office.context.mailbox.item.md#properties) Added a new property that represents if an appointment is an all-day event. -**Available in**: Outlook on Windows (Microsoft 365 subscription) +**Available in**: Classic Outlook on Windows (Microsoft 365 subscription) + +
+ +--- + +--- + +### Item multi-select: Get additional message properties and run operations on multiple selected messages + +#### [Office.context.mailbox.loadItemByIdAsync](/javascript/api/outlook/office.mailbox?view=outlook-js-preview&preserve-view=true#outlook-office-mailbox-loaditembyidasync-member(1)) + +Added a new method to get additional properties and run operations on selected messages. + +**Available in**: Classic Outlook on Windows (Microsoft 365 subscription) + +#### [Office.LoadedMessageCompose](/javascript/api/outlook/office.loadedmessagecompose?view=outlook-js-preview&preserve-view=true) + +Added a new object that represents the properties and methods of a selected message in compose mode. + +**Available in**: Classic Outlook on Windows (Microsoft 365 subscription) + +#### [Office.LoadedMessageRead](/javascript/api/outlook/office.loadedmessageread?view=outlook-js-preview&preserve-view=true) + +Added a new object that represents the properties and methods of a selected message in read mode. + +**Available in**: Classic Outlook on Windows (Microsoft 365 subscription)
@@ -81,7 +107,7 @@ Added a new property that represents if an appointment is an all-day event. Added an `event.completed` option to format a message in a Smart Alerts dialog using Markdown. To learn more, see the [Smart Alerts walkthrough](/office/dev/add-ins/outlook/smart-alerts-onmessagesend-walkthrough) and [Limitations to formatting the dialog message using Markdown](/office/dev/add-ins/outlook/onmessagesend-onappointmentsend-events#limitations-to-formatting-the-dialog-message-using-markdown). -**Available in**: Outlook on Windows (Microsoft 365 subscription) +**Available in**: Classic Outlook on Windows (Microsoft 365 subscription)
@@ -95,25 +121,25 @@ Added an `event.completed` option to format a message in a Smart Alerts dialog u Added a property that gets an object to temporarily set the content displayed in the body or subject of a message in read mode. -**Available in**: Outlook on Windows (Microsoft 365 subscription) +**Available in**: Classic Outlook on Windows (Microsoft 365 subscription) #### [Office.Display](/javascript/api/outlook/office.display?view=outlook-js-preview&preserve-view=true) Added an object that provides properties to temporarily set the content displayed in the body or subject of a message in read mode. -**Available in**: Outlook on Windows (Microsoft 365 subscription) +**Available in**: Classic Outlook on Windows (Microsoft 365 subscription) #### [Office.DisplayedBody](/javascript/api/outlook/office.displayedbody?view=outlook-js-preview&preserve-view=true) Added an object that provides a method to temporarily set the content displayed in the body of a message in read mode. -**Available in**: Outlook on Windows (Microsoft 365 subscription) +**Available in**: Classic Outlook on Windows (Microsoft 365 subscription) #### [Office.DisplayedSubject](/javascript/api/outlook/office.displayedsubject?view=outlook-js-preview&preserve-view=true) Added an object that provides a method to temporarily set the content displayed in the subject of a message in read mode. -**Available in**: Outlook on Windows (Microsoft 365 subscription) +**Available in**: Classic Outlook on Windows (Microsoft 365 subscription)