@types/office-js-preview 1.0.284 → 1.0.287

office-js-preview/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-preview.
 
 ### Additional Details
- * Last updated: Tue, 01 Feb 2022 17:01:29 GMT
+ * Last updated: Thu, 03 Mar 2022 19:31:43 GMT
  * Dependencies: none
  * Global values: `Excel`, `Office`, `OfficeCore`, `OfficeExtension`, `OneNote`, `PowerPoint`, `Visio`, `Word`
 

office-js-preview/index.d.ts

@@ -531,6 +531,9 @@ declare namespace Office {
     }
     /**
      * Manages actions and keyboard shortcuts.
+     * 
+     * @remarks
+     * **Requirement set**: {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/shared-runtime-requirement-sets | SharedRuntime 1.1}
      */
     interface Actions {
         /**
@@ -538,6 +541,9 @@ declare namespace Office {
          * 
          * @param actionId The ID of an action that is defined in an extended manifest.
          * @param actionFunction The function that is run when the action is invoked. 
+         * 
+         * @remarks
+         * **Requirement set**: {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/shared-runtime-requirement-sets | SharedRuntime 1.1}
          */
         associate: (actionId: string, actionFunction: (arg?: any) => void) => void;
         /**
@@ -545,7 +551,7 @@ declare namespace Office {
          *
          * @remarks
          *
-         * **Requirement set**: KeyboardShortcuts 1.1
+         * **Requirement set**: {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/keyboard-shortcuts-requirement-sets | KeyboardShortcuts 1.1}
          * @beta
          * 
          * @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"}`.
@@ -560,7 +566,7 @@ declare namespace Office {
          *
          * @remarks
          *
-         * **Requirement set**: KeyboardShortcuts 1.1
+         * **Requirement set**: {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/keyboard-shortcuts-requirement-sets | KeyboardShortcuts 1.1}
          * @beta
          * 
          * @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}`.
@@ -571,7 +577,7 @@ declare namespace Office {
          *
          * @remarks
          *
-         * **Requirement set**: KeyboardShortcuts 1.1
+         * **Requirement set**: {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/keyboard-shortcuts-requirement-sets | KeyboardShortcuts 1.1}
          * @beta
          * 
          * @param shortcuts An array of shortcut combinations. For example, `["Ctrl+1", "Ctrl+2"]`.
@@ -590,31 +596,50 @@ declare namespace Office {
     }
     /**
      * Represents add-in level functionality for operating or configuring various aspects of the add-in.
+     * 
+     * @remarks
+     *
+     * **Requirement set**: {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/shared-runtime-requirement-sets | SharedRuntime 1.1}
      */
     interface Addin {
         /**
          * Sets the startup behavior for the add-in for when the document is opened next time.
          * @param behavior - Specifies startup behavior of the add-in.
+         * 
+         * @remarks
+         * **Requirement set**: {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/shared-runtime-requirement-sets | SharedRuntime 1.1}
          */
         setStartupBehavior(behavior: Office.StartupBehavior): Promise<void>;
         /**
          * Gets the current startup behavior for the add-in.
+         * 
+         * @remarks
+         * **Requirement set**: {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/shared-runtime-requirement-sets | SharedRuntime 1.1}
          */
         getStartupBehavior(): Promise<Office.StartupBehavior>;
         /**
          * Shows the task pane associated with the add-in.
          * @returns A promise that is resolved when the UI is shown.
+         * 
+         * @remarks
+         * **Requirement set**: {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/shared-runtime-requirement-sets | SharedRuntime 1.1}
          */
         showAsTaskpane(): Promise<void>;
         /**
          * Hides the task pane.
          * @returns A promise that is resolved when the UI is hidden.
+         * 
+         * @remarks
+         * **Requirement set**: {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/shared-runtime-requirement-sets | SharedRuntime 1.1}
          */
         hide(): Promise<void>;
         /**
          * Adds a handler for the `onVisibilityModeChanged` event.
          * @param handler - The handler function that is called when the event is emitted. This function takes in a message for the receiving component.
          * @returns A promise that resolves to a function when the handler is added. Calling it removes the handler.
+         * 
+         * @remarks
+         * **Requirement set**: {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/shared-runtime-requirement-sets | SharedRuntime 1.1}
          */
         onVisibilityModeChanged(
             handler: (message: VisibilityModeChangedMessage) => void,
@@ -678,7 +703,7 @@ declare namespace Office {
      *
      * @remarks
      *
-     * **Requirement set**: Ribbon 1.1
+     * **Requirement set**: {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/ribbon-api-requirement-sets | RibbonApi 1.1}
      */
     interface Ribbon {
         /**
@@ -686,7 +711,7 @@ declare namespace Office {
          *
          * @remarks
          *
-         * **Requirement set**: Ribbon 1.2
+         * **Requirement set**: {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/ribbon-api-requirement-sets | RibbonApi 1.2}
          * 
          * This method only requests that the tab be registered. The actual registration is controlled by the Office application and may not be complete when the returned `Promise` object is resolved.
          * For more information and code examples, see {@link https://docs.microsoft.com/office/dev/add-ins/design/contextual-tabs | Create custom contextual tabs}.
@@ -699,7 +724,7 @@ declare namespace Office {
          *
          * @remarks
          *
-         * **Requirement set**: Ribbon 1.1
+         * **Requirement set**: {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/ribbon-api-requirement-sets | RibbonApi 1.1}
          *
          * Note that this API is only to request an update. The actual UI update to the ribbon is controlled by the Office application and hence the exact timing of the ribbon update (or refresh) cannot be determined by the completion of this API.
          * 
@@ -714,7 +739,7 @@ declare namespace Office {
      *
      * @remarks
      *
-     * **Requirement set**: Ribbon 1.1
+     * **Requirement set**: {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/ribbon-api-requirement-sets | RibbonApi 1.1}
      */
     interface RibbonUpdaterData {
         /**
@@ -727,7 +752,7 @@ declare namespace Office {
      *
      * @remarks
      *
-     * **Requirement set**: Ribbon 1.1
+     * **Requirement set**: {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/ribbon-api-requirement-sets | RibbonApi 1.1}
      */
     interface Tab {
         /**
@@ -747,7 +772,7 @@ declare namespace Office {
          * 
          * @remarks
          *
-         * **Requirement set**: Ribbon 1.2
+         * **Requirement set**: {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/ribbon-api-requirement-sets | RibbonApi 1.2}
          */
         visible?: boolean;
         /**
@@ -757,14 +782,14 @@ declare namespace Office {
          * 
          * When the `Tab` object is part of an {@link Office.RibbonUpdaterData} object passed to the `requestUpdate` method of {@link Office.Ribbon}, the `controls` properties of the various {@link Office.Group} objects specify which controls have their enabled status changed; the `controls` property of the `Tab` object is ignored. 
          *
-         * **Requirement set**: Ribbon 1.1
+         * **Requirement set**: {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/ribbon-api-requirement-sets | RibbonApi 1.1}
          */
         groups?: Group[];
     }
     /**
      * Represents a group of controls on a ribbon tab.
      *
-     * **Requirement set**: Ribbon 1.1
+     * **Requirement set**: {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/ribbon-api-requirement-sets | RibbonApi 1.1}
      */
     interface Group {
         /**
@@ -788,7 +813,7 @@ declare namespace Office {
      *
      * @remarks
      *
-     * **Requirement set**: Ribbon 1.1
+     * **Requirement set**: {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/ribbon-api-requirement-sets | RibbonApi 1.1}
      */
     interface Control {
         /**
@@ -1427,7 +1452,7 @@ declare namespace Office {
          *
          * **Hosts**: Excel, OneNote, Outlook, PowerPoint, Word
          *
-         * **Requirement set**: {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/identity-api-requirement-sets | IdentityAPI}
+         * **Requirement set**: {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/identity-api-requirement-sets | IdentityAPI 1.3}
          *
          * This API requires a single sign-on configuration that bridges the add-in to an Azure application. Office users sign in with Organizational
          * Accounts and Microsoft Accounts. Microsoft Azure returns tokens intended for both user account types to access resources in the Microsoft Graph.
@@ -1452,7 +1477,7 @@ declare namespace Office {
          *
          * **Hosts**: Excel, OneNote, Outlook, PowerPoint, Word
          *
-         * **Requirement set**: {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/identity-api-requirement-sets | IdentityAPI}
+         * **Requirement set**: {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/identity-api-requirement-sets | IdentityAPI 1.3}
          *
          * This API requires a single sign-on configuration that bridges the add-in to an Azure application. Office users sign in with Organizational
          * Accounts and Microsoft Accounts. Microsoft Azure returns tokens intended for both user account types to access resources in the Microsoft Graph.
@@ -1474,7 +1499,7 @@ declare namespace Office {
          * 
          * **Important**: In Outlook, this API is not supported if the add-in is loaded in an Outlook.com or Gmail mailbox. 
          *
-         * **Requirement set**: {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/identity-api-requirement-sets | IdentityAPI}
+         * **Requirement set**: {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/identity-api-requirement-sets | IdentityAPI 1.3}
          *
          * @param options - Optional. Accepts an `AuthOptions` object to define sign-on behaviors.
          * @returns Promise to the access token.
@@ -2164,7 +2189,7 @@ declare namespace Office {
      */
     enum EventType {
         /**
-         * A Document.ActiveViewChanged event was raised.
+         * A Document.ActiveViewChanged event was raised in PowerPoint.
          *
          * @remarks
          *
@@ -2340,9 +2365,13 @@ declare namespace Office {
          */
         Text,
         /**
-         * Returns the entire document (.pptx, .docx, or .xlsx) in Office Open XML (OOXML) format as a byte array.
+         * Returns the entire document (.pptx, .docx, .xlsx, or .xlsm) in Office Open XML (OOXML) format as a byte array.
+         * 
+         * Note: The .xslm file type is supported in Excel on Windows and Mac. It's not supported in Excel on the web.
+         * In Excel on Windows, the file slices from the `getFileAsync` method include the VBA signature files for .xslm file types. The VBA signature files are vbaProjectSignature.bin, vbaProbjectSignatureAgile.bin, and vbaProjectSignatureV3.bin. 
+         * In Excel on Mac, the file slices from the `getFileAsync` method don't include the VBA signature files, because this platform doesn't support the VBA signature feature.
          */
-        Compressed,
+         Compressed,
         /**
          * Returns the entire document in PDF format as a byte array.
          */
@@ -3900,8 +3929,8 @@ declare namespace Office {
          * @param options Provides an option for preserving context data of any type, unchanged, for use in a callback.
          * @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}.
          *                  The `value` property of the result is the state of the presentation's current view.
-         *                  The value returned can be either "edit" or "read". "edit" corresponds to any of the views in which you can edit slides,
-         *                  such as Normal or Outline View. "read" corresponds to either Slide Show or Reading View.
+         *                  The value returned can be either "edit" or "read". "edit" corresponds to any of the views in which you can edit slides:
+         *                  Normal, Slide Sorter, or Outline View. "read" corresponds to either Slide Show or Reading View.
          */
         getActiveViewAsync(options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<"edit" | "read">) => void): void;
         /**
@@ -3915,8 +3944,8 @@ declare namespace Office {
          *
          * @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}.
          *                  The `value` property of the result is the state of the presentation's current view.
-         *                  The value returned can be either "edit" or "read". "edit" corresponds to any of the views in which you can edit slides,
-         *                  such as Normal or Outline View. "read" corresponds to either Slide Show or Reading View.
+         *                  The value returned can be either "edit" or "read". "edit" corresponds to any of the views in which you can edit slides:
+         *                  Normal, Slide Sorter, or Outline View. "read" corresponds to either Slide Show or Reading View.
          */
         getActiveViewAsync(callback?: (result: AsyncResult<"edit" | "read">) => void): void;
         /**
@@ -4092,7 +4121,7 @@ declare namespace Office {
          *     <td>`Office.CoercionType.SlideRange`</td>
          *   </tr>
          *   <tr>
-         *     <td>Excel, PowerPoint, and Word</td>
+         *     <td>Excel on Windows and Mac, PowerPoint on Windows, Mac, and the web, and Word on Windows and Mac</td>
          *     <td>`Office.CoercionType.XmlSvg`</td>
          *   </tr>
          * </table>
@@ -4184,7 +4213,7 @@ declare namespace Office {
          *     <td>`Office.CoercionType.SlideRange`</td>
          *   </tr>
          *   <tr>
-         *     <td>Excel, PowerPoint, and Word</td>
+         *     <td>Excel on Windows and Mac, PowerPoint on Windows, Mac, and the web, and Word on Windows and Mac</td>
          *     <td>`Office.CoercionType.XmlSvg`</td>
          *   </tr>
          * </table>
@@ -4424,7 +4453,7 @@ declare namespace Office {
          *     <td>`Office.CoercionType.SlideRange`</td>
          *   </tr>
          *   <tr>
-         *     <td>Excel, PowerPoint, and Word</td>
+         *     <td>Excel on Windows and Mac, PowerPoint on Windows, Mac, and the web, and Word on Windows and Mac</td>
          *     <td>`Office.CoercionType.XmlSvg`</td>
          *   </tr>
          * </table>
@@ -4613,7 +4642,7 @@ declare namespace Office {
          *     <td>`Office.CoercionType.SlideRange`</td>
          *   </tr>
          *   <tr>
-         *     <td>Excel, PowerPoint, and Word</td>
+         *     <td>Excel on Windows and Mac, PowerPoint on Windows, Mac, and the web, and Word on Windows and Mac</td>
          *     <td>`Office.CoercionType.XmlSvg`</td>
          *   </tr>
          * </table>

office-js-preview/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@types/office-js-preview",
-    "version": "1.0.284",
+    "version": "1.0.287",
     "description": "TypeScript definitions for Office.js",
     "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-js-preview",
     "license": "MIT",
@@ -45,6 +45,6 @@
     },
     "scripts": {},
     "dependencies": {},
-    "typesPublisherContentHash": "400270bbef643c7f44aa8d7d78eff8d8366b87561df3ac53b30b58a7be75f518",
-    "typeScriptVersion": "3.8"
+    "typesPublisherContentHash": "bea7806ad001f2aa21fc4dccfa6af3405eb146cbe420204dc9a34832a061ef3d",
+    "typeScriptVersion": "3.9"
 }