@types/office-runtime 1.0.19 → 1.0.23

office-runtime/README.md

@@ -8,9 +8,9 @@ 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: Thu, 08 Jul 2021 18:51:45 GMT
+ * Last updated: Fri, 05 Nov 2021 22:31:34 GMT
  * Dependencies: none
  * Global values: `OfficeRuntime`
 
 # Credits
-These definitions were written by [OfficeDev](https://github.com/OfficeDev), [Michelle Scharlock](https://github.com/mscharlock), [David Chesnut](https://github.com/davidchesnut), [Alex Jerabek](https://github.com/AlexJerabek), [Ricky Kirkham](https://github.com/rick-kirkham), and [Alison McKay](https://github.com/alison-mk).
+These definitions were written by [OfficeDev](https://github.com/OfficeDev), [David Chesnut](https://github.com/davidchesnut), [Alex Jerabek](https://github.com/AlexJerabek), [Ricky Kirkham](https://github.com/rick-kirkham), and [Alison McKay](https://github.com/alison-mk).

office-runtime/index.d.ts

@@ -1,7 +1,6 @@
 // Type definitions for non-npm package office-runtime 1.0
 // Project: https://github.com/OfficeDev/office-js
 // Definitions by: OfficeDev <https://github.com/OfficeDev>,
-//                 Michelle Scharlock <https://github.com/mscharlock>,
 //                 David Chesnut <https://github.com/davidchesnut>,
 //                 Alex Jerabek <https://github.com/AlexJerabek>,
 //                 Ricky Kirkham <https://github.com/rick-kirkham>,
@@ -34,9 +33,12 @@ declare namespace OfficeRuntime {
   /**
    * Asynchronous, global, and persistent key-value storage.
    *
-   * [Api set: SharedRuntime 1.1]
-   *
    * @remarks
+   * [Api set: SharedRuntime 1.1, Mailbox 1.10]
+   *
+   * **Important**: In Outlook, support is only available with
+   * {@link https://docs.microsoft.com/office/dev/add-ins/outlook/autolaunch | event-based activation}.
+   *
    * Storage limit is 10 MB per domain, which may be shared by multiple add-ins.
    */
   interface Storage {
@@ -44,7 +46,11 @@ declare namespace OfficeRuntime {
      * Retrieves an item from storage based on its key.
      * Returns a Promise. In the event the Promise does not resolve, returns null.
      *
-     * [Api set: SharedRuntime 1.1]
+     * @remarks
+     * [Api set: SharedRuntime 1.1, Mailbox 1.10]
+     *
+     * **Important**: In Outlook, support is only available with
+     * {@link https://docs.microsoft.com/office/dev/add-ins/outlook/autolaunch | event-based activation}.
      *
      * @param key Key of item to be retrieved. Must be a string.
      */
@@ -53,7 +59,11 @@ declare namespace OfficeRuntime {
      * Sets a key-value pair into storage or updates an existing key-value pair.
      * Returns a Promise.
      *
-     * [Api set: SharedRuntime 1.1]
+     * @remarks
+     * [Api set: SharedRuntime 1.1, Mailbox 1.10]
+     *
+     * **Important**: In Outlook, support is only available with
+     * {@link https://docs.microsoft.com/office/dev/add-ins/outlook/autolaunch | event-based activation}.
      *
      * @param key Key of item to be set. Must be a string.
      * @param value Must be a string.
@@ -63,7 +73,11 @@ declare namespace OfficeRuntime {
      * Removes an item from storage based on its key.
      * Returns a Promise.
      *
-     * [Api set: SharedRuntime 1.1]
+     * @remarks
+     * [Api set: SharedRuntime 1.1, Mailbox 1.10]
+     *
+     * **Important**: In Outlook, support is only available with
+     * {@link https://docs.microsoft.com/office/dev/add-ins/outlook/autolaunch | event-based activation}.
      *
      * @param key Key of item to be removed. Must be a string.
      */
@@ -72,7 +86,11 @@ declare namespace OfficeRuntime {
      * Retrieves multiple items from storage based on their key.
      * Returns a Promise. In the event the Promise does not resolve, returns null.
      *
-     * [Api set: SharedRuntime 1.1]
+     * @remarks
+     * [Api set: SharedRuntime 1.1, Mailbox 1.10]
+     *
+     * **Important**: In Outlook, support is only available with
+     * {@link https://docs.microsoft.com/office/dev/add-ins/outlook/autolaunch | event-based activation}.
      *
      * @param keys Keys of items to be removed. Must be an array of strings.
      */
@@ -81,7 +99,11 @@ declare namespace OfficeRuntime {
      * Sets multiple items into storage or updates multiple items within storage.
      * Returns a Promise.
      *
-     * [Api set: SharedRuntime 1.1]
+     * @remarks
+     * [Api set: SharedRuntime 1.1, Mailbox 1.10]
+     *
+     * **Important**: In Outlook, support is only available with
+     * {@link https://docs.microsoft.com/office/dev/add-ins/outlook/autolaunch | event-based activation}.
      *
      * @param keyValues Key-value pairs to be set. Must be strings.
      */
@@ -90,17 +112,24 @@ declare namespace OfficeRuntime {
      * Removes multiple items from storage.
      * Returns a Promise.
      *
-     * [Api set: SharedRuntime 1.1]
+     * @remarks
+     * [Api set: SharedRuntime 1.1, Mailbox 1.10]
+     *
+     * **Important**: In Outlook, support is only available with
+     * {@link https://docs.microsoft.com/office/dev/add-ins/outlook/autolaunch | event-based activation}.
      *
      * @param keys Keys of items to be removed. Must be an array of strings.
      */
     removeItems(keys: string[]): Promise<void>;
     /**
      * Retrieves an array of all keys from storage.
-     *  Returns a Promise.
+     * Returns a Promise.
      *
-     * [Api set: SharedRuntime 1.1]
+     * @remarks
+     * [Api set: SharedRuntime 1.1, Mailbox 1.10]
      *
+     * **Important**: In Outlook, support is only available with
+     * {@link https://docs.microsoft.com/office/dev/add-ins/outlook/autolaunch | event-based activation}.
      */
     getKeys(): Promise<string[]>;
   }
@@ -123,7 +152,7 @@ declare namespace OfficeRuntime {
      * [Api set: SharedRuntime 1.1]
      *
      */
-    displayInIFrame?: boolean | undefined;
+    displayInIFrame?: boolean;
     /**
      * 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'.
@@ -131,7 +160,7 @@ declare namespace OfficeRuntime {
      * [Api set: SharedRuntime 1.1]
      *
      */
-    height?: string | undefined;
+    height?: string;
     /**
      * Optional parameter that defines the width of dialog as a percentage of window.
      * For example, accepts strings such as: '50%', '50'.
@@ -139,28 +168,28 @@ declare namespace OfficeRuntime {
      * [Api set: SharedRuntime 1.1]
      *
      */
-    width?: string | undefined;
+    width?: string;
     /**
      * Optional callback that runs when the dialog box sends a message to its parent.
      *
      * [Api set: SharedRuntime 1.1]
      *
      */
-    onMessage?: ((message: string, dialog?: Dialog) => void) | undefined;
+    onMessage?: (message: string, dialog?: Dialog) => void;
     /**
      * Optional callback that runs when the dialog box is closed.
      *
      * [Api set: SharedRuntime 1.1]
      *
      */
-    onClose?: (() => void) | undefined;
+    onClose?: () => void;
     /**
      * Optional callback that runs when the dialog box sends an error.
      *
      * [Api set: SharedRuntime 1.1]
      *
      */
-    onRuntimeError?: ((error: Error, dialog?: Dialog) => void) | undefined;
+    onRuntimeError?: (error: Error, dialog?: Dialog) => void;
   }
   /**
    * Contains authorization related APIs.
@@ -168,6 +197,12 @@ declare namespace OfficeRuntime {
   const auth: Auth;
     /**
      * Provides options for the user experience when Office obtains an access token to the add-in from AAD v. 2.0 with the `getAccessToken` method.
+     *
+     * @remarks
+     *
+     * The methods in this interface are equivalent to those in the `Office.AuthOptions` interface.
+     * If new authentication types are added in the future, they will only be added to the `Office.AuthOptions` interface.
+     * For simplicity, the code examples throughout the documentation use `Office.AuthOptions`.
      */
     interface AuthOptions {
       /**
@@ -176,26 +211,26 @@ declare namespace OfficeRuntime {
        * If set to `true`, Office will show an interactive consent UI after it fails to silently get an access token.
        * The prompt will only allow consent to the AAD profile scope, not to any Microsoft Graph scopes.
        */
-      allowConsentPrompt?: boolean | undefined;
+      allowConsentPrompt?: boolean;
       /**
        * Allows Office to get an access token silently provided consent is present or show interactive UI to sign in the user. Default value is `false`.
        * If set to `false`, Office will silently try to get an access token. If it fails to do so, Office will return a descriptive error.
        * If set to `true`, Office will show an interactive sign-in UI after it fails to silently get an access token.
        */
-      allowSignInPrompt?: boolean | undefined;
+      allowSignInPrompt?: boolean;
       /**
        * Prompts the user to add their Office account (or to switch to it, if it is already added). Default value is `false`.
        *
        * @deprecated Use `allowSignInPrompt` instead.
        */
-      forceAddAccount?: boolean | undefined;
+      forceAddAccount?: boolean;
       /**
        * Causes Office to display the add-in consent experience. Useful if the add-in's Azure permissions have changed or if the user's consent has
        * been revoked. Default value is `false`.
        *
        * @deprecated Use `allowConsentPrompt` instead.
        */
-      forceConsent?: boolean | undefined;
+      forceConsent?: boolean;
       /**
        * Causes Office to prompt the user to provide the additional factor when the tenancy being targeted by Microsoft Graph requires multifactor
        * authentication. The string value identifies the type of additional factor that is required. In most cases, you won't know at development
@@ -203,7 +238,7 @@ declare namespace OfficeRuntime {
        * call of `getAccessToken` after Microsoft Graph has sent an error requesting the additional factor and containing the string that should
        * be used with the `authChallenge` option.
        */
-      authChallenge?: string | undefined;
+      authChallenge?: string;
       /**
        * A user-defined item of any type that is returned, unchanged, in the `asyncContext` property of the `AsyncResult` object that is passed to a callback.
        */
@@ -213,10 +248,16 @@ declare namespace OfficeRuntime {
        * Office only supports consent to Graph scopes when the add-in has been deployed by a tenant admin. This information will not be available during development.
        * Setting this option to `true` will cause Office to inform your add-in beforehand (by returning a descriptive error) if Graph access will fail.
        */
-      forMSGraphAccess?: boolean | undefined;
+      forMSGraphAccess?: boolean;
   }
   /**
    * Interface that contains authorization related APIs.
+   *
+   * @remarks
+   *
+   * The methods in this interface are equivalent to those in the `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`.
    */
   interface Auth {
     /**

office-runtime/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@types/office-runtime",
-    "version": "1.0.19",
+    "version": "1.0.23",
     "description": "TypeScript definitions for office-runtime",
     "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-runtime",
     "license": "MIT",
@@ -10,11 +10,6 @@
             "url": "https://github.com/OfficeDev",
             "githubUsername": "OfficeDev"
         },
-        {
-            "name": "Michelle Scharlock",
-            "url": "https://github.com/mscharlock",
-            "githubUsername": "mscharlock"
-        },
         {
             "name": "David Chesnut",
             "url": "https://github.com/davidchesnut",
@@ -45,6 +40,6 @@
     },
     "scripts": {},
     "dependencies": {},
-    "typesPublisherContentHash": "bb3d87aa386a7ff60fcc0013e4172b55ee916bf7c538433bed5074c57fdcc5be",
-    "typeScriptVersion": "3.6"
+    "typesPublisherContentHash": "c06f800870854a6de920aee4a8cad24e241d5a301e284b166484f0fbdae8357f",
+    "typeScriptVersion": "3.7"
 }