@types/office-js-preview 1.0.274 → 1.0.275

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, 14 Dec 2021 23:01:10 GMT
+ * Last updated: Thu, 16 Dec 2021 19:31:14 GMT
  * Dependencies: none
  * Global values: `Excel`, `Office`, `OfficeCore`, `OfficeExtension`, `OneNote`, `PowerPoint`, `Visio`, `Word`
 

office-js-preview/index.d.ts

@@ -82393,7 +82393,7 @@ declare namespace Word {
          */
         readonly contentControls: Word.ContentControlCollection;
         /**
-         * Gets the collection of endnotes in the body. Read-only
+         * Gets the collection of endnotes in the body. Read-only.
          *
          * @remarks
          * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
@@ -82408,7 +82408,7 @@ declare namespace Word {
          */
         readonly font: Word.Font;
         /**
-         * Gets the collection of footnotes in the body. Read-only
+         * Gets the collection of footnotes in the body. Read-only.
          *
          * @remarks
          * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
@@ -82571,6 +82571,26 @@ declare namespace Word {
          * @param rangeLocation Optional. The range location can be 'Whole', 'Start', 'End', 'After', or 'Content'.
          */
         getRange(rangeLocation?: "Whole" | "Start" | "End" | "Before" | "After" | "Content"): Word.Range;
+        /**
+         * Gets reviewed text based on ChangeTrackingVersion selection.
+         *
+         * @remarks
+         * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
+         * @beta
+         *
+         * @param changeTrackingVersion Optional. The changeTrackingVersion can be: Original, Current. The default value is Current.
+         */
+        getReviewedText(changeTrackingVersion?: Word.ChangeTrackingVersion): OfficeExtension.ClientResult<string>;
+        /**
+         * Gets reviewed text based on ChangeTrackingVersion selection.
+         *
+         * @remarks
+         * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
+         * @beta
+         *
+         * @param changeTrackingVersion Optional. The changeTrackingVersion can be: Original, Current. The default value is Current.
+         */
+        getReviewedText(changeTrackingVersion?: "Original" | "Current"): OfficeExtension.ClientResult<string>;
         /**
          * Inserts a break at the specified location in the main document.
          *
@@ -83216,7 +83236,7 @@ declare namespace Word {
          */
         readonly contentControls: Word.ContentControlCollection;
         /**
-         * Gets the collection of endnotes in the contentcontrol. Read-only
+         * Gets the collection of endnotes in the contentcontrol. Read-only.
          *
          * @remarks
          * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
@@ -83231,7 +83251,7 @@ declare namespace Word {
          */
         readonly font: Word.Font;
         /**
-         * Gets the collection of footnotes in the contentcontrol. Read-only
+         * Gets the collection of footnotes in the contentcontrol. Read-only.
          *
          * @remarks
          * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
@@ -83482,6 +83502,26 @@ declare namespace Word {
          * @param rangeLocation Optional. The range location can be 'Whole', 'Before', 'Start', 'End', 'After', or 'Content'.
          */
         getRange(rangeLocation?: "Whole" | "Start" | "End" | "Before" | "After" | "Content"): Word.Range;
+        /**
+         * Gets reviewed text based on ChangeTrackingVersion selection.
+         *
+         * @remarks
+         * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
+         * @beta
+         *
+         * @param changeTrackingVersion Optional. The changeTrackingVersion might be: Original, Current. The default value is Current.
+         */
+        getReviewedText(changeTrackingVersion?: Word.ChangeTrackingVersion): OfficeExtension.ClientResult<string>;
+        /**
+         * Gets reviewed text based on ChangeTrackingVersion selection.
+         *
+         * @remarks
+         * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
+         * @beta
+         *
+         * @param changeTrackingVersion Optional. The changeTrackingVersion might be: Original, Current. The default value is Current.
+         */
+        getReviewedText(changeTrackingVersion?: "Original" | "Current"): OfficeExtension.ClientResult<string>;
         /**
          * Gets the text ranges in the content control by using punctuation marks and/or other ending marks.
          *
@@ -84513,14 +84553,14 @@ declare namespace Word {
         /** 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 body object of the main document. The body is the text that excludes headers, footers, footnotes, textboxes, etc.. Read-only.
+         * Gets the body object of the main document. The body is the text that excludes headers, footers, footnotes, textboxes, etc. Read-only.
          *
          * @remarks
          * [Api set: WordApi 1.1]
          */
         readonly body: Word.Body;
         /**
-         * Gets the collection of content control objects in the document. This includes content controls in the body of the document, headers, footers, textboxes, etc.. Read-only.
+         * Gets the collection of content control objects in the document. This includes content controls in the body of the document, headers, footers, textboxes, etc. Read-only.
          *
          * @remarks
          * [Api set: WordApi 1.1]
@@ -84556,6 +84596,14 @@ declare namespace Word {
          * @beta
          */
         readonly settings: Word.SettingCollection;
+        /**
+         * Gets or sets the ChangeTracking mode.
+         *
+         * @remarks
+         * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
+         * @beta
+         */
+        changeTrackingMode: Word.ChangeTrackingMode | "Off" | "TrackAll" | "TrackMineOnly";
         /**
          * Indicates whether the changes in the document have been saved. A value of true indicates that the document hasn't changed since it was saved. Read-only.
          *
@@ -84602,7 +84650,8 @@ declare namespace Word {
          */
         getBookmarkRangeOrNullObject(name: string): Word.Range;
         /**
-         * Gets the body of the document's endnotes. Read-only
+         * Gets the document's endnotes in a single body. Read-only.
+                    Not implemented in Word on the web.
          *
          * @remarks
          * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
@@ -84610,7 +84659,8 @@ declare namespace Word {
          */
         getEndnoteBody(): Word.Body;
         /**
-         * Gets the body of the document's footnotes. Read-only
+         * Gets the document's footnotes in a single body. Read-only.
+                    Not implemented in Word on the web.
          *
          * @remarks
          * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
@@ -84632,7 +84682,7 @@ declare namespace Word {
          */
         save(): void;
         /**
-         * Performs a search with the specified SearchOptions on the scope of the whole document. The search results are a collection of range objects.
+         * Performs a search with the specified search options on the scope of the whole document. The search results are a collection of range objects.
          *
          * @remarks
          * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
@@ -86008,7 +86058,7 @@ declare namespace Word {
          */
         readonly body: Word.Body;
         /**
-         * Represents a footnote/endnote reference in the main document.
+         * Represents a footnote or endnote reference in the main document.
          *
          * @remarks
          * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
@@ -86016,7 +86066,7 @@ declare namespace Word {
          */
         readonly reference: Word.Range;
         /**
-         * Represent the note item type: footnote or endnote.
+         * Represents the note item type: footnote or endnote.
          *
          * @remarks
          * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
@@ -86167,7 +86217,7 @@ declare namespace Word {
          */
         readonly contentControls: Word.ContentControlCollection;
         /**
-         * Gets the collection of endnotes in the Paragraph. Read-only
+         * Gets the collection of endnotes in the paragraph. Read-only.
          *
          * @remarks
          * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
@@ -86182,7 +86232,7 @@ declare namespace Word {
          */
         readonly font: Word.Font;
         /**
-         * Gets the collection of footnotes in the Paragraph. Read-only
+         * Gets the collection of footnotes in the paragraph. Read-only.
          *
          * @remarks
          * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
@@ -86492,6 +86542,26 @@ declare namespace Word {
          * @param rangeLocation Optional. The range location can be 'Whole', 'Start', 'End', 'After', or 'Content'.
          */
         getRange(rangeLocation?: "Whole" | "Start" | "End" | "Before" | "After" | "Content"): Word.Range;
+        /**
+         * Gets reviewed text based on ChangeTrackingVersion selection.
+         *
+         * @remarks
+         * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
+         * @beta
+         *
+         * @param changeTrackingVersion Optional. The changeTrackingVersion might be: Original, Current. The default value is Current.
+         */
+        getReviewedText(changeTrackingVersion?: Word.ChangeTrackingVersion): OfficeExtension.ClientResult<string>;
+        /**
+         * Gets reviewed text based on ChangeTrackingVersion selection.
+         *
+         * @remarks
+         * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
+         * @beta
+         *
+         * @param changeTrackingVersion Optional. The changeTrackingVersion might be: Original, Current. The default value is Current.
+         */
+        getReviewedText(changeTrackingVersion?: "Original" | "Current"): OfficeExtension.ClientResult<string>;
         /**
          * Gets the text ranges in the paragraph by using punctuation marks and/or other ending marks.
          *
@@ -86850,7 +86920,7 @@ declare namespace Word {
          */
         readonly contentControls: Word.ContentControlCollection;
         /**
-         * Gets the collection of endnotes in the Range. Read-only
+         * Gets the collection of endnotes in the range. Read-only.
          *
          * @remarks
          * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
@@ -86865,7 +86935,7 @@ declare namespace Word {
          */
         readonly font: Word.Font;
         /**
-         * Gets the collection of footnotes in the Range. Read-only
+         * Gets the collection of footnotes in the range. Read-only.
          *
          * @remarks
          * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
@@ -87115,6 +87185,26 @@ declare namespace Word {
          * @param rangeLocation Optional. The range location can be 'Whole', 'Start', 'End', 'After', or 'Content'.
          */
         getRange(rangeLocation?: "Whole" | "Start" | "End" | "Before" | "After" | "Content"): Word.Range;
+        /**
+         * Gets reviewed text based on ChangeTrackingVersion selection.
+         *
+         * @remarks
+         * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
+         * @beta
+         *
+         * @param changeTrackingVersion Optional. The changeTrackingVersion might be: Original, Current. The default value is Current.
+         */
+        getReviewedText(changeTrackingVersion?: Word.ChangeTrackingVersion): OfficeExtension.ClientResult<string>;
+        /**
+         * Gets reviewed text based on ChangeTrackingVersion selection.
+         *
+         * @remarks
+         * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
+         * @beta
+         *
+         * @param changeTrackingVersion Optional. The changeTrackingVersion might be: Original, Current. The default value is Current.
+         */
+        getReviewedText(changeTrackingVersion?: "Original" | "Current"): OfficeExtension.ClientResult<string>;
         /**
          * Gets the text child ranges in the range by using punctuation marks and/or other ending marks.
          *
@@ -87934,7 +88024,7 @@ declare namespace Word {
         /** 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 collection of endnotes in the table. Read-only
+         * Gets the collection of endnotes in the table. Read-only.
          *
          * @remarks
          * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
@@ -87949,7 +88039,7 @@ declare namespace Word {
          */
         readonly font: Word.Font;
         /**
-         * Gets the collection of footnotes in the table. Read-only
+         * Gets the collection of footnotes in the table. Read-only.
          *
          * @remarks
          * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
@@ -88583,7 +88673,7 @@ declare namespace Word {
          */
         readonly cells: Word.TableCellCollection;
         /**
-         * Gets the collection of endnotes in the table row. Read-only
+         * Gets the collection of endnotes in the table row. Read-only.
          *
          * @remarks
          * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
@@ -88598,7 +88688,7 @@ declare namespace Word {
          */
         readonly font: Word.Font;
         /**
-         * Gets the collection of footnotes in the table row. Read-only
+         * Gets the collection of footnotes in the table row. Read-only.
          *
          * @remarks
          * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
@@ -89324,6 +89414,50 @@ declare namespace Word {
         */
         toJSON(): Word.Interfaces.TableBorderData;
     }
