@types/office-js 1.0.213 → 1.0.217

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: Thu, 21 Oct 2021 16:31:25 GMT
+ * Last updated: Mon, 01 Nov 2021 20:31:23 GMT
  * Dependencies: none
  * Global values: `Excel`, `Office`, `OfficeCore`, `OfficeExtension`, `OneNote`, `PowerPoint`, `Visio`, `Word`
 

office-js/index.d.ts

@@ -9503,6 +9503,17 @@ declare namespace Office {
          * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Organizer
          */
         requiredAttendees: Recipients;
+        /**
+         * Manages the {@link Office.SessionData | SessionData} of an item in Compose mode.
+         *
+         * @remarks
+         * [Api set: Mailbox 1.11]
+         *
+         * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem`
+         *
+         * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Organizer
+         */
+        sessionData: SessionData;
         /**
          * Gets the id of the series that an instance belongs to.
          * 
@@ -14343,6 +14354,17 @@ declare namespace Office {
          * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose
          */
         notificationMessages: NotificationMessages;
+        /**
+         * Manages the {@link Office.SessionData | SessionData} of an item in Compose mode.
+         *
+         * @remarks
+         * [Api set: Mailbox 1.11]
+         *
+         * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem`
+         *
+         * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose
+         */
+        sessionData: SessionData;
         /**
          * Gets the ID of the series that an instance belongs to.
          * 
@@ -17417,6 +17439,143 @@ declare namespace Office {
          */
         setStartTime(time: string): void;
     }
