@types/office-js-preview 1.0.306 → 1.0.309
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-preview/README.md +1 -1
- office-js-preview/index.d.ts +18 -15
- office-js-preview/package.json +2 -2
office-js-preview/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-preview.
|
|
9
9
|
|
|
10
10
|
### Additional Details
|
|
11
|
-
* Last updated:
|
|
11
|
+
* Last updated: Wed, 01 Jun 2022 18:31:31 GMT
|
|
12
12
|
* Dependencies: none
|
|
13
13
|
* Global values: `Excel`, `Office`, `OfficeCore`, `OfficeExtension`, `OneNote`, `PowerPoint`, `Visio`, `Word`
|
|
14
14
|
|
office-js-preview/index.d.ts
CHANGED
|
@@ -537,9 +537,6 @@ declare namespace Office {
|
|
|
537
537
|
}
|
|
538
538
|
/**
|
|
539
539
|
* Manages actions and keyboard shortcuts.
|
|
540
|
-
*
|
|
541
|
-
* @remarks
|
|
542
|
-
* **Requirement set**: {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/shared-runtime-requirement-sets | SharedRuntime 1.1}
|
|
543
540
|
*/
|
|
544
541
|
interface Actions {
|
|
545
542
|
/**
|
|
@@ -547,9 +544,6 @@ declare namespace Office {
|
|
|
547
544
|
*
|
|
548
545
|
* @param actionId The ID of an action that is defined in an extended manifest or the name of the function as specified in a **FunctionName** element in the manifest.
|
|
549
546
|
* @param actionFunction The function that is run when the action is invoked.
|
|
550
|
-
*
|
|
551
|
-
* @remarks
|
|
552
|
-
* **Requirement set**: {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/shared-runtime-requirement-sets | SharedRuntime 1.1}
|
|
553
547
|
*/
|
|
554
548
|
associate: (actionId: string, actionFunction: (arg?: any) => void) => void;
|
|
555
549
|
/**
|
|
@@ -557,8 +551,11 @@ declare namespace Office {
|
|
|
557
551
|
*
|
|
558
552
|
* @remarks
|
|
559
553
|
*
|
|
560
|
-
* **Requirement
|
|
561
|
-
*
|
|
554
|
+
* **Requirement sets**:
|
|
555
|
+
*
|
|
556
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/keyboard-shortcuts-requirement-sets | KeyboardShortcuts 1.1}
|
|
557
|
+
*
|
|
558
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/shared-runtime-requirement-sets | SharedRuntime 1.1}
|
|
562
559
|
*
|
|
563
560
|
* @param shortcuts An object of custom shortcuts with keys being the IDs of the actions (as defined in an extended manifest) and values being the shortcut combinations. For example, `{"SetItalic": "Ctrl+1", "SetBold": "Ctrl+2"}`.
|
|
564
561
|
* To learn how to specify a valid action ID and a key combination, see {@link https://docs.microsoft.com/office/dev/add-ins/design/keyboard-shortcuts | Add custom keyboard shortcuts to your Office Add-ins}. (Note that a key combination can be `null`, in which case, the action keeps the key combination specified in the JSON file.)
|
|
@@ -572,8 +569,11 @@ declare namespace Office {
|
|
|
572
569
|
*
|
|
573
570
|
* @remarks
|
|
574
571
|
*
|
|
575
|
-
* **Requirement
|
|
576
|
-
*
|
|
572
|
+
* **Requirement sets**:
|
|
573
|
+
*
|
|
574
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/keyboard-shortcuts-requirement-sets | KeyboardShortcuts 1.1}
|
|
575
|
+
*
|
|
576
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/shared-runtime-requirement-sets | SharedRuntime 1.1}
|
|
577
577
|
*
|
|
578
578
|
* @returns A promise that resolves to an object of shortcuts, with keys being the IDs of the actions (as defined in an extended manifest) and values being the shortcut combinations. For example, `{"SetItalic": "Ctrl+1", "SetBold": "Ctrl+2", "SetUnderline": null}`.
|
|
579
579
|
*/
|
|
@@ -583,10 +583,13 @@ declare namespace Office {
|
|
|
583
583
|
*
|
|
584
584
|
* @remarks
|
|
585
585
|
*
|
|
586
|
-
* **Requirement
|
|
587
|
-
*
|
|
586
|
+
* **Requirement sets**:
|
|
587
|
+
*
|
|
588
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/keyboard-shortcuts-requirement-sets | KeyboardShortcuts 1.1}
|
|
589
|
+
*
|
|
590
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/shared-runtime-requirement-sets | SharedRuntime 1.1}
|
|
588
591
|
*
|
|
589
|
-
* @param shortcuts An array of shortcut combinations. For example, `["Ctrl+1", "Ctrl+2"]`.
|
|
592
|
+
* @param shortcuts An array of shortcut combinations. For example, `["Ctrl+1", "Ctrl+2"]`.
|
|
590
593
|
* @returns A promise that resolves to an array of objects. Each object consists of a shortcut combination and Boolean value. The value is `true` if the shortcut combination conflicts with a shortcut of another add-in or with a shortcut of the Office application; otherwise, `false`. For example, `[{shortcut:"Ctrl+1", inUse:true},{shortcut:"Ctrl+2", inUse:false}]`.
|
|
591
594
|
*/
|
|
592
595
|
areShortcutsInUse(shortcuts: string[]): Promise<{shortcut: string, inUse: boolean}[]>;
|
|
@@ -17508,7 +17511,7 @@ declare namespace Office {
|
|
|
17508
17511
|
* **Important**: In Outlook on the web, if a user created a new message by activating a contact's email address link from their contact or
|
|
17509
17512
|
* profile card, your add-in's `getAsync` call currently won't return a value in the `displayName` property of the
|
|
17510
17513
|
* associated `EmailAddressDetails` object. For more details, refer to the
|
|
17511
|
-
* {@link https://github.com/OfficeDev/office-js
|
|
17514
|
+
* {@link https://github.com/OfficeDev/office-js/issues/2201 | related GitHub issue}.
|
|
17512
17515
|
*
|
|
17513
17516
|
* @remarks
|
|
17514
17517
|
* [Api set: Mailbox 1.1]
|
|
@@ -17536,7 +17539,7 @@ declare namespace Office {
|
|
|
17536
17539
|
* **Important**: In Outlook on the web, if a user created a new message by activating a contact's email address link from their contact or
|
|
17537
17540
|
* profile card, your add-in's `getAsync` call currently won't return a value in the `displayName` property of the
|
|
17538
17541
|
* associated `EmailAddressDetails` object. For more details, refer to the
|
|
17539
|
-
* {@link https://github.com/OfficeDev/office-js
|
|
17542
|
+
* {@link https://github.com/OfficeDev/office-js/issues/2201 | related GitHub issue}.
|
|
17540
17543
|
*
|
|
17541
17544
|
* @remarks
|
|
17542
17545
|
* [Api set: Mailbox 1.1]
|
office-js-preview/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@types/office-js-preview",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.309",
|
|
4
4
|
"description": "TypeScript definitions for Office.js",
|
|
5
5
|
"homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-js-preview",
|
|
6
6
|
"license": "MIT",
|
|
@@ -45,6 +45,6 @@
|
|
|
45
45
|
},
|
|
46
46
|
"scripts": {},
|
|
47
47
|
"dependencies": {},
|
|
48
|
-
"typesPublisherContentHash": "
|
|
48
|
+
"typesPublisherContentHash": "931fa5490b8528c078e76ffa6b5d2de65e4f83c101f1733a6d8372d9d515d3ad",
|
|
49
49
|
"typeScriptVersion": "3.9"
|
|
50
50
|
}
|