@types/office-js 1.0.256 → 1.0.259

office-js/README.md

@@ -8,7 +8,7 @@ This package contains type definitions for Office.js (https://github.com/OfficeD
 Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-js.
 
 ### Additional Details
- * Last updated: Fri, 20 May 2022 21:01:43 GMT
+ * Last updated: Tue, 07 Jun 2022 18:31:33 GMT
  * Dependencies: none
  * Global values: `Excel`, `Office`, `OfficeCore`, `OfficeExtension`, `OneNote`, `PowerPoint`, `Visio`, `Word`
 

office-js/index.d.ts

@@ -546,6 +546,53 @@ declare namespace Office {
          * @param actionFunction The function that is run when the action is invoked. 
          */
         associate: (actionId: string, actionFunction: (arg?: any) => void) => void;
+        /**
+         * Replaces existing add-in shortcuts with custom shortcuts for the user.
+         *
+         * @remarks
+         *
+         * **Requirement sets**:
+         * 
+         * - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/keyboard-shortcuts-requirement-sets | KeyboardShortcuts 1.1}
+         * 
+         * - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/shared-runtime-requirement-sets | SharedRuntime 1.1}
+         * 
+         * @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"}`.
+         * 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.)
+         * @returns A promise that resolves when every custom shortcut assignment in `shortcuts` has been registered. Even if there is a conflict with existing shortcuts, the customized shortcut will be registered.
+         * Otherwise, the promise will be rejected with error code and error message. An "InvalidOperation" error code is returned if any action ID in `shortcuts` does not exist, or if shortcut combination is invalid.
+         */
+         replaceShortcuts(shortcuts: {[actionId: string]: string}): Promise<void>;   
+         /**
+          * Gets the existing shortcuts for the add-in. The set always includes (1) the shortcuts defined in the add-in's extended manifest for keyboard shortcuts and (2) the current user's custom shortcuts if those exist.
+          * The shortcut can be `null` if it conflicts with the shortcut of another add-in or with the Office application. Specifically, it would be `null` if, when prompted to choose which shortcut to use, the user didn't choose the action of the current add-in. For more information about conflicts with shortcuts, see  {@link https://docs.microsoft.com/office/dev/add-ins/design/keyboard-shortcuts#avoid-key-combinations-in-use-by-other-add-ins | Avoid key combinations in use by other add-ins}.
+          *
+          * @remarks
+          *
+          * **Requirement sets**:
+          * 
+          * - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/keyboard-shortcuts-requirement-sets | KeyboardShortcuts 1.1}
+          * 
+          * - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/shared-runtime-requirement-sets | SharedRuntime 1.1}
+          * 
+          * @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}`.
+          */
+         getShortcuts(): Promise<{[actionId: string]: string|null}>;   
+         /**
+          * Checks if a set of shortcut combinations are currently in use for the user, as defined by another add-in or by the host Office application.
+          *
+          * @remarks
+          *
+          * **Requirement sets**:
+          * 
+          * - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/keyboard-shortcuts-requirement-sets | KeyboardShortcuts 1.1}
+          * 
+          * - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/shared-runtime-requirement-sets | SharedRuntime 1.1}
+          * 
+          * @param shortcuts An array of shortcut combinations. For example, `["Ctrl+1", "Ctrl+2"]`. 
+          * @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}]`.
+          */
+         areShortcutsInUse(shortcuts: string[]): Promise<{shortcut: string, inUse: boolean}[]>;
     }
 	/**
      * Message used in the `onVisibilityModeChanged` invocation.
@@ -16826,7 +16873,7 @@ declare namespace Office {
          * **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
          * profile card, your add-in's `getAsync` call currently won't return a value in the `displayName` property of the
          * associated `EmailAddressDetails` object. For more details, refer to the
-         * {@link https://github.com/OfficeDev/office-js-docs-pr/issues/2962 | related GitHub issue}.
+         * {@link https://github.com/OfficeDev/office-js/issues/2201 | related GitHub issue}.
          *
          * @remarks
          * [Api set: Mailbox 1.1]
@@ -16854,7 +16901,7 @@ declare namespace Office {
          * **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
          * profile card, your add-in's `getAsync` call currently won't return a value in the `displayName` property of the
          * associated `EmailAddressDetails` object. For more details, refer to the
-         * {@link https://github.com/OfficeDev/office-js-docs-pr/issues/2962 | related GitHub issue}.
+         * {@link https://github.com/OfficeDev/office-js/issues/2201 | related GitHub issue}.
          *
          * @remarks
          * [Api set: Mailbox 1.1]
@@ -18353,17 +18400,17 @@ declare namespace OfficeExtension {
     const Promise: Office.IPromiseConstructor;
     type IPromise<T> = Promise<T>;
 
-    /** Collection of tracked objects, contained within a request context. See "context.trackedObjects" for more information. */
+    /**
+     * Collection of tracked objects, contained within a request context.
+     * See {@link https://docs.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects}
+     * for more information.
+     */
     class TrackedObjects {
         /** 
          * Track a new object for automatic adjustment based on surrounding changes in the document. Only some object types require this. 
          * If you are using an object across ".sync" calls and outside the sequential execution of a ".run" batch, 
          * and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you needed to have added the object 
          * to the tracked object collection when the object was first created. 
-         * 
-         * This method also has the following signature: 
-         * 
-         * `add(objects: ClientObject[]): void;` Where objects is an array of objects to be tracked.
          */
         add(object: ClientObject): void;
         /**
@@ -18377,10 +18424,6 @@ declare namespace OfficeExtension {
          * Release the memory associated with an object that was previously added to this collection. 
          * Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. 
          * You will need to call `context.sync()` before the memory release takes effect.
-         * 
-         * This method also has the following signature: 
-         * 
-         * `remove(objects: ClientObject[]): void;` Where objects is an array of objects to be removed.
          */
         remove(object: ClientObject): void;
         /**

office-js/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@types/office-js",
-    "version": "1.0.256",
+    "version": "1.0.259",
     "description": "TypeScript definitions for Office.js",
     "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-js",
     "license": "MIT",
@@ -45,6 +45,6 @@
     },
     "scripts": {},
     "dependencies": {},
-    "typesPublisherContentHash": "f128a0a38eefbfdc81f6ef75e1d4996dd2aea6e4617893ecbacb5276d05d69d2",
+    "typesPublisherContentHash": "002bef8261aa095a639006649d8b878116411db7ba60955ac573ab1416c85a4f",
     "typeScriptVersion": "3.9"
 }