@types/office-js-preview 1.0.578 → 1.0.580

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, 28 Mar 2025 14:36:00 GMT
11
+ * Last updated: Mon, 07 Apr 2025 19:02:16 GMT
12
12
  * Dependencies: none
13
13
 
14
14
  # Credits
@@ -641,14 +641,20 @@ declare namespace Office {
641
641
  /**
642
642
  * Occurs in Outlook when an action is selected on a notification message with a defined
643
643
  * {@link https://learn.microsoft.com/javascript/api/outlook/office.notificationmessagedetails#actions | custom action}.
644
- * Currently, "Dismiss" is the only supported action that fires this event.
645
- *
646
- * **Important**: This event can only be handled in a task pane. Function commands can't register a handler for this event.
644
+ * Currently, **Dismiss** is the only supported action that fires this event.
647
645
  *
648
646
  * To add an event handler for the `InfobarClicked` event, use the `addHandlerAsync` method of the `Item` object.
649
647
  * The event handler receives an argument of type
650
648
  * {@link https://learn.microsoft.com/javascript/api/outlook/office.infobarclickedeventargs?view=outlook-js-1.10 | Office.InfobarClickedEventArgs}.
651
649
  *
650
+ * **Important**:
651
+ *
652
+ * - This event can only be handled in a task pane. Function commands can't register a handler for this event.
653
+ *
654
+ * - Although Outlook on Mac supports the `InsightMessage` notification type, it currently doesn't support the `InfobarClicked` event.
655
+ * To determine when the **Dismiss** action is selected from the notification, implement a handler for the `OnInfoBarDismissClicked` event instead.
656
+ * For more information, see {@link https://learn.microsoft.com/office/dev/add-ins/outlook/autolaunch#supported-events | Configure your Outlook add-in for event-based activation}.
657
+ *
652
658
  * [Api set: Mailbox 1.10]
653
659
  */
654
660
  InfobarClicked,
@@ -12838,6 +12844,21 @@ declare namespace Office {
12838
12844
  interface AttachmentDetailsCompose {
12839
12845
  /**
12840
12846
  * Gets a value that indicates the attachment's type.
12847
+ *
12848
+ * @remarks
12849
+ *
12850
+ * **Important**:
12851
+ *
12852
+ * - In Outlook on the web and new Outlook on Windows, a message or appointment that's locally saved then attached using
12853
+ * drag-and-drop or the **Attach Item** option is of type `Office.MailboxEnums.AttachmentType.File`. The file name extension is
12854
+ * returned in the `name` property. However, a message or appointment that's attached using the **Forward as Attachment** option
12855
+ * is of type `Office.MailboxEnums.AttachmentType.Item`. In this case, an extension isn't returned in the `name` property.
12856
+ *
12857
+ * - In classic Outlook on Windows, a message or appointment that's attached using drag-and-drop, **Attach File**, or
12858
+ * **Forward as Attachment** is of type `Office.MailboxEnums.AttachmentType.Item`. A file name extension isn't returned in the `name` property.
12859
+ *
12860
+ * - In Outlook on Mac, a message or appointment that's attached using drag-and-drop, **Attach Item**, or **Forward as Attachment** is of type
12861
+ * `Office.MailboxEnums.AttachmentType.File`. The file name extension is returned in the `name` property.
12841
12862
  */
12842
12863
  attachmentType: MailboxEnums.AttachmentType | string;
12843
12864
  /**
@@ -12851,8 +12872,22 @@ declare namespace Office {
12851
12872
  /**
12852
12873
  * Gets the name of the attachment.
12853
12874
  *
12854
- * **Important**: For message or appointment items that were attached by drag-and-drop or "Attach Item",
12855
- * `name` includes a file extension in Outlook on Mac, but excludes the extension on the web or on Windows.
12875
+ * @remarks
12876
+ *
12877
+ * **Important**:
12878
+ *
12879
+ * - An attachment of type `Office.MailboxEnums.AttachmentType.Item` doesn't return a file name extension in the `name` property.
12880
+ *
12881
+ * - In Outlook on the web and new Outlook on Windows, a message or appointment that's locally saved then attached using
12882
+ * drag-and-drop or the **Attach Item** option is of type `Office.MailboxEnums.AttachmentType.File`. The file name extension is
12883
+ * returned in the `name` property. However, a message or appointment that's attached using the **Forward as Attachment** option
12884
+ * is of type `Office.MailboxEnums.AttachmentType.Item`. In this case, an extension isn't returned in the `name` property.
12885
+ *
12886
+ * - In classic Outlook on Windows, a message or appointment that's attached using drag-and-drop, **Attach File**, or
12887
+ * **Forward as Attachment** is of type `Office.MailboxEnums.AttachmentType.Item`. A file name extension isn't returned in the `name` property.
12888
+ *
12889
+ * - In Outlook on Mac, a message or appointment that's attached using drag-and-drop, **Attach Item**, or **Forward as Attachment** is of type
12890
+ * `Office.MailboxEnums.AttachmentType.File`. The file name extension is returned in the `name` property.
12856
12891
  */
12857
12892
  name: string;
12858
12893
  /**
@@ -12903,8 +12938,9 @@ declare namespace Office {
12903
12938
  /**
12904
12939
  * Gets the name of the attachment.
12905
12940
  *
12906
- * **Important**: For message or appointment items that were attached by drag-and-drop or "Attach Item",
12907
- * `name` includes a file extension in Outlook on Mac, but excludes the extension on the web or on Windows.
12941
+ * @remarks
12942
+ *
12943
+ * **Important**: An attachment of type `Office.MailboxEnums.AttachmentType.Item` doesn't return a file name extension in the `name` property.
12908
12944
  */
12909
12945
  name: string;
12910
12946
  /**
@@ -21493,6 +21529,10 @@ declare namespace Office {
21493
21529
  *
21494
21530
  * - To retrieve the JSON data, call `Office.context.mailboxitem.getInitializationContextAsync`. If you create a JSON string using
21495
21531
  * `JSON.stringify()` and assign it to the `contextData` property, you must parse the string using `JSON.parse()` once you retrieve it.
21532
+ *
21533
+ * - To prevent the task pane of a notification message from relaunching if it's already open, implement a handler for the `Office.EventType.InitializationContextChanged` event.
21534
+ * You can then pass the {@link https://learn.microsoft.com/javascript/api/outlook/office.initializationcontextchangedeventargs?view=outlook-js-1.15&preserve-view=true | event arguments}
21535
+ * to the `contextData` property.
21496
21536
  */
21497
21537
  contextData: any;
21498
21538
  }
@@ -23638,6 +23678,10 @@ declare namespace Office {
23638
23678
  *
23639
23679
  * - When you configure a button in the Smart Alerts dialog to run a function, a button for the function is also added to the ribbon or action bar of the Outlook client.
23640
23680
  * Use the `contextData` option to distinguish when a user runs the function from the Smart Alerts dialog.
23681
+ *
23682
+ * - To prevent the task pane of a Smart Alerts add-in from relaunching if it's already open, implement a handler for the `Office.EventType.InitializationContextChanged` event.
23683
+ * You can then pass the {@link https://learn.microsoft.com/javascript/api/outlook/office.initializationcontextchangedeventargs?view=outlook-js-1.15&preserve-view=true | event arguments}
23684
+ * to the `contextData` property.
23641
23685
  */
23642
23686
  contextData?: any;
23643
23687
  /**
@@ -23817,6 +23861,10 @@ declare namespace Office {
23817
23861
  *
23818
23862
  * - If you implement a task pane to open after a reported message is processed, when the `event.completed` call occurs, any task pane that's open or pinned is closed.
23819
23863
  *
23864
+ * - To prevent the task pane of a spam-reporting add-in from relaunching if it's already open, implement a handler for the `Office.EventType.InitializationContextChanged` event.
23865
+ * You can then pass the {@link https://learn.microsoft.com/javascript/api/outlook/office.initializationcontextchangedeventargs?view=outlook-js-1.15&preserve-view=true | event arguments}
23866
+ * to the `contextData` property.
23867
+ *
23820
23868
  * - To retrieve the value of the `contextData` property, you must call `Office.context.mailbox.item.getInitializationContextAsync` in the JavaScript implementation
23821
23869
  * of your task pane. If you create a JSON string using `JSON.stringify()` and assign it to the `contextData` property, you must parse the string using
23822
23870
  * `JSON.parse()` once you retrieve it.
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@types/office-js-preview",
3
- "version": "1.0.578",
3
+ "version": "1.0.580",
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",
@@ -46,7 +46,7 @@
46
46
  "scripts": {},
47
47
  "dependencies": {},
48
48
  "peerDependencies": {},
49
- "typesPublisherContentHash": "92a16fdc89a304c4b24c4a469a66d043399641535d15a78ed0428acfc28a5cb3",
50
- "typeScriptVersion": "5.0",
49
+ "typesPublisherContentHash": "b544b621420d74839b7f9239bc4c72dfbd4b77d83bed4b7dfc25fd3c2c532bff",
50
+ "typeScriptVersion": "5.1",
51
51
  "nonNpm": true
52
52
  }