Skip to content

Commit

Permalink
[office-js][office-js-preview] (Outlook) Document recommendation for …
Browse files Browse the repository at this point in the history
…Body.getAsync (DefinitelyTyped#70332)
  • Loading branch information
samantharamon authored Aug 22, 2024
1 parent 6cd7a02 commit 8b46b33
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 4 deletions.
16 changes: 14 additions & 2 deletions types/office-js-preview/index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -12781,10 +12781,16 @@ declare namespace Office {
*
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read
*
* **Important**: When working with HTML-formatted bodies, it's important to note that the value returned by the `Body.getAsync` method won't necessarily
* **Important**:
*
* - When working with HTML-formatted bodies, it's important to note that the value returned by the `Body.getAsync` method won't necessarily
* be the exact same value that was previously passed in the `Body.setAsync` method. The client may modify the value passed to `setAsync` to make it
* render efficiently with its rendering engine.
*
* - In Outlook on the web and {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows},
* if the body contains formatted elements, such as tables, lists, and links, specify `Office.CoercionType.Html` in the `getAsync` call.
* Otherwise, you may receive an unexpected value, such as an empty string.
*
* @param coercionType - The format for the returned body.
* @param options - An object literal that contains one or more of the following properties:-
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
Expand All @@ -12804,10 +12810,16 @@ declare namespace Office {
*
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read
*
* **Important**: When working with HTML-formatted bodies, it's important to note that the value returned by the `Body.getAsync` method won't necessarily
* **Important**:
*
* - When working with HTML-formatted bodies, it's important to note that the value returned by the `Body.getAsync` method won't necessarily
* be the exact same value that was previously passed in the `Body.setAsync` method. The client may modify the value passed to `setAsync` to make it
* render efficiently with its rendering engine.
*
* - In Outlook on the web and {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows},
* if the body contains formatted elements, such as tables, lists, and links, specify `Office.CoercionType.Html` in the `getAsync` call.
* Otherwise, you may receive an unexpected value, such as an empty string.
*
* @param coercionType - The format for the returned body.
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter
* of type Office.AsyncResult. The body is provided in the requested format in the `asyncResult.value` property.
Expand Down
16 changes: 14 additions & 2 deletions types/office-js/index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -12695,10 +12695,16 @@ declare namespace Office {
*
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read
*
* **Important**: When working with HTML-formatted bodies, it's important to note that the value returned by the `Body.getAsync` method won't necessarily
* **Important**:
*
* - When working with HTML-formatted bodies, it's important to note that the value returned by the `Body.getAsync` method won't necessarily
* be the exact same value that was previously passed in the `Body.setAsync` method. The client may modify the value passed to `setAsync` to make it
* render efficiently with its rendering engine.
*
* - In Outlook on the web and {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows},
* if the body contains formatted elements, such as tables, lists, and links, specify `Office.CoercionType.Html` in the `getAsync` call.
* Otherwise, you may receive an unexpected value, such as an empty string.
*
* @param coercionType - The format for the returned body.
* @param options - An object literal that contains one or more of the following properties:-
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
Expand All @@ -12718,10 +12724,16 @@ declare namespace Office {
*
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read
*
* **Important**: When working with HTML-formatted bodies, it's important to note that the value returned by the `Body.getAsync` method won't necessarily
* **Important**:
*
* - When working with HTML-formatted bodies, it's important to note that the value returned by the `Body.getAsync` method won't necessarily
* be the exact same value that was previously passed in the `Body.setAsync` method. The client may modify the value passed to `setAsync` to make it
* render efficiently with its rendering engine.
*
* - In Outlook on the web and {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows},
* if the body contains formatted elements, such as tables, lists, and links, specify `Office.CoercionType.Html` in the `getAsync` call.
* Otherwise, you may receive an unexpected value, such as an empty string.
*
* @param coercionType - The format for the returned body.
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter
* of type Office.AsyncResult. The body is provided in the requested format in the `asyncResult.value` property.
Expand Down

0 comments on commit 8b46b33

Please sign in to comment.