Skip to content

[office-js-preview] (Outlook) Document errorMessageMarkdown property #68642

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ElizabethSamuel-MSFT merged 5 commits into from
Jun 25, 2024
Merged

[office-js-preview] (Outlook) Document errorMessageMarkdown property #68642

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
3f2c041
Fix merge conflicts
samantharamon Feb 15, 2024
2fbd1e0
Reword
samantharamon Feb 15, 2024
837e2bb
Reword
samantharamon Mar 25, 2024
b3b6c67
Reword
samantharamon Mar 25, 2024
9a14269
Apply suggestions from review
samantharamon Mar 26, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 26 additions & 0 deletions types/office-js-preview/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20805,6 +20805,32 @@ declare namespace Office {
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
*/
errorMessage?: string;
/**
* When you use the {@link https://learn.microsoft.com/javascript/api/outlook/office.mailboxevent#outlook-office-mailboxevent-completed-member(1) | completed method} to signal completion of an event handler
* and set its `allowEvent` property to `false`, this property sets the error message displayed to the user. The error message is formatted using Markdown. For an example, see the
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/smart-alerts-onmessagesend-walkthrough | Smart Alerts walkthrough}.
*
* @remarks
*
* [Api set: Mailbox preview]
*
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level (Outlook)}**: **restricted**
*
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
*
* **Important**
*
* - The formatted error message must be 500 characters or less.
*
* - For guidance on supported Markdown elements, see
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/onmessagesend-onappointmentsend-events#limitations-to-formatting-the-dialog-message-using-markdown | Limitations to formatting the dialog message using Markdown}.
*
* - If you format the dialog message using the `errorMessageMarkdown` property, we recommend you also add a plaintext version of the message using the `errorMessage` property.
* This ensures that the message is displayed properly in Outlook clients that don't support Markdown.
*
* @beta
*/
errorMessageMarkdown?: string;
/**
* When you use the {@link https://learn.microsoft.com/javascript/api/outlook/office.mailboxevent#outlook-office-mailboxevent-completed-member(1) | completed method} to signal completion of an event handler
* and set its `allowEvent` property to `false`, this property overrides the
Expand Down