@types/office-js 1.0.270 → 1.0.273

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: Mon, 08 Aug 2022 18:02:22 GMT
+ * Last updated: Mon, 29 Aug 2022 23:32:43 GMT
  * Dependencies: none
  * Global values: `Excel`, `Office`, `OfficeCore`, `OfficeExtension`, `OneNote`, `PowerPoint`, `Visio`, `Word`
 

office-js/index.d.ts

@@ -10956,7 +10956,7 @@ declare namespace Office {
          */
         optionalAttendees: EmailAddressDetails[];
         /**
-         * Gets the email address of the meeting organizer for a specified meeting.
+         * Gets the meeting organizer's email properties.
          *
          * @remarks
          *
@@ -16581,6 +16581,13 @@ declare namespace Office {
          *
          * There are a maximum of 5 notifications per message. Setting more will return a `NumberOfNotificationMessagesExceeded` error.
          *
+         * **Important**:
+         *
+         * - Only one notification of type {@link https://docs.microsoft.com/javascript/api/outlook/office.mailboxenums.itemnotificationmessagetype#fields | InsightMessage}
+         * is allowed per add-in. Attempting to add more will throw an error.
+         *
+         * - In modern Outlook on the web, you can add an `InsightMessage` notification only in Compose mode.
+         * 
          * @remarks
          * [Api set: Mailbox 1.3]
          * 
@@ -16603,6 +16610,13 @@ declare namespace Office {
          *
          * There are a maximum of 5 notifications per message. Setting more will return a `NumberOfNotificationMessagesExceeded` error.
          *
+         * **Important**:
+         *
+         * - Only one notification of type {@link https://docs.microsoft.com/javascript/api/outlook/office.mailboxenums.itemnotificationmessagetype#fields | InsightMessage}
+         * is allowed per add-in. Attempting to add more will throw an error.
+         *
+         * - In modern Outlook on the web, you can add an `InsightMessage` notification only in Compose mode.
+         * 
          * @remarks
          * [Api set: Mailbox 1.3]
          * 
@@ -19290,6 +19304,224 @@ declare namespace Excel {
     function run<T>(context: OfficeExtension.ClientRequestContext, batch: (context: Excel.RequestContext) => Promise<T>): Promise<T>;
     function postprocessBindingDescriptor(response: any): any;
     function getDataCommonPostprocess(response: any, callArgs: any): any;
+    /**
+     * Represents an `AllowEditRange` object found in a worksheet. This object works with worksheet protection properties.
+                When worksheet protection is enabled, an `AllowEditRange` object can be used to allow editing of a specific range, while maintaining protection on the rest of the worksheet.
+     *
+     * @remarks
+     * [Api set: ExcelApiOnline 1.1]
+     */
+    class AllowEditRange extends OfficeExtension.ClientObject {
+        /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
+        context: RequestContext;
+        /**
+         * Specifies the range associated with the object.
+                    Worksheet protection must be disabled or paused for this method to work properly.
+                    If worksheet protection is enabled and not paused, this method throws an `AccessDenied` error and fails to set the range.
+         *
+         * @remarks
+         * [Api set: ExcelApiOnline 1.1]
+         */
+        address: string;
+        /**
+         * Specifies if the object is password protected.
+         *
+         * @remarks
+         * [Api set: ExcelApiOnline 1.1]
+         */
+        readonly isPasswordProtected: boolean;
+        /**
+         * Specifies the title of the object.
+                    Worksheet protection must be disabled or paused for this method to work properly.
+                    If worksheet protection is enabled and not paused, this method throws an `AccessDenied` error and fails to set the title.
+                    If there is already an existing `AllowEditRange` with the same string, or if the string is `null` or empty (""), then this method throws an `InvalidArgument` error and fails to set the title.
+         *
+         * @remarks
+         * [Api set: ExcelApiOnline 1.1]
+         */
+        title: string;
+        /**
+         * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type.
+         * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called.
+         * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties.
+         */
+        set(properties: Interfaces.AllowEditRangeUpdateData, options?: OfficeExtension.UpdateOptions): void;
+        /** Sets multiple properties on the object at the same time, based on an existing loaded object. */
+        set(properties: Excel.AllowEditRange): void;
+        /**
+         * Deletes the object from the `AllowEditRangeCollection`.
+                    Worksheet protection must be disabled or paused for this method to work properly.
+                    If worksheet protection is enabled and not paused, this method throws an `AccessDenied` error and fails the delete operation.
+         *
+         * @remarks
+         * [Api set: ExcelApiOnline 1.1]
+         */
+        delete(): void;
+        /**
+         * Pauses worksheet protection for the object for the user in the current session.
+                    This method does nothing if worksheet protection isn't enabled or is already paused.
+                    If worksheet protection cannot be paused, this method throws an `UnsupportedOperation` error and fails to pause protection for the object.
+                    If the password is incorrect, then this method throws a `BadPassword` error and fails to pause protection for the object.
+                    If a password is supplied but the object does not require a password, the inputted password will be ignored and the operation will succeed.
+         *
+         * @remarks
+         * [Api set: ExcelApiOnline 1.1]
+         *
+         * @param password The password associated with the `AllowEditRange` object.
+         */
+        pauseProtection(password?: string): void;
+        /**
+         * Changes the password associated with the object.
+                    Setting the password string as empty ("") or `null` will remove password protection from the object.
+                    Worksheet protection must be disabled or paused for this method to work properly.
+                    If worksheet protection is enabled and not paused, then this method throws an `AccessDenied` error and the set operation fails.
+         *
+         * @remarks
+         * [Api set: ExcelApiOnline 1.1]
+         *
+         * @param password The password associated with the `AllowEditRange` object.
+         */
+        setPassword(password?: string): void;
+        /**
+         * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
+         *
+         * @param options Provides options for which properties of the object to load.
+         */
+        load(options?: Excel.Interfaces.AllowEditRangeLoadOptions): Excel.AllowEditRange;
+        /**
+         * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
+         *
+         * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
+         */
+        load(propertyNames?: string | string[]): Excel.AllowEditRange;
+        /**
+         * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
+         *
+         * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load.
+         */
+        load(propertyNamesAndPaths?: {
+            select?: string;
+            expand?: string;
+        }): Excel.AllowEditRange;
+        /**
+        * 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 Excel.AllowEditRange object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.AllowEditRangeData`) that contains shallow copies of any loaded child properties from the original object.
+        */
+        toJSON(): Excel.Interfaces.AllowEditRangeData;
+    }
+    /**
+     * Represents the set of `AllowEditRange` objects found in a worksheet. `AllowEditRange` objects work with worksheet protection properties.
+                When worksheet protection is enabled, an `AllowEditRange` object can be used to allow editing of a specific range, while maintaining protection on the rest of the worksheet.
+     *
+     * @remarks
+     * [Api set: ExcelApiOnline 1.1]
+     */
+    class AllowEditRangeCollection extends OfficeExtension.ClientObject {
+        /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
+        context: RequestContext;
+        /** Gets the loaded child items in this collection. */
+        readonly items: Excel.AllowEditRange[];
+        /**
+         * Adds an `AllowEditRange` object to the worksheet.
+                    Worksheet protection must be disabled or paused for this method to work properly.
+                    If worksheet protection is enabled and not paused, then this method throws an `AccessDenied` error and the add operation fails.
+         *
+         * @remarks
+         * [Api set: ExcelApiOnline 1.1]
+         *
+         * @param title The title string of the `AllowEditRange` object to be added.
+         * @param rangeAddress The range address of the `AllowEditRange` object to be added.
+         * @param options Additional options to be added to the `AllowEditRange` object, such as the password.
+         */
+        add(title: string, rangeAddress: string, options?: Excel.AllowEditRangeOptions): void;
+        /**
+         * Returns the number of `AllowEditRange` objects in the collection.
+         *
+         * @remarks
+         * [Api set: ExcelApiOnline 1.1]
+         */
+        getCount(): OfficeExtension.ClientResult<number>;
+        /**
+         * Gets the `AllowEditRange` object by its title.
+         *
+         * @remarks
+         * [Api set: ExcelApiOnline 1.1]
+         *
+         * @param key The title of the `AllowEditRange`.
+         * @returns The `AllowEditRange` with the title. If there is no `AllowEditRange` with the given title, then an `ItemNotFound` error is thrown.
+         */
+        getItem(key: string): Excel.AllowEditRange;
+        /**
+         * Returns an `AllowEditRange` object by its index in the collection.
+         *
+         * @remarks
+         * [Api set: ExcelApiOnline 1.1]
+         *
+         * @param index The index of the `AllowEditRange` object in the collection.
+         * @returns The `AllowEditRange` at the given index.
+         */
+        getItemAt(index: number): Excel.AllowEditRange;
+        /**
+         * Gets the `AllowEditRange` object by its title.
+         *
+         * @remarks
+         * [Api set: ExcelApiOnline 1.1]
+         *
+         * @param key The title of the `AllowEditRange`.
+         * @returns The `AllowEditRange` with the title. If there is no `AllowEditRange` with the given title, then this method returns an object with its `isNullObject` property set to `true`. For further information, see {@link https://docs.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
+         */
+        getItemOrNullObject(key: string): Excel.AllowEditRange;
+        /**
+         * Pauses worksheet protection for all `AllowEditRange` objects found in this worksheet that have the given password for the user in the current session.
+                    This method does nothing if worksheet protection isn't enabled or is paused.
+                    If worksheet protection cannot be paused, this method throws an `UnsupportedOperation` error and fails to pause protection for the range.
+                    If the password does not match any `AllowEditRange` objects in the collection, then this method throws a `BadPassword` error and fails to pause protection for any range in the collection.
+         *
+         * @remarks
+         * [Api set: ExcelApiOnline 1.1]
+         *
+         * @param password The password to pause protection on the `AllowEditRange` objects.
+         */
+        pauseProtection(password: string): void;
+        /**
+         * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
+         *
+         * @param options Provides options for which properties of the object to load.
+         */
+        load(options?: Excel.Interfaces.AllowEditRangeCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.AllowEditRangeCollection;
+        /**
+         * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
+         *
+         * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
+         */
+        load(propertyNames?: string | string[]): Excel.AllowEditRangeCollection;
+        /**
+         * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
+         *
+         * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load.
+         */
+        load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.AllowEditRangeCollection;
+        /**
+        * 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 `Excel.AllowEditRangeCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.AllowEditRangeCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
+        */
+        toJSON(): Excel.Interfaces.AllowEditRangeCollectionData;
+    }
+    /**
+     * The interface used to construct optional fields of the `AllowEditRange` object.
+     *
+     * @remarks
+     * [Api set: ExcelApiOnline 1.1]
+     */
+    interface AllowEditRangeOptions {
+        /**
+         * The password associated with the `AllowEditRange`.
+         *
+         * @remarks
+         * [Api set: ExcelApiOnline 1.1]
+         */
+        password?: string;
+    }
     /**
      * Notifies when a worksheet is moved within a workbook.
                 
@@ -21070,6 +21302,13 @@ declare namespace Excel {
      * [Api set: ExcelApi 1.14]
      */
     interface WorksheetProtectionChangedEventArgs {
+        /**
+         * Specifies if any of the `AllowEditRange` objects have changed.
+         *
+         * @remarks
+         * [Api set: ExcelApiOnline 1.1]
+         */
+        allowEditRangesChanged: boolean;
         /**
          * Gets the current protection status of the worksheet.
          *
@@ -21077,6 +21316,20 @@ declare namespace Excel {
          * [Api set: ExcelApi 1.14]
          */
         isProtected: boolean;
+        /**
+         * Specifies if the `WorksheetProtectionOptions` have changed.
+         *
+         * @remarks
+         * [Api set: ExcelApiOnline 1.1]
+         */
+        protectionOptionsChanged: boolean;
+        /**
+         * Specifies if the worksheet password has changed.
+         *
+         * @remarks
+         * [Api set: ExcelApiOnline 1.1]
+         */
+        sheetPasswordChanged: boolean;
         /**
          * The source of the event. It can be local or remote (through co-authoring).
          *
@@ -23364,6 +23617,35 @@ declare namespace Excel {
     class WorksheetProtection extends OfficeExtension.ClientObject {
         /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
         context: RequestContext;
+        /**
+         * Specifies the `AllowEditRangeCollection` object found in this worksheet. This is a collection of `AllowEditRange` objects, which work with worksheet protection properties.
+                    When worksheet protection is enabled, an `AllowEditRange` object can be used to allow editing of a specific range, while maintaining protection on the rest of the worksheet.
+         *
+         * @remarks
+         * [Api set: ExcelApiOnline 1.1]
+         */
+        readonly allowEditRanges: Excel.AllowEditRangeCollection;
+        /**
+         * Specifies if protection can be paused for this worksheet.
+         *
+         * @remarks
+         * [Api set: ExcelApiOnline 1.1]
+         */
+        readonly canPauseProtection: boolean;
+        /**
+         * Specifies if the sheet is password protected.
+         *
+         * @remarks
+         * [Api set: ExcelApiOnline 1.1]
+         */
+        readonly isPasswordProtected: boolean;
+        /**
+         * Specifies if worksheet protection is paused.
+         *
+         * @remarks
+         * [Api set: ExcelApiOnline 1.1]
+         */
+        readonly isPaused: boolean;
         /**
          * Specifies the protection options for the worksheet.
          *
@@ -23378,6 +23660,38 @@ declare namespace Excel {
          * [Api set: ExcelApi 1.2]
          */
         readonly protected: boolean;
+        /**
+         * Specifies the protection options saved in the worksheet.
+                    This will return the same `WorksheetProtectionOptions` object regardless of the worksheet protection state.
+         *
+         * @remarks
+         * [Api set: ExcelApiOnline 1.1]
+         */
+        readonly savedOptions: Excel.WorksheetProtectionOptions;
+        /**
+         * Specifies if the password can be used to unlock worksheet protection.
+                    This method doesn't change the worksheet protection state.
+                    If a password is inputted but no password is required to unlock worksheet protection, this method will return false.
+         *
+         * @remarks
+         * [Api set: ExcelApiOnline 1.1]
+         *
+         * @param password The password to check against the protected worksheet.
+         * @returns Returns `true` if the password can be used to unlock worksheet protection. Otherwise, returns `false`.
+         */
+        checkPassword(password?: string): OfficeExtension.ClientResult<boolean>;
+        /**
+         * Pauses worksheet protection for the given worksheet object for the user in the current session.
+                    This method does nothing if worksheet protection isn't enabled or is already paused.
+                    If the password is incorrect, then this method throws an `InvalidArgument` error and fails to pause protection.
+                    This method does not change the protection state if worksheet protection is not enabled or already paused.
+         *
+         * @remarks
+         * [Api set: ExcelApiOnline 1.1]
+         *
+         * @param password The password associated with the protected worksheet.
+         */
+        pauseProtection(password?: string): void;
         /**
          * Protects a worksheet. Fails if the worksheet has already been protected.
          *
@@ -23388,6 +23702,27 @@ declare namespace Excel {
          * @param password Optional. Sheet protection password.
          */
         protect(options?: Excel.WorksheetProtectionOptions, password?: string): void;
+        /**
+         * Resumes worksheet protection for the given worksheet object for the user in a given session.
+                    Worksheet protection must be paused for this method to work. If worksheet protection is not paused, then this method will not change the protection state of the worksheet.
+         *
+         * @remarks
+         * [Api set: ExcelApiOnline 1.1]
+         */
+        resumeProtection(): void;
+        /**
+         * Changes the password associated with the `WorksheetProtection` object.
+                    Setting the password as an empty string ("") or as `null` will remove password protection from the `WorksheetProtection` object.
+                    Worksheet protection must be enabled and paused for this method to work properly.
+                    If worksheet protection is disabled, this method throws an `InvalidOperation` error and fails to change the password.
+                    If worksheet protection is enabled and not paused, this method throws an `AccessDenied` error and fails to change the password.
+         *
+         * @remarks
+         * [Api set: ExcelApiOnline 1.1]
+         *
+         * @param password The password associated with the `WorksheetProtection` object.
+         */
+        setPassword(password?: string): void;
         /**
          * Unprotects a worksheet.
          *
@@ -23397,6 +23732,17 @@ declare namespace Excel {
          * @param password Sheet protection password.
          */
         unprotect(password?: string): void;
+        /**
+         * Change the worksheet protection options associated with the `WorksheetProtection` object.
+                    Worksheet protection must be disabled or paused for this method to work properly.
+                    If worksheet protection is enabled and not paused, this method throws an `AccessDenied` error and fails to change the worksheet protection options.
+         *
+         * @remarks
+         * [Api set: ExcelApiOnline 1.1]
+         *
+         * @param options The options interface associated with the `WorksheetProtection` object.
+         */
+        updateOptions(options: Excel.WorksheetProtectionOptions): void;
         /**
          * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
          *
@@ -23794,7 +24140,7 @@ declare namespace Excel {
          */
         readonly linkedDataTypeState: Excel.LinkedDataTypeState[][];
         /**
-         * Represents Excel's number format code for the given range.
+         * Represents Excel's number format code for the given range. For more information about Excel number formatting, see {@link https://support.microsoft.com/office/number-format-codes-5026bbd6-04bc-48cd-bf33-80f18b4eae68 | Number format codes}.
          *
          * @remarks
          * [Api set: ExcelApi 1.1]
@@ -24662,11 +25008,11 @@ declare namespace Excel {
             expand?: string;
         }): Excel.Range;
         /**
-         * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for `context.trackedObjects.add(thisObject)`. If you are using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you needed to have added the object to the tracked object collection when the object was first created.
+         * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://docs.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you are using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created.
          */
         track(): Excel.Range;
         /**
-         * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for `context.trackedObjects.remove(thisObject)`. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call `context.sync()` before the memory release takes effect.
+         * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://docs.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call `context.sync()` before the memory release takes effect.
          */
         untrack(): Excel.Range;
         /**
@@ -25042,11 +25388,11 @@ declare namespace Excel {
             expand?: string;
         }): Excel.RangeAreas;
         /**
-         * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for `context.trackedObjects.add(thisObject)`. If you are using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you needed to have added the object to the tracked object collection when the object was first created.
+         * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://docs.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you are using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created.
          */
         track(): Excel.RangeAreas;
         /**
-         * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for `context.trackedObjects.remove(thisObject)`. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call `context.sync()` before the memory release takes effect.
+         * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://docs.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call `context.sync()` before the memory release takes effect.
          */
         untrack(): Excel.RangeAreas;
         /**
@@ -25126,11 +25472,11 @@ declare namespace Excel {
             expand?: string;
         }): Excel.WorkbookRangeAreas;
         /**
-         * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for `context.trackedObjects.add(thisObject)`. If you are using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you needed to have added the object to the tracked object collection when the object was first created.
+         * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://docs.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you are using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created.
          */
         track(): Excel.WorkbookRangeAreas;
         /**
-         * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for `context.trackedObjects.remove(thisObject)`. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call `context.sync()` before the memory release takes effect.
+         * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://docs.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call `context.sync()` before the memory release takes effect.
          */
         untrack(): Excel.WorkbookRangeAreas;
         /**
@@ -33335,8 +33681,8 @@ declare namespace Excel {
          * [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),
-                     then an `InvalidArgument` exception will be thrown.
+                     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),
+                     then an `InvalidArgument` error will be thrown.
          */
         clearColumnCriteria(columnIndex: number): void;
         /**
@@ -37437,7 +37783,8 @@ declare namespace Excel {
          */
         readonly font: Excel.ConditionalRangeFont;
         /**
-         * Represents Excel's number format code for the given range. Cleared if `null` is passed in.
+         * Represents Excel's number format code for the given range. For more information about Excel number formatting, see {@link https://support.microsoft.com/office/number-format-codes-5026bbd6-04bc-48cd-bf33-80f18b4eae68 | Number format codes}.
+                    Cleared if `null` is passed in.
          *
          * @remarks
          * [Api set: ExcelApi 1.6]
@@ -38177,7 +38524,7 @@ declare namespace Excel {
         /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
         context: RequestContext;
         /**
-         * Gets the name of the table style.
+         * Specifies the name of the table style.
          *
          * @remarks
          * [Api set: ExcelApi 1.10]
@@ -38341,7 +38688,7 @@ declare namespace Excel {
         /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
         context: RequestContext;
         /**
-         * Gets the name of the PivotTable style.
+         * Specifies the name of the PivotTable style.
          *
          * @remarks
          * [Api set: ExcelApi 1.10]
@@ -38505,7 +38852,7 @@ declare namespace Excel {
         /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
         context: RequestContext;
         /**
-         * Gets the name of the slicer style.
+         * Specifies the name of the slicer style.
          *
          * @remarks
          * [Api set: ExcelApi 1.10]
@@ -38669,7 +39016,7 @@ declare namespace Excel {
         /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
         context: RequestContext;
         /**
-         * Gets the name of the timeline style.
+         * Specifies the name of the timeline style.
          *
          * @remarks
          * [Api set: ExcelApi 1.10]
@@ -39406,7 +39753,8 @@ declare namespace Excel {
         /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
         context: RequestContext;
         /**
-         * Refreshes all the data connections in the collection.
+         * Refreshes data connections in the collection, such as from a PivotTable to a Power BI dataset, or a Data Model to a table or range in the same workbook.
+                    Data connections unsupported by this method are: Power Query connections, data connections outside the original workbook (except Power BI connections), and connections to data protected by a firewall.
          *
          * @remarks
          * [Api set: ExcelApi 1.7]
@@ -44133,7 +44481,7 @@ declare namespace Excel {
     }
     /**
      * @remarks
-     * [Api set: ExcelApi 1.1 for All, Formats, and Contents. 1.7 for Hyperlinks and RemoveHyperlinks.]
+     * [Api set: ExcelApi 1.1]
      */
     enum ClearApplyTo {
         /**
@@ -45535,7 +45883,7 @@ declare namespace Excel {
     }
     /**
      * @remarks
-     * [Api set: ExcelApi 1.1 for Unknown, Empty, String, Integer, Double, Boolean, Error. 1.7 for RichValue]
+     * [Api set: ExcelApi 1.1]
      */
     enum RangeValueType {
         /**
@@ -45787,7 +46135,7 @@ declare namespace Excel {
         /**
          * `Unknown` indicates that the type of data change is not one of the listed types.
          * @remarks
-         * [Api set: ExcelApi The name of this value was 'Others' in ExcelApi 1.7]
+         * [Api set: ExcelApi 1.8. The name of this value was 'Others' in ExcelApi 1.7]
          */
         unknown = "Unknown",
         /**
@@ -52795,6 +53143,7 @@ declare namespace Excel {
         requestAborted = "RequestAborted",
         responsePayloadSizeLimitExceeded = "ResponsePayloadSizeLimitExceeded",
         unsupportedFeature = "UnsupportedFeature",
+        unsupportedFillType = "UnsupportedFillType",
         unsupportedOperation = "UnsupportedOperation",
         unsupportedSheet = "UnsupportedSheet",
         invalidOperationInCellEditMode = "InvalidOperationInCellEditMode"
@@ -52813,6 +53162,32 @@ declare namespace Excel {
             */
             $skip?: number;
         }
+        /** An interface for updating data on the AllowEditRange object, for use in `allowEditRange.set({ ... })`. */
+        interface AllowEditRangeUpdateData {
+            /**
+             * Specifies the range associated with the object.
+                        Worksheet protection must be disabled or paused for this method to work properly.
+                        If worksheet protection is enabled and not paused, this method throws an `AccessDenied` error and fails to set the range.
+             *
+             * @remarks
+             * [Api set: ExcelApiOnline 1.1]
+             */
+            address?: string;
+            /**
+             * Specifies the title of the object.
+                        Worksheet protection must be disabled or paused for this method to work properly.
+                        If worksheet protection is enabled and not paused, this method throws an `AccessDenied` error and fails to set the title.
+                        If there is already an existing `AllowEditRange` with the same string, or if the string is `null` or empty (""), then this method throws an `InvalidArgument` error and fails to set the title.
+             *
+             * @remarks
+             * [Api set: ExcelApiOnline 1.1]
+             */
+            title?: string;
+        }
+        /** An interface for updating data on the AllowEditRangeCollection object, for use in `allowEditRangeCollection.set({ ... })`. */
+        interface AllowEditRangeCollectionUpdateData {
+            items?: Excel.Interfaces.AllowEditRangeData[];
+        }
         /** An interface for updating data on the QueryCollection object, for use in `queryCollection.set({ ... })`. */
         interface QueryCollectionUpdateData {
             items?: Excel.Interfaces.QueryData[];
@@ -53041,7 +53416,7 @@ declare namespace Excel {
              */
             hyperlink?: Excel.RangeHyperlink;
             /**
-             * Represents Excel's number format code for the given range.
+             * Represents Excel's number format code for the given range. For more information about Excel number formatting, see {@link https://support.microsoft.com/office/number-format-codes-5026bbd6-04bc-48cd-bf33-80f18b4eae68 | Number format codes}.
              *
              * @remarks
              * [Api set: ExcelApi 1.1]
@@ -56504,7 +56879,8 @@ declare namespace Excel {
             */
             font?: Excel.Interfaces.ConditionalRangeFontUpdateData;
             /**
-             * Represents Excel's number format code for the given range. Cleared if `null` is passed in.
+             * Represents Excel's number format code for the given range. For more information about Excel number formatting, see {@link https://support.microsoft.com/office/number-format-codes-5026bbd6-04bc-48cd-bf33-80f18b4eae68 | Number format codes}.
+                        Cleared if `null` is passed in.
              *
              * @remarks
              * [Api set: ExcelApi 1.6]
@@ -56769,7 +57145,7 @@ declare namespace Excel {
         /** An interface for updating data on the TableStyle object, for use in `tableStyle.set({ ... })`. */
         interface TableStyleUpdateData {
             /**
-             * Gets the name of the table style.
+             * Specifies the name of the table style.
              *
              * @remarks
              * [Api set: ExcelApi 1.10]
@@ -56783,7 +57159,7 @@ declare namespace Excel {
         /** An interface for updating data on the PivotTableStyle object, for use in `pivotTableStyle.set({ ... })`. */
         interface PivotTableStyleUpdateData {
             /**
-             * Gets the name of the PivotTable style.
+             * Specifies the name of the PivotTable style.
              *
              * @remarks
              * [Api set: ExcelApi 1.10]
@@ -56797,7 +57173,7 @@ declare namespace Excel {
         /** An interface for updating data on the SlicerStyle object, for use in `slicerStyle.set({ ... })`. */
         interface SlicerStyleUpdateData {
             /**
-             * Gets the name of the slicer style.
+             * Specifies the name of the slicer style.
              *
              * @remarks
              * [Api set: ExcelApi 1.10]
@@ -56811,7 +57187,7 @@ declare namespace Excel {
         /** An interface for updating data on the TimelineStyle object, for use in `timelineStyle.set({ ... })`. */
         interface TimelineStyleUpdateData {
             /**
-             * Gets the name of the timeline style.
+             * Specifies the name of the timeline style.
              *
              * @remarks
              * [Api set: ExcelApi 1.10]
@@ -57586,6 +57962,39 @@ declare namespace Excel {
         interface NamedSheetViewCollectionUpdateData {
             items?: Excel.Interfaces.NamedSheetViewData[];
         }
+        /** An interface describing the data returned by calling `allowEditRange.toJSON()`. */
+        interface AllowEditRangeData {
+            /**
+             * Specifies the range associated with the object.
+                        Worksheet protection must be disabled or paused for this method to work properly.
+                        If worksheet protection is enabled and not paused, this method throws an `AccessDenied` error and fails to set the range.
+             *
+             * @remarks
+             * [Api set: ExcelApiOnline 1.1]
+             */
+            address?: string;
+            /**
+             * Specifies if the object is password protected.
+             *
+             * @remarks
+             * [Api set: ExcelApiOnline 1.1]
+             */
+            isPasswordProtected?: boolean;
+            /**
+             * Specifies the title of the object.
+                        Worksheet protection must be disabled or paused for this method to work properly.
+                        If worksheet protection is enabled and not paused, this method throws an `AccessDenied` error and fails to set the title.
+                        If there is already an existing `AllowEditRange` with the same string, or if the string is `null` or empty (""), then this method throws an `InvalidArgument` error and fails to set the title.
+             *
+             * @remarks
+             * [Api set: ExcelApiOnline 1.1]
+             */
+            title?: string;
+        }
+        /** An interface describing the data returned by calling `allowEditRangeCollection.toJSON()`. */
+        interface AllowEditRangeCollectionData {
+            items?: Excel.Interfaces.AllowEditRangeData[];
+        }
         /** An interface describing the data returned by calling `query.toJSON()`. */
         interface QueryData {
             /**
@@ -58115,6 +58524,35 @@ declare namespace Excel {
         }
         /** An interface describing the data returned by calling `worksheetProtection.toJSON()`. */
         interface WorksheetProtectionData {
+            /**
+            * Specifies the `AllowEditRangeCollection` object found in this worksheet. This is a collection of `AllowEditRange` objects, which work with worksheet protection properties.
+            When worksheet protection is enabled, an `AllowEditRange` object can be used to allow editing of a specific range, while maintaining protection on the rest of the worksheet.
+            *
+            * @remarks
+            * [Api set: ExcelApiOnline 1.1]
+            */
+            allowEditRanges?: Excel.Interfaces.AllowEditRangeData[];
+            /**
+             * Specifies if protection can be paused for this worksheet.
+             *
+             * @remarks
+             * [Api set: ExcelApiOnline 1.1]
+             */
+            canPauseProtection?: boolean;
+            /**
+             * Specifies if the sheet is password protected.
+             *
+             * @remarks
+             * [Api set: ExcelApiOnline 1.1]
+             */
+            isPasswordProtected?: boolean;
+            /**
+             * Specifies if worksheet protection is paused.
+             *
+             * @remarks
+             * [Api set: ExcelApiOnline 1.1]
+             */
+            isPaused?: boolean;
             /**
              * Specifies the protection options for the worksheet.
              *
@@ -58129,6 +58567,14 @@ declare namespace Excel {
              * [Api set: ExcelApi 1.2]
              */
             protected?: boolean;
+            /**
+             * Specifies the protection options saved in the worksheet.
+                        This will return the same `WorksheetProtectionOptions` object regardless of the worksheet protection state.
+             *
+             * @remarks
+             * [Api set: ExcelApiOnline 1.1]
+             */
+            savedOptions?: Excel.WorksheetProtectionOptions;
         }
         /** An interface describing the data returned by calling `range.toJSON()`. */
         interface RangeData {
@@ -58275,7 +58721,7 @@ declare namespace Excel {
              */
             linkedDataTypeState?: Excel.LinkedDataTypeState[][];
             /**
-             * Represents Excel's number format code for the given range.
+             * Represents Excel's number format code for the given range. For more information about Excel number formatting, see {@link https://support.microsoft.com/office/number-format-codes-5026bbd6-04bc-48cd-bf33-80f18b4eae68 | Number format codes}.
              *
              * @remarks
              * [Api set: ExcelApi 1.1]
@@ -62607,7 +63053,8 @@ declare namespace Excel {
             */
             font?: Excel.Interfaces.ConditionalRangeFontData;
             /**
-             * Represents Excel's number format code for the given range. Cleared if `null` is passed in.
+             * Represents Excel's number format code for the given range. For more information about Excel number formatting, see {@link https://support.microsoft.com/office/number-format-codes-5026bbd6-04bc-48cd-bf33-80f18b4eae68 | Number format codes}.
+                        Cleared if `null` is passed in.
              *
              * @remarks
              * [Api set: ExcelApi 1.6]
@@ -62865,7 +63312,7 @@ declare namespace Excel {
         /** An interface describing the data returned by calling `tableStyle.toJSON()`. */
         interface TableStyleData {
             /**
-             * Gets the name of the table style.
+             * Specifies the name of the table style.
              *
              * @remarks
              * [Api set: ExcelApi 1.10]
@@ -62886,7 +63333,7 @@ declare namespace Excel {
         /** An interface describing the data returned by calling `pivotTableStyle.toJSON()`. */
         interface PivotTableStyleData {
             /**
-             * Gets the name of the PivotTable style.
+             * Specifies the name of the PivotTable style.
              *
              * @remarks
              * [Api set: ExcelApi 1.10]
@@ -62907,7 +63354,7 @@ declare namespace Excel {
         /** An interface describing the data returned by calling `slicerStyle.toJSON()`. */
         interface SlicerStyleData {
             /**
-             * Gets the name of the slicer style.
+             * Specifies the name of the slicer style.
              *
              * @remarks
              * [Api set: ExcelApi 1.10]
@@ -62928,7 +63375,7 @@ declare namespace Excel {
         /** An interface describing the data returned by calling `timelineStyle.toJSON()`. */
         interface TimelineStyleData {
             /**
-             * Gets the name of the timeline style.
+             * Specifies the name of the timeline style.
              *
              * @remarks
              * [Api set: ExcelApi 1.10]
@@ -64035,6 +64482,84 @@ declare namespace Excel {
              */
             value?: T;
         }
+        /**
+         * Represents an `AllowEditRange` object found in a worksheet. This object works with worksheet protection properties.
+                    When worksheet protection is enabled, an `AllowEditRange` object can be used to allow editing of a specific range, while maintaining protection on the rest of the worksheet.
+         *
+         * @remarks
+         * [Api set: ExcelApiOnline 1.1]
+         */
+        interface AllowEditRangeLoadOptions {
+            /**
+              Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`).
+             */
+            $all?: boolean;
+            /**
+             * Specifies the range associated with the object.
+                        Worksheet protection must be disabled or paused for this method to work properly.
+                        If worksheet protection is enabled and not paused, this method throws an `AccessDenied` error and fails to set the range.
+             *
+             * @remarks
+             * [Api set: ExcelApiOnline 1.1]
+             */
+            address?: boolean;
+            /**
+             * Specifies if the object is password protected.
+             *
+             * @remarks
+             * [Api set: ExcelApiOnline 1.1]
+             */
+            isPasswordProtected?: boolean;
+            /**
+             * Specifies the title of the object.
+                        Worksheet protection must be disabled or paused for this method to work properly.
+                        If worksheet protection is enabled and not paused, this method throws an `AccessDenied` error and fails to set the title.
+                        If there is already an existing `AllowEditRange` with the same string, or if the string is `null` or empty (""), then this method throws an `InvalidArgument` error and fails to set the title.
+             *
+             * @remarks
+             * [Api set: ExcelApiOnline 1.1]
+             */
+            title?: boolean;
+        }
+        /**
+         * Represents the set of `AllowEditRange` objects found in a worksheet. `AllowEditRange` objects work with worksheet protection properties.
+                    When worksheet protection is enabled, an `AllowEditRange` object can be used to allow editing of a specific range, while maintaining protection on the rest of the worksheet.
+         *
+         * @remarks
+         * [Api set: ExcelApiOnline 1.1]
+         */
+        interface AllowEditRangeCollectionLoadOptions {
+            /**
+              Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`).
+             */
+            $all?: boolean;
+            /**
+             * For EACH ITEM in the collection: Specifies the range associated with the object.
+                        Worksheet protection must be disabled or paused for this method to work properly.
+                        If worksheet protection is enabled and not paused, this method throws an `AccessDenied` error and fails to set the range.
+             *
+             * @remarks
+             * [Api set: ExcelApiOnline 1.1]
+             */
+            address?: boolean;
+            /**
+             * For EACH ITEM in the collection: Specifies if the object is password protected.
+             *
+             * @remarks
+             * [Api set: ExcelApiOnline 1.1]
+             */
+            isPasswordProtected?: boolean;
+            /**
+             * For EACH ITEM in the collection: Specifies the title of the object.
+                        Worksheet protection must be disabled or paused for this method to work properly.
+                        If worksheet protection is enabled and not paused, this method throws an `AccessDenied` error and fails to set the title.
+                        If there is already an existing `AllowEditRange` with the same string, or if the string is `null` or empty (""), then this method throws an `InvalidArgument` error and fails to set the title.
+             *
+             * @remarks
+             * [Api set: ExcelApiOnline 1.1]
+             */
+            title?: boolean;
+        }
         /**
          * Represents a Power Query query.
          *
@@ -64711,6 +65236,27 @@ declare namespace Excel {
               Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`).
              */
             $all?: boolean;
+            /**
+             * Specifies if protection can be paused for this worksheet.
+             *
+             * @remarks
+             * [Api set: ExcelApiOnline 1.1]
+             */
+            canPauseProtection?: boolean;
+            /**
+             * Specifies if the sheet is password protected.
+             *
+             * @remarks
+             * [Api set: ExcelApiOnline 1.1]
+             */
+            isPasswordProtected?: boolean;
+            /**
+             * Specifies if worksheet protection is paused.
+             *
+             * @remarks
+             * [Api set: ExcelApiOnline 1.1]
+             */
+            isPaused?: boolean;
             /**
              * Specifies the protection options for the worksheet.
              *
@@ -64725,6 +65271,14 @@ declare namespace Excel {
              * [Api set: ExcelApi 1.2]
              */
             protected?: boolean;
+            /**
+             * Specifies the protection options saved in the worksheet.
+                        This will return the same `WorksheetProtectionOptions` object regardless of the worksheet protection state.
+             *
+             * @remarks
+             * [Api set: ExcelApiOnline 1.1]
+             */
+            savedOptions?: boolean;
         }
         /**
          * Range represents a set of one or more contiguous cells such as a cell, a row, a column, or a block of cells.
@@ -64881,7 +65435,7 @@ declare namespace Excel {
              */
             linkedDataTypeState?: boolean;
             /**
-             * Represents Excel's number format code for the given range.
+             * Represents Excel's number format code for the given range. For more information about Excel number formatting, see {@link https://support.microsoft.com/office/number-format-codes-5026bbd6-04bc-48cd-bf33-80f18b4eae68 | Number format codes}.
              *
              * @remarks
              * [Api set: ExcelApi 1.1]
@@ -71807,7 +72361,8 @@ declare namespace Excel {
             */
             font?: Excel.Interfaces.ConditionalRangeFontLoadOptions;
             /**
-             * Represents Excel's number format code for the given range. Cleared if `null` is passed in.
+             * Represents Excel's number format code for the given range. For more information about Excel number formatting, see {@link https://support.microsoft.com/office/number-format-codes-5026bbd6-04bc-48cd-bf33-80f18b4eae68 | Number format codes}.
+                        Cleared if `null` is passed in.
              *
              * @remarks
              * [Api set: ExcelApi 1.6]
@@ -72304,7 +72859,7 @@ declare namespace Excel {
              */
             $all?: boolean;
             /**
-             * For EACH ITEM in the collection: Gets the name of the table style.
+             * For EACH ITEM in the collection: Specifies the name of the table style.
              *
              * @remarks
              * [Api set: ExcelApi 1.10]
@@ -72330,7 +72885,7 @@ declare namespace Excel {
              */
             $all?: boolean;
             /**
-             * Gets the name of the table style.
+             * Specifies the name of the table style.
              *
              * @remarks
              * [Api set: ExcelApi 1.10]
@@ -72356,7 +72911,7 @@ declare namespace Excel {
              */
             $all?: boolean;
             /**
-             * For EACH ITEM in the collection: Gets the name of the PivotTable style.
+             * For EACH ITEM in the collection: Specifies the name of the PivotTable style.
              *
              * @remarks
              * [Api set: ExcelApi 1.10]
@@ -72382,7 +72937,7 @@ declare namespace Excel {
              */
             $all?: boolean;
             /**
-             * Gets the name of the PivotTable style.
+             * Specifies the name of the PivotTable style.
              *
              * @remarks
              * [Api set: ExcelApi 1.10]
@@ -72408,7 +72963,7 @@ declare namespace Excel {
              */
             $all?: boolean;
             /**
-             * For EACH ITEM in the collection: Gets the name of the slicer style.
+             * For EACH ITEM in the collection: Specifies the name of the slicer style.
              *
              * @remarks
              * [Api set: ExcelApi 1.10]
@@ -72434,7 +72989,7 @@ declare namespace Excel {
              */
             $all?: boolean;
             /**
-             * Gets the name of the slicer style.
+             * Specifies the name of the slicer style.
              *
              * @remarks
              * [Api set: ExcelApi 1.10]
@@ -72460,7 +73015,7 @@ declare namespace Excel {
              */
             $all?: boolean;
             /**
-             * For EACH ITEM in the collection: Gets the name of the timeline style.
+             * For EACH ITEM in the collection: Specifies the name of the timeline style.
              *
              * @remarks
              * [Api set: ExcelApi 1.10]
@@ -72486,7 +73041,7 @@ declare namespace Excel {
              */
             $all?: boolean;
             /**
-             * Gets the name of the timeline style.
+             * Specifies the name of the timeline style.
              *
              * @remarks
              * [Api set: ExcelApi 1.10]
@@ -72970,7 +73525,7 @@ declare namespace Excel {
              */
             linkedDataTypeState?: boolean;
             /**
-             * For EACH ITEM in the collection: Represents Excel's number format code for the given range.
+             * For EACH ITEM in the collection: Represents Excel's number format code for the given range. For more information about Excel number formatting, see {@link https://support.microsoft.com/office/number-format-codes-5026bbd6-04bc-48cd-bf33-80f18b4eae68 | Number format codes}.
              *
              * @remarks
              * [Api set: ExcelApi 1.1]

office-js/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@types/office-js",
-    "version": "1.0.270",
+    "version": "1.0.273",
     "description": "TypeScript definitions for Office.js",
     "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-js",
     "license": "MIT",
@@ -45,6 +45,6 @@
     },
     "scripts": {},
     "dependencies": {},
-    "typesPublisherContentHash": "2db986b698e2118ad69e75fccfbf037f2b97f643b14c21c5f9ab70d3136b80e2",
+    "typesPublisherContentHash": "259cf2bcde08dabe6367345d9072f2ea044b6315871c61a5a1f63ab3b90bb229",
     "typeScriptVersion": "4.0"
 }