@types/office-js 1.0.339 → 1.0.341

office-js/README.md

@@ -8,7 +8,7 @@ This package contains type definitions for Office.js (https://github.com/OfficeD
 Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-js.
 
 ### Additional Details
- * Last updated: Thu, 24 Aug 2023 19:33:01 GMT
+ * Last updated: Tue, 29 Aug 2023 20:03:01 GMT
  * Dependencies: none
  * Global values: `Excel`, `Office`, `OfficeCore`, `OfficeExtension`, `OneNote`, `PowerPoint`, `Visio`, `Word`
 

office-js/index.d.ts

@@ -1042,7 +1042,12 @@ declare namespace Office {
          *
          * @remarks
          *
-         * See {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/add-in-commands-requirement-sets | Add-in commands requirement sets} for more support information.
+         * For information on support in Excel, Word, and PowerPoint, see
+         * {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/add-in-commands-requirement-sets | Add-in commands requirement sets}.
+         *
+         * The following outlines support information for Outlook.
+         *
+         * [Api set: Mailbox 1.3]
          *
          * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level (Outlook)}**: **restricted**
          *
@@ -1054,83 +1059,102 @@ declare namespace Office {
              *
              * @remarks
              *
-             * This property is supported in Outlook only in {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/outlook-api-requirement-sets | requirement set} Mailbox 1.3 and later.
+             * The following outlines support information for Outlook.
+             *
+             * [Api set: Mailbox 1.3]
+             *
+             * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **restricted**
+             *
+             * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read
              */
             source:Source;
-
             /**
              * Indicates that the add-in has completed processing and will automatically be closed.
              *
              * This method must be called at the end of a function which was invoked by the following:
              *
-             * - A function command button (that is, an add-in command defined with an `Action` element, where the `xsi:type` attribute is set to `ExecuteFunction`).
+             * - A function command button (that is, an add-in command defined with an **\<Action\>** element, where the `xsi:type` attribute is set to `ExecuteFunction`).
              *
-             * - An event defined in the {@link https://learn.microsoft.com/javascript/api/manifest/extensionpoint#launchevent | LaunchEvent extension point}.
-             * For example, an `OnMessageSend` event. 
-             * 
              * - An {@link https://learn.microsoft.com/javascript/api/manifest/event | event} defined in the
-             * {@link https://learn.microsoft.com/javascript/api/manifest/extensionpoint#events | Events extension point}. For example, an `ItemSend` event.
+             * {@link https://learn.microsoft.com/javascript/api/manifest/extensionpoint#events | Events extension point} of an on-send add-in in Outlook.
+             * For example, an `ItemSend` event.
              *
              * @remarks
              *
+             * The following outlines support information for Outlook.
+             *
              * [Api set: Mailbox 1.3]
-             * 
+             *
              * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **restricted**
              *
              * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read
              *
-             * **Note**: The `options` parameter was introduced in Mailbox 1.8.
+             * **Important**: The `options` parameter only applies to Outlook add-ins that implement the
+             * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-on-send-addins | on-send feature}. It was introduced in Mailbox 1.8.
              *
-             * @param options Optional. An object that specifies behavior options for when the event is completed.
+             * @param options Optional. An object that specifies the behavior of an on-send add-in in Outlook when it completes processing an `ItemSend` event.
              */
             completed(options?: EventCompletedOptions): void;
         }
-
         /**
-         * Specifies the behavior for when the event is completed.
+         * Specifies the behavior of an {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-on-send-addins | on-send} add-in in Outlook
+         * when it completes processing an `ItemSend` event.
+         *
+         * @remarks
+         *
+         * [Api set: Mailbox 1.8]
+         *
+         * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **restricted**
+         *
+         * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
          */
         interface EventCompletedOptions {
             /**
-             * When the {@link https://learn.microsoft.com/javascript/api/office/office.addincommands.event#office-office-addincommands-event-completed-member(1) | completed method}
-             * is used to signal completion of an event handler, this value indicates if the handled event should continue execution or be canceled.
-             * For example, an add-in that handles the `OnMessageSend` or `OnAppointmentSend` event can set `allowEvent` to `false` to cancel the
-             * sending of an item. For a complete sample, see the
-             * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/smart-alerts-onmessagesend-walkthrough | Smart Alerts walkthrough}.
-             * 
+             * 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 completion of an event handler, this value indicates if the handled event should continue execution or be canceled.
+             * For example, an on-send add-in that handles the `ItemSend` event can set `allowEvent` to `false` to cancel the sending of a message.
+             *
              * @remarks
              *
              * [Api set: Mailbox 1.8]
-             * 
-             * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level (Outlook)}**: **restricted**
-             *
-             * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
-             */
-            allowEvent: boolean;
-
-            /**
-             * When the {@link https://learn.microsoft.com/javascript/api/office/office.addincommands.event#office-office-addincommands-event-completed-member(1) | completed method}
-             * is used to signal completion of an event handler and if the `allowEvent` option is set to `false`, this value sets the error message
-             * that will be displayed to the user. For an example, see the  
-             * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/smart-alerts-onmessagesend-walkthrough | Smart Alerts walkthrough}.
              *
-             * @remarks
-             * 
-             * [Api set: Mailbox 1.12]
-             * 
              * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level (Outlook)}**: **restricted**
              *
              * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
              */
-            errorMessage?: string;
+            allowEvent: boolean;
         }
-
         /**
          * Encapsulates source data for add-in events.
+         *
+         * @remarks
+         *
+         * For information on support in Excel, Word, and PowerPoint, see
+         * {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/add-in-commands-requirement-sets | Add-in commands requirement sets}.
+         *
+         * The following outlines support information for Outlook.
+         *
+         * [Api set: Mailbox 1.3]
+         *
+         * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level (Outlook)}**: **restricted**
+         *
+         * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read
          */
         interface Source {
-
             /**
              * The ID of the control that triggered calling this function. The ID comes from the manifest.
+             *
+             * @remarks
+             *
+             * The following outlines support information for Outlook.
+             *
+             * [Api set: Mailbox 1.3]
+             *
+             * See {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/add-in-commands-requirement-sets | Add-in commands requirement sets} for more support information.
+             *
+             * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level (Outlook)}**: **restricted**
+             *
+             * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read
              */
             id: string;
         }
@@ -1421,7 +1445,6 @@ declare namespace Office {
          */
         openBrowserWindow(url: string): void;
     }
-
     /**
      * Provides information about which Requirement Sets are supported in the current environment.
      */
@@ -1444,7 +1467,6 @@ declare namespace Office {
         */
        isSetSupported(name: string, minVersionNumber?: number): boolean;
     }
-
     /**
      * Provides options for how a dialog is displayed.
      */
@@ -1476,7 +1498,6 @@ declare namespace Office {
          */
         asyncContext?: any
     }
-
     /**
      * The Office Auth namespace, `Office.auth`, provides a method that allows the Office client application to obtain an access token to the add-in's web application.
      * Indirectly, this also enables the add-in to access the signed-in user's Microsoft Graph data without requiring the user to sign in a second time.
@@ -14864,6 +14885,34 @@ declare namespace Office {
          */
         removeHandlerAsync(eventType: Office.EventType | string, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
     }
+    /**
+     * The `MailboxEvent` object is passed as an argument to the event handler of an add-in that implements
+     * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/autolaunch | event-based activation}, including
+     * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/smart-alerts-onmessagesend-walkthrough | Smart Alerts}.
+     * It allows the add-in to signify to the Outlook client that it has completed processing an event.
+     *
+     * @remarks
+     * [Api set: Mailbox 1.10]
+     *
+     * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **restricted**
+     *
+     * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read
+     */
+    interface MailboxEvent {
+        /**
+         * Indicates that the event-based add-in has completed processing an event.
+         *
+         * @remarks
+         * [Api set: Mailbox 1.10]
+         *
+         * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **restricted**
+         *
+         * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read
+         *
+         * @param options - Optional. An object that specifies the behavior of an event-based add-in when it completes processing an event.
+         */
+        completed(options?: SmartAlertsEventCompletedOptions): void;
+    }
     /**
      * Represents the categories master list on the mailbox.
      *
@@ -19038,6 +19087,42 @@ declare namespace Office {
          */
         delegatePermissions: MailboxEnums.DelegatePermissions;
     }
