@types/office-js 1.0.487 → 1.0.488

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 Apr 2025 18:39:20 GMT
11
+ * Last updated: Mon, 07 Apr 2025 19:02:16 GMT
12
12
  * Dependencies: none
13
13
 
14
14
  # Credits
office-js/index.d.ts CHANGED
@@ -12757,6 +12757,21 @@ declare namespace Office {
12757
12757
  interface AttachmentDetailsCompose {
12758
12758
  /**
12759
12759
  * Gets a value that indicates the attachment's type.
12760
+ *
12761
+ * @remarks
12762
+ *
12763
+ * **Important**:
12764
+ *
12765
+ * - In Outlook on the web and new Outlook on Windows, a message or appointment that's locally saved then attached using
12766
+ * drag-and-drop or the **Attach Item** option is of type `Office.MailboxEnums.AttachmentType.File`. The file name extension is
12767
+ * returned in the `name` property. However, a message or appointment that's attached using the **Forward as Attachment** option
12768
+ * is of type `Office.MailboxEnums.AttachmentType.Item`. In this case, an extension isn't returned in the `name` property.
12769
+ *
12770
+ * - In classic Outlook on Windows, a message or appointment that's attached using drag-and-drop, **Attach File**, or
12771
+ * **Forward as Attachment** is of type `Office.MailboxEnums.AttachmentType.Item`. A file name extension isn't returned in the `name` property.
12772
+ *
12773
+ * - In Outlook on Mac, a message or appointment that's attached using drag-and-drop, **Attach Item**, or **Forward as Attachment** is of type
12774
+ * `Office.MailboxEnums.AttachmentType.File`. The file name extension is returned in the `name` property.
12760
12775
  */
12761
12776
  attachmentType: MailboxEnums.AttachmentType | string;
12762
12777
  /**
@@ -12770,8 +12785,23 @@ declare namespace Office {
12770
12785
  /**
12771
12786
  * Gets the name of the attachment.
12772
12787
  *
12773
- * **Important**: For message or appointment items that were attached by drag-and-drop or "Attach Item",
12774
- * `name` includes a file extension in Outlook on Mac, but excludes the extension on the web or on Windows.
12788
+ * @remarks
12789
+ *
12790
+ * **Important**:
12791
+ *
12792
+ * - An attachment of type `Office.MailboxEnums.AttachmentType.Item` doesn't return a file name extension in the `name` property.
12793
+ *
12794
+ * - In Outlook on the web and new Outlook on Windows, a message or appointment that's locally saved then attached using
12795
+ * drag-and-drop or the **Attach Item** option is of type `Office.MailboxEnums.AttachmentType.File`. The file name extension is
12796
+ * returned in the `name` property. However, a message or appointment that's attached using the **Forward as Attachment** option
12797
+ * is of type `Office.MailboxEnums.AttachmentType.Item`. In this case, an extension isn't returned in the `name` property.
12798
+ *
12799
+ * - In classic Outlook on Windows, a message or appointment that's attached using drag-and-drop, **Attach Item**, or
12800
+ * **Forward as Attachment** is of type `Office.MailboxEnums.AttachmentType.Item`. A file name extension isn't returned in the `name` property.
12801
+ * A calendar item that's attached
12802
+ *
12803
+ * - In Outlook on Mac, a message or appointment that's attached using drag-and-drop, **Attach Item**, or **Forward as Attachment** is of type
12804
+ * `Office.MailboxEnums.AttachmentType.File`. The file name extension is returned in the `name` property.
12775
12805
  */
12776
12806
  name: string;
12777
12807
  /**
@@ -12822,8 +12852,9 @@ declare namespace Office {
12822
12852
  /**
12823
12853
  * Gets the name of the attachment.
12824
12854
  *
12825
- * **Important**: For message or appointment items that were attached by drag-and-drop or "Attach Item",
12826
- * `name` includes a file extension in Outlook on Mac, but excludes the extension on the web or on Windows.
12855
+ * @remarks
12856
+ *
12857
+ * **Important**: An attachment of type `Office.MailboxEnums.AttachmentType.Item` doesn't return a file name extension in the `name` property.
12827
12858
  */
12828
12859
  name: string;
12829
12860
  /**
@@ -21033,6 +21064,10 @@ declare namespace Office {
21033
21064
  *
21034
21065
  * - To retrieve the JSON data, call `Office.context.mailboxitem.getInitializationContextAsync`. If you create a JSON string using
21035
21066
  * `JSON.stringify()` and assign it to the `contextData` property, you must parse the string using `JSON.parse()` once you retrieve it.
21067
+ *
21068
+ * - 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.
21069
+ * 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}
21070
+ * to the `contextData` property.
21036
21071
  */
21037
21072
  contextData: any;
21038
21073
  }
@@ -23119,6 +23154,10 @@ declare namespace Office {
23119
23154
  *
23120
23155
  * - 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.
23121
23156
  * Use the `contextData` option to distinguish when a user runs the function from the Smart Alerts dialog.
23157
+ *
23158
+ * - 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.
23159
+ * 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}
23160
+ * to the `contextData` property.
23122
23161
  */
23123
23162
  contextData?: any;
23124
23163
  /**
@@ -23298,6 +23337,10 @@ declare namespace Office {
23298
23337
  *
23299
23338
  * - 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.
23300
23339
  *
23340
+ * - 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.
23341
+ * 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}
23342
+ * to the `contextData` property.
23343
+ *
23301
23344
  * - To retrieve the value of the `contextData` property, you must call `Office.context.mailbox.item.getInitializationContextAsync` in the JavaScript implementation
23302
23345
  * 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
23303
23346
  * `JSON.parse()` once you retrieve it.
office-js/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@types/office-js",
3
- "version": "1.0.487",
3
+ "version": "1.0.488",
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",
@@ -46,6 +46,6 @@
46
46
  "scripts": {},
47
47
  "dependencies": {},
48
48
  "peerDependencies": {},
49
- "typesPublisherContentHash": "24f3ecc1bfac4591486e788bb5c5f4ed9a9344d0013e671c9c24eb84385cf12c",
49
+ "typesPublisherContentHash": "1d24d351aa7b6886e9d7f10fbcb04bf1a82118294145d41110ee4c7a2c6a4c6e",
50
50
  "typeScriptVersion": "5.1"
51
51
  }