@types/office-js 1.0.486 → 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 +1 -1
- office-js/index.d.ts +56 -7
- office-js/package.json +3 -3
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:
|
|
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
|
@@ -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,
|
|
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,
|
|
@@ -12751,6 +12757,21 @@ declare namespace Office {
|
|
|
12751
12757
|
interface AttachmentDetailsCompose {
|
|
12752
12758
|
/**
|
|
12753
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.
|
|
12754
12775
|
*/
|
|
12755
12776
|
attachmentType: MailboxEnums.AttachmentType | string;
|
|
12756
12777
|
/**
|
|
@@ -12764,8 +12785,23 @@ declare namespace Office {
|
|
|
12764
12785
|
/**
|
|
12765
12786
|
* Gets the name of the attachment.
|
|
12766
12787
|
*
|
|
12767
|
-
*
|
|
12768
|
-
*
|
|
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.
|
|
12769
12805
|
*/
|
|
12770
12806
|
name: string;
|
|
12771
12807
|
/**
|
|
@@ -12816,8 +12852,9 @@ declare namespace Office {
|
|
|
12816
12852
|
/**
|
|
12817
12853
|
* Gets the name of the attachment.
|
|
12818
12854
|
*
|
|
12819
|
-
*
|
|
12820
|
-
*
|
|
12855
|
+
* @remarks
|
|
12856
|
+
*
|
|
12857
|
+
* **Important**: An attachment of type `Office.MailboxEnums.AttachmentType.Item` doesn't return a file name extension in the `name` property.
|
|
12821
12858
|
*/
|
|
12822
12859
|
name: string;
|
|
12823
12860
|
/**
|
|
@@ -21027,6 +21064,10 @@ declare namespace Office {
|
|
|
21027
21064
|
*
|
|
21028
21065
|
* - To retrieve the JSON data, call `Office.context.mailboxitem.getInitializationContextAsync`. If you create a JSON string using
|
|
21029
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.
|
|
21030
21071
|
*/
|
|
21031
21072
|
contextData: any;
|
|
21032
21073
|
}
|
|
@@ -23113,6 +23154,10 @@ declare namespace Office {
|
|
|
23113
23154
|
*
|
|
23114
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.
|
|
23115
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.
|
|
23116
23161
|
*/
|
|
23117
23162
|
contextData?: any;
|
|
23118
23163
|
/**
|
|
@@ -23292,6 +23337,10 @@ declare namespace Office {
|
|
|
23292
23337
|
*
|
|
23293
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.
|
|
23294
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
|
+
*
|
|
23295
23344
|
* - To retrieve the value of the `contextData` property, you must call `Office.context.mailbox.item.getInitializationContextAsync` in the JavaScript implementation
|
|
23296
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
|
|
23297
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.
|
|
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": "
|
|
50
|
-
"typeScriptVersion": "5.
|
|
49
|
+
"typesPublisherContentHash": "1d24d351aa7b6886e9d7f10fbcb04bf1a82118294145d41110ee4c7a2c6a4c6e",
|
|
50
|
+
"typeScriptVersion": "5.1"
|
|
51
51
|
}
|