@types/office-js-preview 1.0.444 → 1.0.445

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -8,7 +8,7 @@ This package contains type definitions for office-js-preview (https://github.com
8
8
  Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-js-preview.
9
9
 
10
10
  ### Additional Details
11
- * Last updated: Fri, 26 Jan 2024 00:50:36 GMT
11
+ * Last updated: Fri, 26 Jan 2024 01:28:35 GMT
12
12
  * Dependencies: none
13
13
 
14
14
  # Credits
@@ -13656,7 +13656,7 @@ declare namespace Office {
13656
13656
  */
13657
13657
  interface DisplayedBody {
13658
13658
  /**
13659
- * Temporarily sets the content displayed in the body of a message in read mode. The set content will remain visible until the user switches to a different messsage or
13659
+ * Temporarily sets the content displayed in the body of a message in read mode. The set content remains visible until the user switches to a different messsage or
13660
13660
  * closes the window of the current message.
13661
13661
  *
13662
13662
  * @remarks
@@ -13670,6 +13670,17 @@ declare namespace Office {
13670
13670
  * {@link https://learn.microsoft.com/javascript/api/outlook/office.body#outlook-office-body-gettypeasync-member(1) | Office.context.mailbox.item.body.getTypeAsync},
13671
13671
  * then pass the returned value to the `options.coercionType` parameter.
13672
13672
  *
13673
+ * **Important**:
13674
+ *
13675
+ * - If multiple add-ins that implement `setAsync` run simultaneously, the content set by the last add-in that completes the `setAsync` operation is displayed in the body.
13676
+ *
13677
+ * - The content set by the `setAsync` method is only displayed while the user is viewing the item. It isn't cached in Outlook and doesn't sync with other
13678
+ * Outlook clients.
13679
+ *
13680
+ * - If you save a message after calling `setAsync`, the original contents of the message body appear in the saved item.
13681
+ *
13682
+ * - The `setAsync` method isn't supported on multiple selected messages.
13683
+ *
13673
13684
  * @param data - The string to be temporarily displayed in the body of a message. The string is limited to 1,000,000 characters.
13674
13685
  * @param options - An object literal that contains one or more of the following properties:-
13675
13686
  * `asyncContext`: Developers can provide any object they wish to access in the callback function.
@@ -13691,6 +13702,17 @@ declare namespace Office {
13691
13702
  *
13692
13703
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read
13693
13704
  *
13705
+ * **Important**:
13706
+ *
13707
+ * - If multiple add-ins that implement `setAsync` run simultaneously, the content set by the last add-in that completes the `setAsync` operation is displayed in the body.
13708
+ *
13709
+ * - The content set by the `setAsync` method is only displayed while the user is viewing the item. It isn't cached in Outlook and doesn't sync with other
13710
+ * Outlook clients.
13711
+ *
13712
+ * - If you save a message after calling `setAsync`, the original contents of the message body appear in the saved item.
13713
+ *
13714
+ * - The `setAsync` method isn't supported on multiple selected messages.
13715
+ *
13694
13716
  * @param data - The string to be temporarily displayed in the body of a message. The string is limited to 1,000,000 characters.
13695
13717
  * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter, `asyncResult`,
13696
13718
  * which is an `Office.AsyncResult` object. Any errors encountered will be provided in the `asyncResult.error` property.
@@ -13723,11 +13745,25 @@ declare namespace Office {
13723
13745
  *
13724
13746
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read
13725
13747
  *
13748
+ * **Important**:
13749
+ *
13750
+ * - If multiple add-ins that implement `setAsync` run simultaneously, the content set by the last add-in that completes the `setAsync` operation is displayed in the
13751
+ * subject field.
13752
+ *
13753
+ * - The content set by the `setAsync` method is only displayed while the user is viewing the item. It isn't cached in Outlook and doesn't sync with other
13754
+ * Outlook clients.
13755
+ *
13756
+ * - If you save a message after calling `setAsync`, the original subject appears in the saved item.
13757
+ *
13758
+ * - The `setAsync` method isn't supported on multiple selected messages.
13759
+ *
13726
13760
  * @param data - The string to be temporarily displayed in the subject of a message. The string is limited to 255 characters.
13727
13761
  * @param options - An object literal that contains one or more of the following properties:-
13728
13762
  * `asyncContext`: Developers can provide any object they wish to access in the callback function.
13729
13763
  * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter, `asyncResult`,
13730
13764
  * which is an `Office.AsyncResult` object. Any errors encountered will be provided in the `asyncResult.error` property.
13765
+ *
13766
+ * @beta
13731
13767
  */
13732
13768
  setAsync(data: string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
13733
13769
  /**
@@ -13741,9 +13777,23 @@ declare namespace Office {
13741
13777
  *
13742
13778
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read
13743
13779
  *
13780
+ * **Important**:
13781
+ *
13782
+ * - If multiple add-ins that implement `setAsync` run simultaneously, the content set by the last add-in that completes the `setAsync` operation is displayed in the
13783
+ * subject field.
13784
+ *
13785
+ * - The content set by the `setAsync` method is only displayed while the user is viewing the item. It isn't cached in Outlook and doesn't sync with other
13786
+ * Outlook clients.
13787
+ *
13788
+ * - If you save a message after calling `setAsync`, the original subject appears in the saved item.
13789
+ *
13790
+ * - The `setAsync` method isn't supported on multiple selected messages.
13791
+ *
13744
13792
  * @param data - The string to be temporarily displayed in the subject of a message. The string is limited to 255 characters.
13745
13793
  * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter, `asyncResult`,
13746
13794
  * which is an `Office.AsyncResult` object. Any errors encountered will be provided in the `asyncResult.error` property.
13795
+ *
13796
+ * @beta
13747
13797
  */
13748
13798
  setAsync(data: string, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
13749
13799
  }
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@types/office-js-preview",
3
- "version": "1.0.444",
3
+ "version": "1.0.445",
4
4
  "description": "TypeScript definitions for office-js-preview",
5
5
  "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-js-preview",
6
6
  "license": "MIT",
@@ -45,6 +45,6 @@
45
45
  },
46
46
  "scripts": {},
47
47
  "dependencies": {},
48
- "typesPublisherContentHash": "e1dff5d5a002d193a56a8d62f7bbbe47c724881e2ac457526efba759aed2fb6b",
48
+ "typesPublisherContentHash": "1f28f67fcb6bd9c50774a8a34750873a67cf651981cf64a8042402c1b014b270",
49
49
  "typeScriptVersion": "4.6"
50
50
  }