+    /**
+     * ChangeTracking mode.
+     *
+     * @remarks
+     * [Api set: WordApi]
+     */
+    enum ChangeTrackingMode {
+        /**
+         * ChangeTracking is turned off.
+         * @remarks
+         * [Api set: WordApi]
+         */
+        off = "Off",
+        /**
+         * ChangeTracking is turned on for everyone.
+         * @remarks
+         * [Api set: WordApi]
+         */
+        trackAll = "TrackAll",
+        /**
+         * Tracking is turned on for my changes only.
+         * @remarks
+         * [Api set: WordApi]
+         */
+        trackMineOnly = "TrackMineOnly",
+    }
+    /**
+     * Specify the current version or the original version of the document.
+     *
+     * @remarks
+     * [Api set: WordApi]
+     */
+    enum ChangeTrackingVersion {
+        /**
+         * @remarks
+         * [Api set: WordApi]
+         */
+        original = "Original",
+        /**
+         * @remarks
+         * [Api set: WordApi]
+         */
+        current = "Current",
+    }
     /**
      * Note item type
      *
@@ -91492,7 +91626,7 @@ declare namespace Word {
         /** An interface for updating data on the Document object, for use in `document.set({ ... })`. */
         interface DocumentUpdateData {
             /**
-            * Gets the body object of the main document. The body is the text that excludes headers, footers, footnotes, textboxes, etc..
+            * Gets the body object of the main document. The body is the text that excludes headers, footers, footnotes, textboxes, etc.
             *
             * @remarks
             * [Api set: WordApi 1.1]
@@ -91505,6 +91639,14 @@ declare namespace Word {
             * [Api set: WordApi 1.3]
             */
             properties?: Word.Interfaces.DocumentPropertiesUpdateData;
+            /**
+             * Gets or sets the ChangeTracking mode.
+             *
+             * @remarks
+             * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
+             * @beta
+             */
+            changeTrackingMode?: Word.ChangeTrackingMode | "Off" | "TrackAll" | "TrackMineOnly";
         }
         /** An interface for updating data on the DocumentCreated object, for use in `documentCreated.set({ ... })`. */
         interface DocumentCreatedUpdateData {
@@ -91744,7 +91886,7 @@ declare namespace Word {
             */
             body?: Word.Interfaces.BodyUpdateData;
             /**
-            * Represents a footnote/endnote reference in the main document.
+            * Represents a footnote or endnote reference in the main document.
             *
             * @remarks
             * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
@@ -92614,14 +92756,14 @@ declare namespace Word {
         /** An interface describing the data returned by calling `document.toJSON()`. */
         interface DocumentData {
             /**
-            * Gets the body object of the main document. The body is the text that excludes headers, footers, footnotes, textboxes, etc.. Read-only.
+            * Gets the body object of the main document. The body is the text that excludes headers, footers, footnotes, textboxes, etc. Read-only.
             *
             * @remarks
             * [Api set: WordApi 1.1]
             */
             body?: Word.Interfaces.BodyData;
             /**
-            * Gets the collection of content control objects in the document. This includes content controls in the body of the document, headers, footers, textboxes, etc.. Read-only.
+            * Gets the collection of content control objects in the document. This includes content controls in the body of the document, headers, footers, textboxes, etc. Read-only.
             *
             * @remarks
             * [Api set: WordApi 1.1]
@@ -92657,6 +92799,14 @@ declare namespace Word {
             * @beta
             */
             settings?: Word.Interfaces.SettingData[];
+            /**
+             * Gets or sets the ChangeTracking mode.
+             *
+             * @remarks
+             * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
+             * @beta
+             */
+            changeTrackingMode?: Word.ChangeTrackingMode | "Off" | "TrackAll" | "TrackMineOnly";
             /**
              * Indicates whether the changes in the document have been saved. A value of true indicates that the document hasn't changed since it was saved. Read-only.
              *
@@ -93056,7 +93206,7 @@ declare namespace Word {
             */
             body?: Word.Interfaces.BodyData;
             /**
-            * Represents a footnote/endnote reference in the main document.
+            * Represents a footnote or endnote reference in the main document.
             *
             * @remarks
             * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
@@ -93064,7 +93214,7 @@ declare namespace Word {
             */
             reference?: Word.Interfaces.RangeData;
             /**
-             * Represent the note item type: footnote or endnote.
+             * Represents the note item type: footnote or endnote.
              *
              * @remarks
              * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
@@ -94516,7 +94666,7 @@ declare namespace Word {
              */
             $all?: boolean;
             /**
-            * Gets the body object of the main document. The body is the text that excludes headers, footers, footnotes, textboxes, etc..
+            * Gets the body object of the main document. The body is the text that excludes headers, footers, footnotes, textboxes, etc.
             *
             * @remarks
             * [Api set: WordApi 1.1]
@@ -94529,6 +94679,14 @@ declare namespace Word {
             * [Api set: WordApi 1.3]
             */
             properties?: Word.Interfaces.DocumentPropertiesLoadOptions;
+            /**
+             * Gets or sets the ChangeTracking mode.
+             *
+             * @remarks
+             * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
+             * @beta
+             */
+            changeTrackingMode?: boolean;
             /**
              * Indicates whether the changes in the document have been saved. A value of true indicates that the document hasn't changed since it was saved. Read-only.
              *
@@ -95133,7 +95291,7 @@ declare namespace Word {
             */
             body?: Word.Interfaces.BodyLoadOptions;
             /**
-            * Represents a footnote/endnote reference in the main document.
+            * Represents a footnote or endnote reference in the main document.
             *
             * @remarks
             * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
@@ -95141,7 +95299,7 @@ declare namespace Word {
             */
             reference?: Word.Interfaces.RangeLoadOptions;
             /**
-             * Represent the note item type: footnote or endnote.
+             * Represents the note item type: footnote or endnote.
              *
              * @remarks
              * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
@@ -95170,7 +95328,7 @@ declare namespace Word {
             */
             body?: Word.Interfaces.BodyLoadOptions;
             /**
-            * For EACH ITEM in the collection: Represents a footnote/endnote reference in the main document.
+            * For EACH ITEM in the collection: Represents a footnote or endnote reference in the main document.
             *
             * @remarks
             * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
@@ -95178,7 +95336,7 @@ declare namespace Word {
             */
             reference?: Word.Interfaces.RangeLoadOptions;
             /**
-             * For EACH ITEM in the collection: Represent the note item type: footnote or endnote.
+             * For EACH ITEM in the collection: Represents the note item type: footnote or endnote.
              *
              * @remarks
              * [Api set: WordApiOnline BETA (PREVIEW ONLY)]

office-js-preview/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@types/office-js-preview",
-    "version": "1.0.274",
+    "version": "1.0.275",
     "description": "TypeScript definitions for Office.js",
     "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-js-preview",
     "license": "MIT",
@@ -40,6 +40,6 @@
     },
     "scripts": {},
     "dependencies": {},
-    "typesPublisherContentHash": "6007e8f89acfcf9767786a2f205279954353b6fba3ed605e236b06ea2d0c6aba",
+    "typesPublisherContentHash": "02eb8fd2b83bc013408a1321dfaa484695151768bef6f822a54d2c82759fae58",
     "typeScriptVersion": "3.8"
 }