+    /**
+     * Specifies the behavior of a {@link https://learn.microsoft.com/office/dev/add-ins/outlook/smart-alerts-onmessagesend-walkthrough | Smart Alerts add-in}
+     * when it completes processing an `OnMessageSend` or `OnAppointmentSend` event.
+     */
+    interface SmartAlertsEventCompletedOptions {
+        /**
+         * When you use the {@link Office.MailboxEvent.completed | completed method} to signal completion of an event handler,
+         * this value indicates if the handled event should continue execution or be canceled.
+         * For example, an add-in that handles the `OnMessageSend` or `OnAppointmentSend` event can set `allowEvent` to `false` to cancel the sending of an item.
+         * For a complete sample, see the
+         * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/smart-alerts-onmessagesend-walkthrough | Smart Alerts walkthrough}.
+         *
+         * @remarks
+         *
+         * [Api set: Mailbox 1.12]
+         *
+         * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level (Outlook)}**: **restricted**
+         *
+         * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
+         */
+        allowEvent?: boolean;
+        /**
+         * When you use the {@link Office.MailboxEvent.completed | completed method} to signal completion of an event handler and set its `allowEvent` property
+         * to `false`, this property sets the error message that will be displayed to the user. For an example, see the
+         * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/smart-alerts-onmessagesend-walkthrough | Smart Alerts walkthrough}.
+         *
+         * @remarks
+         * 
+         * [Api set: Mailbox 1.12]
+         * 
+         * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level (Outlook)}**: **restricted**
+         *
+         * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
+         */
+        errorMessage?: string;
+    }
     /**
      * Provides methods to get and set the subject of an appointment or message in an Outlook add-in.
      *
@@ -60963,7 +61048,7 @@ declare namespace Excel {
         unsupportedSheet = "UnsupportedSheet",
         invalidOperationInCellEditMode = "InvalidOperationInCellEditMode"
     }
-    module Interfaces {
+    namespace Interfaces {
         /**
         * Provides ways to load properties of only a subset of members of a collection.
         */
