@types/office-runtime 1.0.21 → 1.0.24

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: Thu, 02 Sep 2021 18:31:24 GMT
+ * Last updated: Tue, 21 Jun 2022 21:01:37 GMT
  * Dependencies: none
  * Global values: `OfficeRuntime`
 

office-runtime/index.d.ts

@@ -33,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 {
@@ -43,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.
      */
@@ -52,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.
@@ -62,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.
      */
@@ -71,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.
      */
@@ -80,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.
      */
@@ -89,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[]>;
   }
@@ -167,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 {
       /**
@@ -216,6 +252,12 @@ declare namespace OfficeRuntime {
   }
   /**
    * Interface that contains authorization related APIs.
+   *
+   * @remarks
+   *
+   * 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`.
    */
   interface Auth {
     /**
@@ -225,7 +267,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
      *

office-runtime/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@types/office-runtime",
-    "version": "1.0.21",
+    "version": "1.0.24",
     "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": "346ac191aba31a807452a6bfe3062e7483b5581de88f1c417939f98a5f9b34e7",
-    "typeScriptVersion": "3.7"
+    "typesPublisherContentHash": "284ed6f24d74073f2659a8b2abc04e7d490abc44114dd7b55523efd658833caf",
+    "typeScriptVersion": "4.0"
 }