@types/office-js-preview 1.0.405 → 1.0.407

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 Aug 2023 21:03:03 GMT
+ * Last updated: Thu, 17 Aug 2023 21:32:55 GMT
  * Dependencies: none
  * Global values: `Excel`, `Office`, `OfficeCore`, `OfficeExtension`, `OneNote`, `PowerPoint`, `Visio`, `Word`
 

office-js-preview/index.d.ts

@@ -1135,7 +1135,7 @@ declare namespace Office {
              * When you use the {@link https://learn.microsoft.com/javascript/api/office/office.addincommands.event#office-office-addincommands-event-completed-member(1) | completed method}
              * to signal that a reported message has finished processing, this property specifies the Outlook mailbox folder to which the message will be moved.
              *
-             * **Important**: Only applicable to add-ins that implement the {@link https://learn.microsoft.com/office/dev/add-ins/outlook/spam-reporting | integrated spam reporting feature}.
+             * **Important**: Only applicable to add-ins that implement the {@link https://learn.microsoft.com/office/dev/add-ins/outlook/spam-reporting | integrated spam-reporting feature}.
              *
              * @remarks
              *
@@ -1156,13 +1156,40 @@ declare namespace Office {
              * @beta
              */
             folderName?: string;
+            /**
+             * When you use the {@link https://learn.microsoft.com/javascript/api/office/office.addincommands.event#office-office-addincommands-event-completed-member(1) | completed method}
+             * to signal that a reported message has finished processing, this property specifies whether the message is moved to a different folder in the mailbox.
+             *
+             * **Important**: Only applicable to add-ins that implement the {@link https://learn.microsoft.com/office/dev/add-ins/outlook/spam-reporting | integrated spam-reporting feature}.
+             *
+             * @remarks
+             *
+             * [Api set: Mailbox preview]
+             *
+             * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level (Outlook)}**: **read item**
+             *
+             * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read
+             *
+             * **Important**:
+             *
+             * In Outlook on Windows, you can only use this property in a spam-reporting add-in starting in Version 2308 (Build 16724.10000).
+             * If you're using an earlier build that supports the integrated spam-reporting feature, use the `postProcessingAction`
+             * property instead.
+             *
+             * If the property is set to `Office.MailboxEnums.MoveSpamItemTo.CustomFolder`, you must specify the name of the folder to which
+             * the message will be moved in the `folderName` property of the `event.completed` call. Otherwise, the `moveItemTo` property will default to
+             * `Office.MailboxEnums.MoveSpamItemTo.JunkFolder` and move the reported message to the **Junk Email** folder.
+             *
+             * @beta
+             */
+            moveItemTo?: Office.MailboxEnums.MoveSpamItemTo;
             /**
              * When set to `true`, deletes a reported message if an error occurs while the message is processed.
              * If this property is set to `false` or isn't specified in the
              * {@link https://learn.microsoft.com/javascript/api/office/office.addincommands.event#office-office-addincommands-event-completed-member(1) | completed method},
              * the reported message remains in its current mailbox folder.
              *
-             * **Important**: Only applicable to add-ins that implement the {@link https://learn.microsoft.com/office/dev/add-ins/outlook/spam-reporting | integrated spam reporting feature}.
+             * **Important**: Only applicable to add-ins that implement the {@link https://learn.microsoft.com/office/dev/add-ins/outlook/spam-reporting | integrated spam-reporting feature}.
              *
              * @remarks
              *
@@ -1177,17 +1204,18 @@ declare namespace Office {
             onErrorDeleteItem?: boolean;
             /**
              * When you use the {@link https://learn.microsoft.com/javascript/api/office/office.addincommands.event#office-office-addincommands-event-completed-member(1) | completed method}
-             * to signal that a reported message has finished processing, this property specifies the next action to be performed on the message. The following post-processing actions are available:
+             * to signal that a reported message has finished processing, this property specifies whether the message is moved to a different folder in the mailbox.
+             * The following post-processing actions are available.
              *
-             * - `delete` - Deletes the reported message.
+             * - `delete` - Moves the reported message to the **Deleted Items** folder of the mailbox.
              *
              * - `moveToCustomFolder` - Moves the reported message to a specified folder. You must specify the name of the folder in the `folderName` property.
              *
-             * - `moveToSpamFolder` - Moves the reported message to the Junk Email folder of the mailbox.
+             * - `moveToSpamFolder` - Moves the reported message to the **Junk Email** folder of the mailbox.
              *
              * - `noMove` - Leaves the reported message in its current folder.
              *
-             * **Important**: Only applicable to add-ins that implement the {@link https://learn.microsoft.com/office/dev/add-ins/outlook/spam-reporting | integrated spam reporting feature}.
+             * **Important**: Only applicable to add-ins that implement the {@link https://learn.microsoft.com/office/dev/add-ins/outlook/spam-reporting | integrated spam-reporting feature}.
              *
              * @remarks
              *
@@ -1197,9 +1225,14 @@ declare namespace Office {
              *
              * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read
              *
-             * **Important**: If the property is set to `moveToCustomFolder`, you must specify the name of the folder to which the message will be moved in the `folderName`
-             * property of the `event.completed` call. Otherwise, the `postProcessingAction` property will default to `moveToSpamFolder` and move the reported message to the
-             * Junk Email folder.
+             * **Important**:
+             *
+             * In Outlook on Windows, you can only use this property in earlier builds that support the integrated spam-reporting feature.
+             * If you're on Version 2308 (Build 16724.10000) or later, use the `moveItemTo` property instead.
+             *
+             * If the property is set to `moveToCustomFolder`, you must specify the name of the folder to which
+             * the message will be moved in the `folderName` property of the `event.completed` call. Otherwise, the `postProcessingAction` property will default to
+             * `moveToSpamFolder` and move the reported message to the **Junk Email** folder.
              *
              * @beta
              */
@@ -1209,7 +1242,7 @@ declare namespace Office {
              * to signal that a reported message has finished processing, this property indicates if a post-processing dialog is shown to the user. The JSON object assigned to this property
              * must contain a title and a description. If this property isn't specified, a dialog isn't shown to the user once their reported message is processed. 
              *
-             * **Important**: Only applicable to add-ins that implement the {@link https://learn.microsoft.com/office/dev/add-ins/outlook/spam-reporting | integrated spam reporting feature}.
+             * **Important**: Only applicable to add-ins that implement the {@link https://learn.microsoft.com/office/dev/add-ins/outlook/spam-reporting | integrated spam-reporting feature}.
              *
              * @remarks
              *
@@ -9038,6 +9071,44 @@ declare namespace Office {
              */
             Dec = "dec"
         }
+        /**
+         * Specifies the folder to which a reported spam or phishing message is moved once it's processed by a spam-reporting add-in.
+         *
+         * To learn more about the integrated spam-reporting feature, see
+         * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/spam-reporting | Implement an integrated spam-reporting add-in (preview)}.
+         *
+         * @remarks
+         * [Api set: Mailbox preview]
+         *
+         * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read
+         *
+         * **Important**: This enum can only be used to assign values to the
+         * {@link https://learn.microsoft.com/javascript/api/office/office.addincommands.eventcompletedoptions?view=outlook-js-preview&preserve-view=true#office-office-addincommands-eventcompletedoptions-moveitemto-member |
+         * moveItemTo} property of the `event.completed` method. If you're on an Outlook on Windows version that only supports the `postProcessingAction` property,
+         * you must assign it different string values. For a list of supported string values, see
+         * {@link https://learn.microsoft.com/javascript/api/office/office.addincommands.eventcompletedoptions?view=outlook-js-preview&preserve-view=true#office-office-addincommands-eventcompletedoptions-postprocessingaction-member |
+         * Office.AddinCommands.EventCompletedOptions.postProcessingAction}.
+         *
+         * @beta
+         */
+        enum MoveSpamItemTo {
+            /**
+             * Specifies that a reported message is moved to a custom folder in the mailbox.
+             */
+            CustomFolder = "customFolder",
+            /**
+             * Specifies that a reported message is moved to the **Deleted Items** folder of the mailbox.
+             */
+            DeletedItemsFolder = "deletedItemsFolder",
+            /**
+             * Specifies that a reported message is moved to the **Junk Email** folder of the mailbox.
+             */
+            JunkFolder = "junkFolder",
+            /**
+             * Specifies that a reported message remains in its current folder in the mailbox.
+             */
+            NoMove = "noMove"
+        }
         /**
          * Represents the current view of Outlook on the web.
          */
@@ -88559,13 +88630,13 @@ declare namespace Word {
          */
         getOoxml(): OfficeExtension.ClientResult<string>;
         /**
-         * Gets the paragraph by its unique id. Throws an `ItemNotFound` error if the collection is empty.
+         * Gets the paragraph by its unique ID in GUID format. Throws an `ItemNotFound` error if the collection is empty.
          *
          * @remarks
          * [Api set: WordApi BETA (PREVIEW ONLY)]
          * @beta
          *
-         * @param id Required. Unique Paragraph Id.
+         * @param id Required. Unique paragraph ID in GUID format.
          */
         getParagraphById(id: string): Word.Paragraph;
         /**
@@ -88850,7 +88921,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;
         /**
-         * Specifies the line color for the border.
+         * Specifies the line color for the border. Color is specified in ‘#RRGGBB’ format or by using the color name.
          *
          * @remarks
          * [Api set: WordApi BETA (PREVIEW ONLY)]
@@ -100889,7 +100960,7 @@ declare namespace Word {
         /** An interface for updating data on the Border object, for use in `border.set({ ... })`. */
         interface BorderUpdateData {
             /**
-             * Specifies the line color for the border.
+             * Specifies the line color for the border. Color is specified in ‘#RRGGBB’ format or by using the color name.
              *
              * @remarks
              * [Api set: WordApi BETA (PREVIEW ONLY)]
@@ -102345,7 +102416,7 @@ declare namespace Word {
         /** An interface describing the data returned by calling `border.toJSON()`. */
         interface BorderData {
             /**
-             * Specifies the line color for the border.
+             * Specifies the line color for the border. Color is specified in ‘#RRGGBB’ format or by using the color name.
              *
              * @remarks
              * [Api set: WordApi BETA (PREVIEW ONLY)]
@@ -104463,7 +104534,7 @@ declare namespace Word {
              */
             $all?: boolean;
             /**
-             * Specifies the line color for the border.
+             * Specifies the line color for the border. Color is specified in ‘#RRGGBB’ format or by using the color name.
              *
              * @remarks
              * [Api set: WordApi BETA (PREVIEW ONLY)]

office-js-preview/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@types/office-js-preview",
-    "version": "1.0.405",
+    "version": "1.0.407",
     "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": "c877fcb87750c4a352fb2dc908f8e394e81b38769aef4bf87ff226cc7a1d50f7",
+    "typesPublisherContentHash": "5356f9c6216807b1a06e2a09ccb3d4bfc6629a701f92322ecece04ab49deb69a",
     "typeScriptVersion": "4.3"
 }