+    /**
+     * Provides methods to  manage an item's session data.
+     *
+     * @remarks
+     * [Api set: Mailbox 1.11]
+     *
+     * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem`
+     *
+     * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
+     */
+    interface SessionData {
+        /**
+         * Clears all session data key-value pairs.
+         *
+         * @remarks
+         * [Api set: Mailbox 1.11]
+         *
+         * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadWriteItem`
+         *
+         * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
+         *
+         * @param options - An object literal that contains one or more of the following properties.
+         *        `asyncContext`: Developers can provide any object they wish to access in the callback method.
+         * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter,
+         *                `asyncResult`, which is an `Office.AsyncResult` object.
+         */
+        clearAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
+        /**
+         * Clears all session data key-value pairs.
+         *
+         * @remarks
+         * [Api set: Mailbox 1.11]
+         *
+         * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadWriteItem`
+         *
+         * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
+         *
+         * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter,
+         *                `asyncResult`, which is an `Office.AsyncResult` object.
+         */
+        clearAsync(callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
+        /**
+         * Gets all session data key-value pairs.
+         *
+         * @remarks
+         * [Api set: Mailbox 1.11]
+         *
+         * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadWriteItem`
+         *
+         * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
+         *
+         * @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter,
+         *                `asyncResult`, which is an `Office.AsyncResult` object.
+         */
+        getAllAsync(callback: (asyncResult: Office.AsyncResult<string>) => void): void;
+        /**
+         * Gets the session data value of the specified key.
+         *
+         * @remarks
+         * [Api set: Mailbox 1.11]
+         *
+         * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem`
+         *
+         * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
+         *
+         * @param name - The session data key.
+         * @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter of
+         *                 type `Office.AsyncResult`.
+         */
+        getAsync(name: string, callback: (asyncResult: Office.AsyncResult<string>) => void): void;
+        /**
+         * Removes a session data key-value pair.
+         *
+         * @remarks
+         * [Api set: Mailbox 1.11]
+         *
+         * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadWriteItem`
+         *
+         * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
+         *
+         * @param name - The session data key.
+         * @param options - An object literal that contains one or more of the following properties.
+         *        `asyncContext`: Developers can provide any object they wish to access in the callback method.
+         * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter,
+         *                `asyncResult`, which is an `Office.AsyncResult` object.
+         */
+        removeAsync(name: string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
+        /**
+         * Removes a session data key-value pair.
+         *
+         * @remarks
+         * [Api set: Mailbox 1.11]
+         *
+         * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadWriteItem`
+         *
+         * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
+         *
+         * @param name - The session data key.
+         * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter,
+         *                `asyncResult`, which is an `Office.AsyncResult` object.
+         */
+        removeAsync(name: string, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
+        /**
+         * Sets a session data key-value pair.
+         *
+         * @remarks
+         * [Api set: Mailbox 1.11]
+         *
+         * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem`
+         *
+         * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
+
+         * @param name - The session data key.
+         * @param value - The session data value as a string.
+         * @param options - An object literal that contains one or more of the following properties.
+         *        `asyncContext`: Developers can provide any object they wish to access in the callback method.
+         * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter of
+         *                 type `Office.AsyncResult`.
+         */
+        setAsync(name: string, value: string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
+        /**
+         * Sets a session data key-value pair.
+         *
+         * @remarks
+         * [Api set: Mailbox 1.11]
+         *
+         * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem`
+         *
+         * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
+
+         * @param name - The session data key.
+         * @param value - The session data value as a string.
+         * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter of
+         *                 type `Office.AsyncResult`.
+         */
+        setAsync(name: string, value: string, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
+    }
     /**
      * Represents the properties of an appointment or message in a shared folder.
      *
@@ -32833,7 +32992,7 @@ declare namespace Excel {
          * Clears the column filter criteria of the AutoFilter.
          *
          * @remarks
-         * [Api set: ExcelApiOnline 1.1]
+         * [Api set: ExcelApi 1.14]
          *
          * @param columnIndex The zero-based column index, which represents which column filter needs to be cleared.
                      If the index value is not supported(for example, if the value is a negative number, or if the value is greater than the number of available columns in the range),
@@ -48446,7 +48605,7 @@ declare namespace Excel {
         }): FunctionResult<T>;
         /**
         * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.)
-        * Whereas the original FunctionResult<T> object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Interfaces.FunctionResultData<T>`) that contains shallow copies of any loaded child properties from the original object.
+        * Whereas the original `FunctionResult<T>` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Interfaces.FunctionResultData<T>`) that contains shallow copies of any loaded child properties from the original object.
         */
         toJSON(): Interfaces.FunctionResultData<T>;
     }
@@ -74351,6 +74510,9 @@ declare namespace Word {
         /**
          * Gets the collection of paragraph objects in the body. Read-only.
          *
+         * **Important**: Paragraphs in tables are not returned for requirement sets 1.1 and 1.2.
+         * From requirement set 1.3, paragraphs in tables are also returned.
+         *
          * @remarks
          * [Api set: WordApi 1.1]
          */
@@ -74759,7 +74921,10 @@ declare namespace Word {
          */
         readonly lists: Word.ListCollection;
         /**
-         * Get the collection of paragraph objects in the content control. Read-only.
+         * Gets the collection of paragraph objects in the content control. Read-only.
+         *
+         * **Important**: For requirement sets 1.1 and 1.2, paragraphs in tables wholly contained within this content control are not returned.
+         * From requirement set 1.3, paragraphs in such tables are also returned. 
          *
          * @remarks
          * [Api set: WordApi 1.1]
@@ -77511,6 +77676,9 @@ declare namespace Word {
         /**
          * Gets the collection of paragraph objects in the range. Read-only.
          *
+         * **Important**: For requirement sets 1.1 and 1.2, paragraphs in tables wholly contained within this range are not returned.
+         * From requirement set 1.3, paragraphs in such tables are also returned.
+         *
          * @remarks
          * [Api set: WordApi 1.1]
          */
@@ -86200,14 +86368,6 @@ declare namespace Word {
     /**
      * Executes a batch script that performs actions on the Word object model, using a new RequestContext. When the promise is resolved, any tracked objects that were automatically allocated during execution will be released.
      * @param batch - A function that takes in a RequestContext and returns a promise (typically, just the result of "context.sync()"). The context parameter facilitates requests to the Word application. Since the Office add-in and the Word application run in two different processes, the RequestContext is required to get access to the Word object model from the add-in.
-     *
-     * @remarks
-     *
-     * In addition to this signature, the method also has the following signatures, which allow you to resume using the request context of previously created objects:
-     *
-     * run<T>(object: OfficeExtension.ClientObject, batch: (context: Word.RequestContext) => Promise<T>): Promise<T>;
-     *
-     * run<T>(objects: OfficeExtension.ClientObject[], batch: (context: Word.RequestContext) => Promise<T>): Promise<T>;
      */
     function run<T>(batch: (context: Word.RequestContext) => Promise<T>): Promise<T>;
 }

office-js/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@types/office-js",
-    "version": "1.0.213",
+    "version": "1.0.217",
     "description": "TypeScript definitions for Office.js",
     "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-js",
     "license": "MIT",
@@ -40,6 +40,6 @@
     },
     "scripts": {},
     "dependencies": {},
-    "typesPublisherContentHash": "4a0aaeb4e6ad3145dee16ad2386ff94c2dc942687824f2129dbf0b79714551aa",
+    "typesPublisherContentHash": "d7ba3b2afcc20968c82925f6f7cfe82de8b5f083ffb4e73b08546a76103f5115",
     "typeScriptVersion": "3.7"
 }