@types/office-js 1.0.432 → 1.0.434

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.
office-js/README.md CHANGED
@@ -8,7 +8,7 @@ This package contains type definitions for office-js (https://github.com/OfficeD
8
8
  Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-js.
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
office-js/index.d.ts CHANGED
@@ -5473,6 +5473,8 @@ declare namespace Office {
5473
5473
  *
5474
5474
  * - 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.
5475
5475
  *
5476
+ * Although classic Outlook on Mac doesn't support Mailbox 1.9, it does support DialogApi 1.2.
5477
+ *
5476
5478
  * @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.
5477
5479
  * @param messageOptions Optional. Provides options for how to send the message.
5478
5480
  */
@@ -8630,18 +8632,22 @@ declare namespace Office {
8630
8632
  */
8631
8633
  displayDialogAsync(startAddress: string, callback?: (result: AsyncResult<Dialog>) => void): void;
8632
8634
  /**
8633
- * Delivers a message from the dialog box to its parent/opener page.
8634
- *
8635
+ * Delivers a message from the dialog box to its parent/opener page.
8636
+ *
8635
8637
  * @remarks
8636
- *
8637
- * **Requirement sets**:
8638
- *
8638
+ *
8639
+ * **Applications**: Excel, Outlook, PowerPoint, Word
8640
+ *
8641
+ * **Requirement sets**:
8642
+ *
8639
8643
  * - {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/dialog-api-requirement-sets | DialogApi}
8640
- *
8644
+ *
8645
+ * - {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/outlook-api-requirement-sets | Mailbox 1.4}
8646
+ *
8641
8647
  * - 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.
8642
- *
8643
- * @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.
8644
- * @param messageOptions Optional. Provides options for how to send the message.
8648
+ *
8649
+ * @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.
8650
+ * @param messageOptions Optional. Provides options for how to send the message.
8645
8651
  */
8646
8652
  messageParent(message: string, messageOptions?: DialogMessageOptions): void;
8647
8653
  /**
@@ -20568,7 +20574,7 @@ declare namespace Office {
20568
20574
  cancelLabel?: string;
20569
20575
  /**
20570
20576
  * 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`,
20571
- * this property specifies the ID of the task pane that opens when the **Don't Send** button is selected from the Smart Alerts dialog.
20577
+ * 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.
20572
20578
  *
20573
20579
  * For an example, see the
20574
20580
  * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/smart-alerts-onmessagesend-walkthrough#customize-the-dont-send-button-optional | Smart Alerts walkthrough}.
@@ -20583,14 +20589,14 @@ declare namespace Office {
20583
20589
  *
20584
20590
  * **Important**:
20585
20591
  *
20586
- * 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
20592
+ * 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
20587
20593
  * add-in uses.
20588
20594
  *
20589
- * - **Add-in only manifest**: The `id` attribute of the {@link https://learn.microsoft.com/javascript/api/manifest/control | Control} element representing the task pane.
20595
+ * - **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.
20590
20596
  *
20591
- * - **Unified manifest for Microsoft 365**: The "id" property of the task pane command in the "controls" array.
20597
+ * - **Unified manifest for Microsoft 365**: The "id" property of the task pane or function command in the "controls" array.
20592
20598
  *
20593
- * If you specify the `contextData` option in your `event.completed` call, you must also assign a task pane ID to the `commandId` option.
20599
+ * 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.
20594
20600
  * Otherwise, the JSON data assigned to `contextData` is ignored.
20595
20601
  */
20596
20602
  commandId?: string;
office-js/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@types/office-js",
3
- "version": "1.0.432",
3
+ "version": "1.0.434",
4
4
  "description": "TypeScript definitions for office-js",
5
5
  "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-js",
6
6
  "license": "MIT",
@@ -45,6 +45,6 @@
45
45
  },
46
46
  "scripts": {},
47
47
  "dependencies": {},
48
- "typesPublisherContentHash": "a4e9c42a4489b5f50dac50ae21564283afc8fb537c267f60833bbe39a9abebdf",
48
+ "typesPublisherContentHash": "3f9986d01e9ec5df657d71f8ad34614418e48888546ec20932e7b942cc67e148",
49
49
  "typeScriptVersion": "4.8"
50
50
  }