@@ -93899,7 +93984,7 @@ declare namespace Word {
         searchDialogIsOpen = "SearchDialogIsOpen",
         searchStringInvalidOrTooLong = "SearchStringInvalidOrTooLong",
     }
-    module Interfaces {
+    namespace Interfaces {
         /**
         * Provides ways to load properties of only a subset of members of a collection.
         */
@@ -104653,7 +104738,7 @@ declare namespace OneNote {
         notSupported = "NotSupported",
         operationAborted = "OperationAborted",
     }
-    module Interfaces {
+    namespace Interfaces {
         /**
         * Provides ways to load properties of only a subset of members of a collection.
         */
@@ -109731,7 +109816,7 @@ declare namespace Visio {
         notImplemented = "NotImplemented",
         unsupportedOperation = "UnsupportedOperation",
     }
-    module Interfaces {
+    namespace Interfaces {
         /**
         * Provides ways to load properties of only a subset of members of a collection.
         */
@@ -114236,7 +114321,7 @@ declare namespace PowerPoint {
     enum ErrorCodes {
         generalException = "GeneralException",
     }
-    module Interfaces {
+    namespace Interfaces {
         /**
         * Provides ways to load properties of only a subset of members of a collection.
         */

office-js/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@types/office-js",
-    "version": "1.0.339",
+    "version": "1.0.341",
     "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": "55992e2b7457ee2c12bad9e10b5eeefd3b9ef3b385a95a380c0e0172e00432c8",
+    "typesPublisherContentHash": "85163151895fbe1fd08958eed03b88fcd3be2c45fea121bad3a6d0ba3afbdcd6",
     "typeScriptVersion": "4.3"
 }