@types/office-js-preview 1.0.352 → 1.0.354

office-js-preview/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-preview.
 
 ### Additional Details
- * Last updated: Tue, 08 Nov 2022 20:51:48 GMT
+ * Last updated: Mon, 14 Nov 2022 16:32:54 GMT
  * Dependencies: none
  * Global values: `Excel`, `Office`, `OfficeCore`, `OfficeExtension`, `OneNote`, `PowerPoint`, `Visio`, `Word`
 

office-js-preview/index.d.ts

@@ -13406,7 +13406,7 @@ declare namespace Office {
      * The `InternetHeaders` object represents custom internet headers that are preserved after the message item leaves Exchange
      * and is converted to a MIME message. These headers are stored as x-headers in the MIME message.
      *
-     * Internet headers are stored as key/value pairs on a per-item basis.
+     * Internet headers are stored as string key-value pairs on a per-item basis.
      *
      * **Note**: This object is intended for you to set and get your custom headers on a message item. To learn more, see
      * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/internet-headers | Get and set internet headers on a message in an Outlook add-in}.
@@ -13436,8 +13436,8 @@ declare namespace Office {
      */
     interface InternetHeaders {
         /**
-         * Given an array of internet header names, this method returns a dictionary containing those internet headers and their values.
-         * If the add-in requests an x-header that is not available, that x-header will not be returned in the results.
+         * Given an array of internet header names, this method returns a record containing those internet headers and their values.
+         * If the add-in requests an x-header that isn't available, that x-header will not be returned in the results.
          *
          * **Note**: This method is intended to return the values of the custom headers you set using the `setAsync` method.
          *
@@ -13451,13 +13451,14 @@ declare namespace Office {
          * @param names - The names of the internet headers to be returned.
          * @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 function.
-         * @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.
+         * @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter,
+         *                `asyncResult`, of type `Office.AsyncResult`. The string key-value pairs of internet headers are returned in the
+         *                `asyncResult.value` property. Any errors encountered are provided in the `asyncResult.error` property.
          */
-        getAsync(names: string[], options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<InternetHeaders>) => void): void;
+        getAsync(names: string[], options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<Record<string, string>>) => void): void;
         /**
-         * Given an array of internet header names, this method returns a dictionary containing those internet headers and their values.
-         * If the add-in requests an x-header that is not available, that x-header will not be returned in the results.
+         * Given an array of internet header names, this method returns a record containing those internet headers and their values.
+         * If the add-in requests an x-header that isn't available, that x-header will not be returned in the results.
          *
          * **Note**: This method is intended to return the values of the custom headers you set using the `setAsync` method.
          *
@@ -13469,10 +13470,11 @@ declare namespace Office {
          * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
          *
          * @param names - The names of the internet headers to be returned.
-         * @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.
+         * @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter,
+         *                `asyncResult`, of type `Office.AsyncResult`. The string key-value pairs of internet headers are returned in the
+         *                `asyncResult.value` property. Any errors encountered are provided in the `asyncResult.error` property.
          */
-        getAsync(names: string[], callback?: (asyncResult: Office.AsyncResult<InternetHeaders>) => void): void;
+        getAsync(names: string[], callback: (asyncResult: Office.AsyncResult<Record<string, string>>) => void): void;
         /**
          * Given an array of internet header names, this method removes the specified headers from the internet header collection.
          *
@@ -13489,9 +13491,9 @@ declare namespace Office {
          * @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 function.
          * @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.
+         *                `asyncResult`, of type `Office.AsyncResult`. Any errors encountered are provided in the `asyncResult.error` property.
          */
