@types/office-js 1.0.521 → 1.0.522
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 +184 -0
- office-js/package.json +2 -2
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: Tue, 05 Aug 2025 18:02:59 GMT
|
|
12
12
|
* Dependencies: none
|
|
13
13
|
|
|
14
14
|
# Credits
|
office-js/index.d.ts
CHANGED
|
@@ -684,6 +684,20 @@ declare namespace Office {
|
|
|
684
684
|
* [Api set: Mailbox 1.5]
|
|
685
685
|
*/
|
|
686
686
|
ItemChanged,
|
|
687
|
+
/**
|
|
688
|
+
* Occurs in Outlook on the web and the new Outlook on Windows when messages or file attachments in the Outlook client window are
|
|
689
|
+
* dragged then dropped into the task pane of an add-in.
|
|
690
|
+
*
|
|
691
|
+
* To add an event handler for the `ItemDraggedAndDropped` event, use the `addHandlerAsync` method of the `Mailbox` object.
|
|
692
|
+
* The event handler receives an argument of type
|
|
693
|
+
* {@link https://learn.microsoft.com/javascript/api/outlook/office.draganddropeventargs | Office.DragAndDropEventArgs}.
|
|
694
|
+
*
|
|
695
|
+
* **Important**: The `ItemDraggedAndDropped` event isn't supported in Outlook on Windows (classic) and on Mac. If the `ItemDraggedAndDropped` handler
|
|
696
|
+
* runs on these clients, an error occurs ("This event isn't supported on this platform.").
|
|
697
|
+
*
|
|
698
|
+
* [Api set: Mailbox 1.5]
|
|
699
|
+
*/
|
|
700
|
+
ItemDraggedAndDropped,
|
|
687
701
|
/**
|
|
688
702
|
* Triggers when a `customXmlPart` node is deleted.
|
|
689
703
|
*/
|
|
@@ -14342,6 +14356,176 @@ declare namespace Office {
|
|
|
14342
14356
|
*/
|
|
14343
14357
|
OWAView: MailboxEnums.OWAView | "OneColumn" | "TwoColumns" | "ThreeColumns";
|
|
14344
14358
|
}
|
|
14359
|
+
/**
|
|
14360
|
+
* Provides details about the mouse pointer position and the messages or file attachments being dragged and dropped into an add-in's task pane when the
|
|
14361
|
+
* `Office.EventType.ItemDraggedAndDropped` event is raised.
|
|
14362
|
+
*
|
|
14363
|
+
* @remarks
|
|
14364
|
+
*
|
|
14365
|
+
* [Api set: Mailbox 1.5]
|
|
14366
|
+
*
|
|
14367
|
+
* To learn more about the drag-and-drop feature and how to implement it across various Outlook clients, see
|
|
14368
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/drag-drop-items | Drag and drop messages and attachments into the task pane of an Outlook add-in}.
|
|
14369
|
+
*/
|
|
14370
|
+
export interface DragAndDropEventArgs {
|
|
14371
|
+
/**
|
|
14372
|
+
* Gets the details about the mouse pointer position within an add-in's task pane and the messages or file attachments being dragged and dropped into the task pane.
|
|
14373
|
+
*
|
|
14374
|
+
* @remarks
|
|
14375
|
+
*
|
|
14376
|
+
* [Api set: Mailbox 1.5]
|
|
14377
|
+
*/
|
|
14378
|
+
dragAndDropEventData: DragoverEventData | DropEventData;
|
|
14379
|
+
/**
|
|
14380
|
+
* Gets the type of the event. For details, see {@link https://learn.microsoft.com/javascript/api/office/office.eventtype | Office.EventType}.
|
|
14381
|
+
*
|
|
14382
|
+
* [Api set: Mailbox 1.5]
|
|
14383
|
+
*/
|
|
14384
|
+
type: "olkDragAndDropEvent";
|
|
14385
|
+
}
|
|
14386
|
+
/**
|
|
14387
|
+
* Represents the `DragAndDropEventArgs.dragAndDropEventData` object when messages or file attachments are dragged over an add-in's task pane.
|
|
14388
|
+
*
|
|
14389
|
+
* @remarks
|
|
14390
|
+
*
|
|
14391
|
+
* [Api set: Mailbox 1.5]
|
|
14392
|
+
*
|
|
14393
|
+
* To learn more about the drag-and-drop feature and how to implement it across various Outlook clients, see
|
|
14394
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/drag-drop-items | Drag and drop messages and attachments into the task pane of an Outlook add-in}.
|
|
14395
|
+
*/
|
|
14396
|
+
interface DragoverEventData {
|
|
14397
|
+
/**
|
|
14398
|
+
* Gets the x-coordinate of the mouse pointer that represents the horizontal position in pixels.
|
|
14399
|
+
* The position is relative to the left edge of the Outlook on the web or the new Outlook on Windows client window.
|
|
14400
|
+
*
|
|
14401
|
+
* @remarks
|
|
14402
|
+
*
|
|
14403
|
+
* [Api set: Mailbox 1.5]
|
|
14404
|
+
*/
|
|
14405
|
+
pageX: number;
|
|
14406
|
+
/**
|
|
14407
|
+
* Gets the y-coordinate of the mouse pointer that represents the vertical position in pixels.
|
|
14408
|
+
* The position is relative to the top edge of the Outlook on the web or the new Outlook on Windows client window.
|
|
14409
|
+
*
|
|
14410
|
+
* @remarks
|
|
14411
|
+
*
|
|
14412
|
+
* [Api set: Mailbox 1.5]
|
|
14413
|
+
*/
|
|
14414
|
+
pageY: number;
|
|
14415
|
+
/**
|
|
14416
|
+
* Gets the type of drag-and-drop event. The `dragover` event occurs when messages or file attachments are dragged over an add-in's task pane.
|
|
14417
|
+
*
|
|
14418
|
+
* @remarks
|
|
14419
|
+
*
|
|
14420
|
+
* [Api set: Mailbox 1.5]
|
|
14421
|
+
*/
|
|
14422
|
+
type: "dragover";
|
|
14423
|
+
}
|
|
14424
|
+
/**
|
|
14425
|
+
* Represents the `DragAndDropEventArgs.dragAndDropEventData` object when messages or file attachments are dropped into an add-in's task pane.
|
|
14426
|
+
*
|
|
14427
|
+
* @remarks
|
|
14428
|
+
*
|
|
14429
|
+
* [Api set: Mailbox 1.5]
|
|
14430
|
+
*
|
|
14431
|
+
* To learn more about the drag-and-drop feature and how to implement it across various Outlook clients, see
|
|
14432
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/drag-drop-items | Drag and drop messages and attachments into the task pane of an Outlook add-in}.
|
|
14433
|
+
*/
|
|
14434
|
+
interface DropEventData {
|
|
14435
|
+
/**
|
|
14436
|
+
* Gets the messages or file attachments being dragged and dropped into an add-in's task pane.
|
|
14437
|
+
*
|
|
14438
|
+
* @remarks
|
|
14439
|
+
*
|
|
14440
|
+
* [Api set: Mailbox 1.5]
|
|
14441
|
+
*/
|
|
14442
|
+
dataTransfer: DroppedItems;
|
|
14443
|
+
/**
|
|
14444
|
+
* Gets the x-coordinate of the mouse pointer that represents the horizontal position in pixels.
|
|
14445
|
+
* The position is relative to the left edge of the Outlook on the web or the new Outlook on Windows client window.
|
|
14446
|
+
*
|
|
14447
|
+
* @remarks
|
|
14448
|
+
*
|
|
14449
|
+
* [Api set: Mailbox 1.5]
|
|
14450
|
+
*/
|
|
14451
|
+
pageX: number;
|
|
14452
|
+
/**
|
|
14453
|
+
* Gets the y-coordinate of the mouse pointer that represents the vertical position in pixels.
|
|
14454
|
+
* The position is relative to the top edge of the Outlook on the web or the new Outlook on Windows client window.
|
|
14455
|
+
* @remarks
|
|
14456
|
+
*
|
|
14457
|
+
* [Api set: Mailbox 1.5]
|
|
14458
|
+
*/
|
|
14459
|
+
pageY: number;
|
|
14460
|
+
/**
|
|
14461
|
+
* Gets the type of drag-and-drop event. The `drop` event occurs when messages or file attachments are dropped into an add-in's task pane.
|
|
14462
|
+
*
|
|
14463
|
+
* @remarks
|
|
14464
|
+
*
|
|
14465
|
+
* [Api set: Mailbox 1.5]
|
|
14466
|
+
*/
|
|
14467
|
+
type: "drop";
|
|
14468
|
+
}
|
|
14469
|
+
/**
|
|
14470
|
+
* Provides the messages or file attachments being dragged and dropped into an add-in's task pane.
|
|
14471
|
+
*
|
|
14472
|
+
* @remarks
|
|
14473
|
+
*
|
|
14474
|
+
* [Api set: Mailbox 1.5]
|
|
14475
|
+
*
|
|
14476
|
+
* To learn more about the drag-and-drop feature and how to implement it across various Outlook clients, see
|
|
14477
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/drag-drop-items | Drag and drop messages and attachments into the task pane of an Outlook add-in}.
|
|
14478
|
+
*/
|
|
14479
|
+
interface DroppedItems {
|
|
14480
|
+
/**
|
|
14481
|
+
* Gets an array of the messages or file attachments being dragged and dropped into an add-in's task pane.
|
|
14482
|
+
*
|
|
14483
|
+
* @remarks
|
|
14484
|
+
*
|
|
14485
|
+
* [Api set: Mailbox 1.5]
|
|
14486
|
+
*/
|
|
14487
|
+
files: DroppedItemDetails[]
|
|
14488
|
+
}
|
|
14489
|
+
/**
|
|
14490
|
+
* Provides the contents and details of the message or file attachment being dragged and dropped into an add-in's task pane.
|
|
14491
|
+
*
|
|
14492
|
+
* @remarks
|
|
14493
|
+
*
|
|
14494
|
+
* [Api set: Mailbox 1.5]
|
|
14495
|
+
*
|
|
14496
|
+
* To learn more about the drag-and-drop feature and how to implement it across various Outlook clients, see
|
|
14497
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/drag-drop-items | Drag and drop messages and attachments into the task pane of an Outlook add-in}.
|
|
14498
|
+
*/
|
|
14499
|
+
interface DroppedItemDetails {
|
|
14500
|
+
/**
|
|
14501
|
+
* Gets the contents of the file being dragged and dropped.
|
|
14502
|
+
*
|
|
14503
|
+
* @remarks
|
|
14504
|
+
*
|
|
14505
|
+
* [Api set: Mailbox 1.5]
|
|
14506
|
+
*
|
|
14507
|
+
* For guidance on how to retrieve data from a `Blob`, see the {@link https://developer.mozilla.org/docs/Web/API/Blob | File API documentation}.
|
|
14508
|
+
*/
|
|
14509
|
+
fileContent: Blob;
|
|
14510
|
+
/**
|
|
14511
|
+
* Gets the name of the file being dragged and dropped.
|
|
14512
|
+
*
|
|
14513
|
+
* @remarks
|
|
14514
|
+
*
|
|
14515
|
+
* [Api set: Mailbox 1.5]
|
|
14516
|
+
*/
|
|
14517
|
+
name: string;
|
|
14518
|
+
/**
|
|
14519
|
+
* Gets the type of the file being dragged and dropped.
|
|
14520
|
+
*
|
|
14521
|
+
* @remarks
|
|
14522
|
+
*
|
|
14523
|
+
* [Api set: Mailbox 1.5]
|
|
14524
|
+
*
|
|
14525
|
+
* **Important**: When a message is dragged into an add-in's task pane, it's dropped as a .eml file.
|
|
14526
|
+
*/
|
|
14527
|
+
type: string;
|
|
14528
|
+
}
|
|
14345
14529
|
/**
|
|
14346
14530
|
* Provides the email properties of the sender or specified recipients of an email message or appointment.
|
|
14347
14531
|
*
|
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.522",
|
|
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": "
|
|
49
|
+
"typesPublisherContentHash": "ac86e1a00cfbc9eef00d3634bbcc25a3f71a092942d875d5469715c5c8d70726",
|
|
50
50
|
"typeScriptVersion": "5.2"
|
|
51
51
|
}
|