@types/office-runtime 1.0.23 → 1.0.26

office-runtime/README.md

@@ -8,7 +8,7 @@ This package contains type definitions for office-runtime (https://github.com/Of
 Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-runtime.
 
 ### Additional Details
- * Last updated: Fri, 05 Nov 2021 22:31:34 GMT
+ * Last updated: Thu, 08 Sep 2022 20:32:46 GMT
  * Dependencies: none
  * Global values: `OfficeRuntime`
 

office-runtime/index.d.ts

@@ -18,9 +18,10 @@ Copyright (c) Microsoft Corporation
  */
 declare namespace OfficeRuntime {
   /**
-   * Method that enables a pop up web dialog box.
+   * Function that enables a pop up web dialog box.
    *
-   * [Api set: SharedRuntime 1.1]
+   * @remarks
+   * [Api set: CustomFunctionsRuntime 1.1]
    *
    * @param url Must be a string.
    * @param options Optional parameter. Must be of type DisplayWebDialogOptions.
@@ -133,23 +134,37 @@ declare namespace OfficeRuntime {
      */
     getKeys(): Promise<string[]>;
   }
-  /** Object representing the dialog box. */
+  /**
+   * Object representing the dialog box.
+   *
+   * @remarks
+   * [Api set: CustomFunctionsRuntime 1.1]
+   *
+   */
   interface Dialog {
     /**
      * Method to close a dialog box. Returns a Promise.
      *
-     * [Api set: SharedRuntime 1.1]
+     * @remarks
+     * [Api set: CustomFunctionsRuntime 1.1]
      *
      */
     close(): Promise<void>;
   }
-  /** Provides display options and actions a dialog box may take. */
+  /**
+   * Provides display options and actions a dialog box may take.
+   *
+   * @remarks
+   * [Api set: CustomFunctionsRuntime 1.1]
+   *
+   */
   interface DisplayWebDialogOptions {
     /**
      * Optional parameter that determines whether the dialog box displays as a popup (false) or within an IFrame (true).
      * This setting is only applicable to custom functions running on Excel Online.
      *
-     * [Api set: SharedRuntime 1.1]
+     * @remarks
+     * [Api set: CustomFunctionsRuntime 1.1]
      *
      */
     displayInIFrame?: boolean;
@@ -157,7 +172,8 @@ declare namespace OfficeRuntime {
      * Optional parameter that defines the height of the dialog box as a percentage of the current display.
      * For example, accepts strings such as: '50%', '50'.
      *
-     * [Api set: SharedRuntime 1.1]
+     * @remarks
+     * [Api set: CustomFunctionsRuntime 1.1]
      *
      */
     height?: string;
@@ -165,28 +181,32 @@ declare namespace OfficeRuntime {
      * Optional parameter that defines the width of dialog as a percentage of window.
      * For example, accepts strings such as: '50%', '50'.
      *
-     * [Api set: SharedRuntime 1.1]
+     * @remarks
+     * [Api set: CustomFunctionsRuntime 1.1]
      *
      */
     width?: string;
     /**
      * Optional callback that runs when the dialog box sends a message to its parent.
      *
-     * [Api set: SharedRuntime 1.1]
+     * @remarks
+     * [Api set: CustomFunctionsRuntime 1.1]
      *
      */
     onMessage?: (message: string, dialog?: Dialog) => void;
     /**
      * Optional callback that runs when the dialog box is closed.
      *
-     * [Api set: SharedRuntime 1.1]
+     * @remarks
+     * [Api set: CustomFunctionsRuntime 1.1]
      *
      */
     onClose?: () => void;
     /**
      * Optional callback that runs when the dialog box sends an error.
      *
-     * [Api set: SharedRuntime 1.1]
+     * @remarks
+     * [Api set: CustomFunctionsRuntime 1.1]
      *
      */
     onRuntimeError?: (error: Error, dialog?: Dialog) => void;
@@ -255,7 +275,7 @@ declare namespace OfficeRuntime {
    *
    * @remarks
    *
-   * The methods in this interface are equivalent to those in the `Office.auth` interface.
+   * The methods in this interface are equivalent to those in the {@link https://docs.microsoft.com/javascript/api/office/office.auth | Office.auth interface}.
    * If new authentication types are added in the future, they will only be added to the `Office.auth` interface.
    * For simplicity, the code examples throughout the documentation use `Office.auth`.
    */
@@ -267,7 +287,7 @@ declare namespace OfficeRuntime {
      * 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.
      *
-     * **Important**: In Outlook, this API is not supported if the add-in is loaded in an Outlook.com or Gmail mailbox.
+     * **Important**: In Outlook, this API isn't supported if the add-in is loaded in an Outlook.com or Gmail mailbox.
      *
      * @remarks
      *
@@ -283,7 +303,7 @@ declare namespace OfficeRuntime {
    */
   const apiInformation: ApiInformation;
   /**
-   * Interface that contains functions for checking API requirement-set support.
+   * Interface that contains methods for checking API requirement-set support.
    */
   interface ApiInformation {
     /**

office-runtime/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@types/office-runtime",
-    "version": "1.0.23",
+    "version": "1.0.26",
     "description": "TypeScript definitions for office-runtime",
     "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-runtime",
     "license": "MIT",
@@ -40,6 +40,6 @@
     },
     "scripts": {},
     "dependencies": {},
-    "typesPublisherContentHash": "c06f800870854a6de920aee4a8cad24e241d5a301e284b166484f0fbdae8357f",
-    "typeScriptVersion": "3.7"
+    "typesPublisherContentHash": "792f2ed71875e61e1d93e9a38f216e7d0cdd30c8a3f550d5afb7bf97573802dd",
+    "typeScriptVersion": "4.1"
 }