-        removeAsync(names: string[], options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<InternetHeaders>) => void): void;
+        removeAsync(names: string[], options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
         /**
          * Given an array of internet header names, this method removes the specified headers from the internet header collection.
          *
@@ -13506,9 +13508,9 @@ declare namespace Office {
          *
          * @param names - The names of the internet headers to be removed.
          * @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.
+         *                `asyncResult`, of type `Office.AsyncResult`. Any errors encountered are provided in the `asyncResult.error` property.
          */
-        removeAsync(names: string[], callback?: (asyncResult: Office.AsyncResult<InternetHeaders>) => void): void;
+        removeAsync(names: string[], callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
         /**
          * Sets the specified internet headers to the specified values.
          *
@@ -13530,14 +13532,14 @@ declare namespace Office {
          *
          * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
          *
-         * @param headers - The names and corresponding values of the headers to be set. Should be a dictionary object with keys being the names of the
-         *                internet headers and values being the values of the internet headers.
+         * @param headers - The names and corresponding values of the headers to be set. This should be a record object with its keys being internet header names
+         *                and values being the corresponding header value strings.
          * @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 function.
-         * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter
-         *                             of type Office.AsyncResult. Any errors encountered will be provided in the `asyncResult.error` property.
+         * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter,
+         *                 `asyncResult`, of type `Office.AsyncResult`. Any errors encountered are provided in the `asyncResult.error` property.
          */
-        setAsync(headers: Object, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
+        setAsync(headers: Record<string, string>, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
         /**
          * Sets the specified internet headers to the specified values.
          *
@@ -13559,12 +13561,12 @@ declare namespace Office {
          *
          * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
          *
-         * @param headers - The names and corresponding values of the headers to be set. Should be a dictionary object with keys being the names of the
-         *                internet headers and values being the values of the internet headers.
-         * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter
-         *                             of type Office.AsyncResult. Any errors encountered will be provided in the `asyncResult.error` property.
+         * @param headers - The names and corresponding values of the headers to be set. This should be a record object with its keys being internet header names
+         *                and values being the corresponding header value strings.
+         * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter,
+         *                 `asyncResult`, of type `Office.AsyncResult`. Any errors encountered are provided in the `asyncResult.error` property.
          */
-        setAsync(headers: Object, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
+        setAsync(headers: Record<string, string>, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
     }
     /**
      * The item namespace is used to access the currently selected message, meeting request, or appointment.
@@ -112040,8 +112042,7 @@ declare namespace PowerPoint {
                     If no shapes are selected, an empty collection is returned.
          *
          * @remarks
-         * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
-         * @beta
+         * [Api set: PowerPointApi 1.5]
          */
         getSelectedShapes(): PowerPoint.ShapeScopedCollection;
         /**
@@ -112050,8 +112051,7 @@ declare namespace PowerPoint {
                     If no slides are selected, an empty collection is returned.
          *
          * @remarks
-         * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
-         * @beta
+         * [Api set: PowerPointApi 1.5]
          */
         getSelectedSlides(): PowerPoint.SlideScopedCollection;
         /**
@@ -112059,8 +112059,7 @@ declare namespace PowerPoint {
                     Throws an exception if no text is selected.
          *
          * @remarks
-         * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
-         * @beta
+         * [Api set: PowerPointApi 1.5]
          */
         getSelectedTextRange(): PowerPoint.TextRange;
         /**
@@ -112068,8 +112067,7 @@ declare namespace PowerPoint {
                     If no text is selected, an object with an `isNullObject` property set to `true` is returned.
          *
          * @remarks
-         * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
-         * @beta
+         * [Api set: PowerPointApi 1.5]
          */
         getSelectedTextRangeOrNullObject(): PowerPoint.TextRange;
         /**
@@ -112086,8 +112084,7 @@ declare namespace PowerPoint {
          * Selects the slides in the current view of the presentation. Existing slide selection is replaced with the new selection.
          *
          * @remarks
-         * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
-         * @beta
+         * [Api set: PowerPointApi 1.5]
          *
          * @param slideIds List of slide IDs to select in the presentation. If the list is empty, selection is cleared.
          */
@@ -114002,8 +113999,7 @@ declare namespace PowerPoint {
          * Selects the specified shapes. Existing shape selection is replaced with the new selection.
          *
          * @remarks
-         * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
-         * @beta
+         * [Api set: PowerPointApi 1.5]
          *
          * @param shapeIds List of shape IDs to select in the slide. If the list is empty, the selection is cleared.
          */
@@ -114680,8 +114676,7 @@ declare namespace PowerPoint {
                     Throws an `InvalidArgument` exception when set with a negative value or if the value is greater than the length of the available text from the starting point.
          *
          * @remarks
-         * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
-         * @beta
+         * [Api set: PowerPointApi 1.5]
          */
         length: number;
         /**
@@ -114689,8 +114684,7 @@ declare namespace PowerPoint {
                     Throws an `InvalidArgument` exception when set with a negative value or if the value is greater than the length of the text.
          *
          * @remarks
-         * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
-         * @beta
+         * [Api set: PowerPointApi 1.5]
          */
         start: number;
         /**
@@ -114704,8 +114698,7 @@ declare namespace PowerPoint {
          * Returns the parent {@link PowerPoint.TextFrame} object that holds this `TextRange`.
          *
          * @remarks
-         * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
-         * @beta
+         * [Api set: PowerPointApi 1.5]
          */
         getParentTextFrame(): PowerPoint.TextFrame;
         /**
@@ -114722,8 +114715,7 @@ declare namespace PowerPoint {
          * Selects this `TextRange` in the current view.
          *
          * @remarks
-         * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
-         * @beta
+         * [Api set: PowerPointApi 1.5]
          */
         setSelected(): void;
         /**
@@ -114836,8 +114828,7 @@ declare namespace PowerPoint {
          * Returns the parent {@link PowerPoint.Shape} object that holds this `TextFrame`.
          *
          * @remarks
-         * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
-         * @beta
+         * [Api set: PowerPointApi 1.5]
          */
         getParentShape(): PowerPoint.Shape;
         /**
@@ -114964,48 +114955,42 @@ declare namespace PowerPoint {
          * Returns the parent {@link PowerPoint.Slide} object that holds this `Shape`. Throws an exception if this shape does not belong to a `Slide`.
          *
          * @remarks
-         * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
-         * @beta
+         * [Api set: PowerPointApi 1.5]
          */
         getParentSlide(): PowerPoint.Slide;
         /**
          * Returns the parent {@link PowerPoint.SlideLayout} object that holds this `Shape`. Throws an exception if this shape does not belong to a `SlideLayout`.
          *
          * @remarks
-         * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
-         * @beta
+         * [Api set: PowerPointApi 1.5]
          */
         getParentSlideLayout(): PowerPoint.SlideLayout;
         /**
          * Returns the parent {@link PowerPoint.SlideLayout} object that holds this `Shape`. If this shape does not belong to a `SlideLayout`, an object with an `isNullObject` property set to `true` is returned.
          *
          * @remarks
-         * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
-         * @beta
+         * [Api set: PowerPointApi 1.5]
          */
         getParentSlideLayoutOrNullObject(): PowerPoint.SlideLayout;
         /**
          * Returns the parent {@link PowerPoint.SlideMaster} object that holds this `Shape`. Throws an exception if this shape does not belong to a `SlideMaster`.
          *
          * @remarks
-         * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
-         * @beta
+         * [Api set: PowerPointApi 1.5]
          */
         getParentSlideMaster(): PowerPoint.SlideMaster;
         /**
          * Returns the parent {@link PowerPoint.SlideMaster} object that holds this `Shape`. If this shape does not belong to a `SlideMaster`, an object with an `isNullObject` property set to `true` is returned.
          *
          * @remarks
-         * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
-         * @beta
+         * [Api set: PowerPointApi 1.5]
          */
         getParentSlideMasterOrNullObject(): PowerPoint.SlideMaster;
         /**
          * Returns the parent {@link PowerPoint.Slide} object that holds this `Shape`. If this shape does not belong to a `Slide`, an object with an `isNullObject` property set to `true` is returned.
          *
          * @remarks
-         * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
-         * @beta
+         * [Api set: PowerPointApi 1.5]
          */
         getParentSlideOrNullObject(): PowerPoint.Slide;
         /**
@@ -115039,8 +115024,7 @@ declare namespace PowerPoint {
      * Represents a collection of shapes.
      *
      * @remarks
-     * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
-     * @beta
+     * [Api set: PowerPointApi 1.5]
      */
     class ShapeScopedCollection extends OfficeExtension.ClientObject {
         /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
@@ -115051,8 +115035,7 @@ declare namespace PowerPoint {
          * Gets the number of shapes in the collection.
          *
          * @remarks
-         * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
-         * @beta
+         * [Api set: PowerPointApi 1.5]
          * @returns The number of shapes in the collection.
          */
         getCount(): OfficeExtension.ClientResult<number>;
@@ -115060,8 +115043,7 @@ declare namespace PowerPoint {
          * Gets a shape using its unique ID. An error is thrown if the shape does not exist.
          *
          * @remarks
-         * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
-         * @beta
+         * [Api set: PowerPointApi 1.5]
          *
          * @param key The ID of the shape.
          * @returns The shape with the unique ID. If such a shape does not exist, an error is thrown.
@@ -115071,8 +115053,7 @@ declare namespace PowerPoint {
          * Gets a shape using its zero-based index in the collection. An error is thrown if the index is out of range.
          *
          * @remarks
-         * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
-         * @beta
+         * [Api set: PowerPointApi 1.5]
          *
          * @param index The index of the shape in the collection.
          * @returns The shape at the given index. An error is thrown if index is out of range.
@@ -115082,8 +115063,7 @@ declare namespace PowerPoint {
          * Gets a shape using its unique ID. If such a shape does not exist, an object with an `isNullObject` property set to true is returned.
          *
          * @remarks
-         * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
-         * @beta
+         * [Api set: PowerPointApi 1.5]
          *
          * @param id The ID of the shape.
          * @returns The shape with the unique ID. If such a shape does not exist, an object with an `isNullObject` property set to true is returned.
@@ -115202,8 +115182,7 @@ declare namespace PowerPoint {
      * Represents a collection of slides in the presentation.
      *
      * @remarks
-     * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
-     * @beta
+     * [Api set: PowerPointApi 1.5]
      */
     class SlideScopedCollection extends OfficeExtension.ClientObject {
         /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
@@ -115214,8 +115193,7 @@ declare namespace PowerPoint {
          * Gets the number of slides in the collection.
          *
          * @remarks
-         * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
-         * @beta
+         * [Api set: PowerPointApi 1.5]
          * @returns The number of slides in the collection.
          */
         getCount(): OfficeExtension.ClientResult<number>;
@@ -115223,8 +115201,7 @@ declare namespace PowerPoint {
          * Gets a slide using its unique ID.
          *
          * @remarks
-         * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
-         * @beta
+         * [Api set: PowerPointApi 1.5]
          *
          * @param key The ID of the slide.
          * @returns The slide with the unique ID. If such a slide does not exist, an error is thrown.
@@ -115234,8 +115211,7 @@ declare namespace PowerPoint {
          * Gets a slide using its zero-based index in the collection.
          *
          * @remarks
-         * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
-         * @beta
+         * [Api set: PowerPointApi 1.5]
          *
          * @param index The index of the slide in the collection.
          * @returns The slide at the given index. An error is thrown if index is out of range.
@@ -115247,8 +115223,7 @@ declare namespace PowerPoint {
                     and properties}.
          *
          * @remarks
-         * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
-         * @beta
+         * [Api set: PowerPointApi 1.5]
          *
          * @param id The ID of the slide.
          * @returns The slide with the unique ID.
@@ -115525,8 +115500,7 @@ declare namespace PowerPoint {
                         Throws an `InvalidArgument` exception when set with a negative value or if the value is greater than the length of the available text from the starting point.
              *
              * @remarks
-             * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
-             * @beta
+             * [Api set: PowerPointApi 1.5]
              */
             length?: number;
             /**
@@ -115534,8 +115508,7 @@ declare namespace PowerPoint {
                         Throws an `InvalidArgument` exception when set with a negative value or if the value is greater than the length of the text.
              *
              * @remarks
-             * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
-             * @beta
+             * [Api set: PowerPointApi 1.5]
              */
             start?: number;
             /**
@@ -115870,8 +115843,7 @@ declare namespace PowerPoint {
                         Throws an `InvalidArgument` exception when set with a negative value or if the value is greater than the length of the available text from the starting point.
              *
              * @remarks
-             * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
-             * @beta
+             * [Api set: PowerPointApi 1.5]
              */
             length?: number;
             /**
@@ -115879,8 +115851,7 @@ declare namespace PowerPoint {
                         Throws an `InvalidArgument` exception when set with a negative value or if the value is greater than the length of the text.
              *
              * @remarks
-             * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
-             * @beta
+             * [Api set: PowerPointApi 1.5]
              */
             start?: number;
             /**
@@ -116490,8 +116461,7 @@ declare namespace PowerPoint {
                         Throws an `InvalidArgument` exception when set with a negative value or if the value is greater than the length of the available text from the starting point.
              *
              * @remarks
-             * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
-             * @beta
+             * [Api set: PowerPointApi 1.5]
              */
             length?: boolean;
             /**
@@ -116499,8 +116469,7 @@ declare namespace PowerPoint {
                         Throws an `InvalidArgument` exception when set with a negative value or if the value is greater than the length of the text.
              *
              * @remarks
-             * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
-             * @beta
+             * [Api set: PowerPointApi 1.5]
              */
             start?: boolean;
             /**
@@ -116672,8 +116641,7 @@ declare namespace PowerPoint {
          * Represents a collection of shapes.
          *
          * @remarks
-         * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
-         * @beta
+         * [Api set: PowerPointApi 1.3]
          */
         interface ShapeScopedCollectionLoadOptions {
             /**
@@ -116788,8 +116756,7 @@ declare namespace PowerPoint {
          * Represents a collection of slides in the presentation.
          *
          * @remarks
-         * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
-         * @beta
+         * [Api set: PowerPointApi 1.2]
          */
         interface SlideScopedCollectionLoadOptions {
             /**

office-js-preview/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@types/office-js-preview",
-    "version": "1.0.352",
+    "version": "1.0.354",
     "description": "TypeScript definitions for Office.js",
     "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-js-preview",
     "license": "MIT",
@@ -45,6 +45,6 @@
     },
     "scripts": {},
     "dependencies": {},
-    "typesPublisherContentHash": "6fd9cd2e042a84f93385c020dc4d5028a49f01e6e2fa9320d0b03a9cfd001e58",
+    "typesPublisherContentHash": "6ffd19341915560b80ce21bd528ad247fdb107201ef1eb04ab079944ab75f2fb",
     "typeScriptVersion": "4.1"
 }