Skip to content

Commit

Permalink
[Outlook] (Dialog API) Document support in Outlook on Mac (#2069)
Browse files Browse the repository at this point in the history
* Update support for Dialog APIs

* Fix link

* Update ms.date

* Fix note

* Apply suggestions from review

Co-authored-by: Elizabeth Samuel <[email protected]>

---------

Co-authored-by: Elizabeth Samuel <[email protected]>
  • Loading branch information
samantharamon and ElizabethSamuel-MSFT authored Oct 8, 2024
1 parent 531b560 commit 709a77b
Show file tree
Hide file tree
Showing 3 changed files with 38 additions and 21 deletions.
23 changes: 19 additions & 4 deletions docs/requirement-sets/common/dialog-api-requirement-sets.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Dialog API requirement sets
description: Learn more about the Dialog API requirement sets.
ms.date: 04/15/2024
ms.date: 10/08/2024
ms.topic: overview
ms.localizationpriority: medium
---
Expand All @@ -18,23 +18,38 @@ Office Add-ins run across multiple versions of Office. The following table lists
| DialogApi 1.1 | Supported | Version 1602 (Build 6741.0000) | Version 1602 (Build 6741.0000) | Office 2016 | Version 15.20 | Version 1.22 | Version 1608 (Build 7601.6800) |

> [!NOTE]
> \* Users of perpetual versions of Office may not have accepted all patches and updates. If so, the DLL that Office uses to report its version in the UI may be greater than the versions listed here even if the updated DLLs needed to support DialogApi have not be installed on the user's computer. To ensure that the needed patch is installed, the user must go to the [Office 2016 update list](/officeupdates/msp-files-office-2016), search for **osfclient-x-none**, and install the listed patch.
> \* Users of perpetual versions of Office may not have accepted all patches and updates. If so, the DLL that Office uses to report its version in the UI may be greater than the versions listed here even if the updated DLLs needed to support DialogApi haven't been installed on the user's computer. To ensure that the needed patch is installed, the user must go to the [Office 2016 update list](/officeupdates/msp-files-office-2016), search for **osfclient-x-none**, and install the listed patch.
## Office on Windows (Microsoft 365 subscription) support

The DialogApi 1.2 requirement set is supported in the Consumer Channel from Version 2005 (Build 12827.20268). That requirement set is also supported in the Semi-Annual Channel and Monthly Enterprise Channel builds available since June 9, 2020. The **minimum** supported builds for each channel are as follows:
The DialogApi 1.2 requirement set is supported in the Consumer Channel from Version 2005 (Build 12827.20268). That requirement set is also supported in the Semi-Annual Channel and Monthly Enterprise Channel builds available since June 9, 2020. The **minimum** supported builds for each channel are as follows:

| Channel | Minimum version | Minimum build |
|:-----|:-----|:-----|
| Current Channel | 2005 | 12827.20160 |
| Monthly Enterprise Channel | 2004 | 12730.20430 |
| Semi-Annual Enterprise Channel | 2002 | 12527.20720 |

## Outlook support

In Outlook, dialog features and their APIs were introduced in the following Mailbox requirement sets.

| Feature | API | Mailbox requirement set |
| :----- | :----- | :----- |
| Display a dialog | [Office.context.ui.displayDialogAsync](/javascript/api/office/office.ui#office-office-ui-displaydialogasync-member(1)) | [1.4](../outlook/requirement-set-1.4/outlook-requirement-set-1.4.md) |
| Deliver a message from the dialog to the its parent page | [Office.context.ui.messageParent](/javascript/api/office/office.ui#office-office-ui-messageparent-member(1)) | [1.4](../outlook/requirement-set-1.4/outlook-requirement-set-1.4.md) |
| Close a dialog | [Office.context.ui.closeContainer](/javascript/api/office/office.ui#office-office-ui-closecontainer-member(1)) | [1.5](../outlook/requirement-set-1.5/outlook-requirement-set-1.5.md) |
| Deliver a message from the host page to a dialog | [Office.dialog.messageChild](/javascript/api/office/office.dialog#office-office-dialog-messagechild-member(1)) | [1.9](../outlook/requirement-set-1.9/outlook-requirement-set-1.9.md)\* |

> [!NOTE]
> \* Although classic Outlook on Mac doesn't support Mailbox requirement set 1.9, it does support the DialogApi 1.2 requirement set.
## Office versions and build numbers

To find out more about versions, build numbers, and Office Online Server, see:

[!INCLUDE [Links to get Office versions and how to find Office client version](../../includes/links-get-office-versions-builds.md)]

- [Office Online Server overview](/officeonlineserver/office-online-server-overview)

## Office Common API requirement sets
Expand All @@ -43,7 +58,7 @@ For information about Common API requirement sets, see [Office Common API requir

## Dialog API 1.1 and 1.2

The Dialog API 1.1 is the first version of the API. Requirement set 1.2 adds support for sending data from the parent page to the dialog box with the [Office.dialog.messageChild](/javascript/api/office/office.dialog#office-office-dialog-messagechild-member(1)) method. For details about these APIs, see the [Dialog API](/javascript/api/office/office.ui) reference topic.
The Dialog API 1.1 is the first version of the API (see [Office.UI](/javascript/api/office/office.ui)). Requirement set 1.2 adds support for sending data from the parent page to the dialog box with the [Office.dialog.messageChild](/javascript/api/office/office.dialog#office-office-dialog-messagechild-member(1)) method. For details about these APIs, see the [Dialog API](/javascript/api/office/office.ui) reference topic.

## See also

Expand Down
Loading

0 comments on commit 709a77b

Please sign in to comment.