@types/office-js-preview 1.0.518 → 1.0.520

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: Tue, 01 Oct 2024 00:33:23 GMT
11
+ * Last updated: Mon, 07 Oct 2024 22:07:58 GMT
12
12
  * Dependencies: none
13
13
 
14
14
  # Credits
@@ -5525,6 +5525,8 @@ declare namespace Office {
5525
5525
  *
5526
5526
  * - If the `messageOptions` parameter is used, {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/dialog-origin-requirement-sets | DialogOrigin 1.1} is also required.
5527
5527
  *
5528
+ * Although classic Outlook on Mac doesn't support Mailbox 1.9, it does support DialogApi 1.2.
5529
+ *
5528
5530
  * @param message Accepts a message from the host page to deliver to the dialog. Anything that can be serialized to a string, including JSON and XML, can be sent.
5529
5531
  * @param messageOptions Optional. Provides options for how to send the message.
5530
5532
  */
@@ -8682,18 +8684,22 @@ declare namespace Office {
8682
8684
  */
8683
8685
  displayDialogAsync(startAddress: string, callback?: (result: AsyncResult<Dialog>) => void): void;
8684
8686
  /**
8685
- * Delivers a message from the dialog box to its parent/opener page.
8686
- *
8687
+ * Delivers a message from the dialog box to its parent/opener page.
8688
+ *
8687
8689
  * @remarks
8688
- *
8689
- * **Requirement sets**:
8690
- *
8690
+ *
8691
+ * **Applications**: Excel, Outlook, PowerPoint, Word
8692
+ *
8693
+ * **Requirement sets**:
8694
+ *
8691
8695
  * - {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/dialog-api-requirement-sets | DialogApi}
8692
- *
8696
+ *
8697
+ * - {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/outlook-api-requirement-sets | Mailbox 1.4}
8698
+ *
8693
8699
  * - If the `messageOptions` parameter is used, {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/dialog-origin-requirement-sets | DialogOrigin 1.1} is also required.
8694
- *
8695
- * @param message Accepts a message from the dialog to deliver to the add-in. Anything that can serialized to a string including JSON and XML can be sent.
8696
- * @param messageOptions Optional. Provides options for how to send the message.
8700
+ *
8701
+ * @param message Accepts a message from the dialog to deliver to the add-in. Anything that can serialized to a string including JSON and XML can be sent.
8702
+ * @param messageOptions Optional. Provides options for how to send the message.
8697
8703
  */
8698
8704
  messageParent(message: string, messageOptions?: DialogMessageOptions): void;
8699
8705
  /**
@@ -20928,7 +20934,7 @@ declare namespace Office {
20928
20934
  cancelLabel?: string;
20929
20935
  /**
20930
20936
  * 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`,
20931
- * this property specifies the ID of the task pane that opens when the **Don't Send** button is selected from the Smart Alerts dialog.
20937
+ * this property specifies the ID of the task pane or function that runs when the **Don't Send** button is selected from the Smart Alerts dialog.
20932
20938
  *
20933
20939
  * For an example, see the
20934
20940
  * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/smart-alerts-onmessagesend-walkthrough#customize-the-dont-send-button-optional | Smart Alerts walkthrough}.
@@ -20943,14 +20949,14 @@ declare namespace Office {
20943
20949
  *
20944
20950
  * **Important**:
20945
20951
  *
20946
- * The `commandId` value must match the task pane ID specified in the manifest of your add-in. The markup depends on the type of manifest your
20952
+ * The `commandId` value must match the task pane or function ID specified in the manifest of your add-in. The markup depends on the type of manifest your
20947
20953
  * add-in uses.
20948
20954
  *
20949
- * - **Add-in only manifest**: The `id` attribute of the {@link https://learn.microsoft.com/javascript/api/manifest/control | Control} element representing the task pane.
20955
+ * - **Add-in only manifest**: The `id` attribute of the {@link https://learn.microsoft.com/javascript/api/manifest/control | Control} element representing the task pane or function.
20950
20956
  *
20951
- * - **Unified manifest for Microsoft 365**: The "id" property of the task pane command in the "extensions.ribbons.tabs.groups.controls" array.
20957
+ * - **Unified manifest for Microsoft 365**: The "id" property of the task pane or function command in the "controls" array.
20952
20958
  *
20953
- * If you specify the `contextData` option in your `event.completed` call, you must also assign a task pane ID to the `commandId` option.
20959
+ * If you specify the `contextData` option in your `event.completed` call, you must also assign a task pane or function ID to the `commandId` option.
20954
20960
  * Otherwise, the JSON data assigned to `contextData` is ignored.
20955
20961
  */
20956
20962
  commandId?: string;
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@types/office-js-preview",
3
- "version": "1.0.518",
3
+ "version": "1.0.520",
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,7 +45,7 @@
45
45
  },
46
46
  "scripts": {},
47
47
  "dependencies": {},
48
- "typesPublisherContentHash": "addda6c813855e9325b3bc4c50c1228ca4541b237838b859cc30e114a92ccf77",
48
+ "typesPublisherContentHash": "572b97676af58aa2f2fe751816052413077bb7899ee68c3843f11fb85958544d",
49
49
  "typeScriptVersion": "4.8",
50
50
  "nonNpm": true
51
51
  }