@types/office-js 1.0.277 → 1.0.278

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: Fri, 09 Sep 2022 21:02:44 GMT
+ * Last updated: Mon, 12 Sep 2022 21:02:42 GMT
  * Dependencies: none
  * Global values: `Excel`, `Office`, `OfficeCore`, `OfficeExtension`, `OneNote`, `PowerPoint`, `Visio`, `Word`
 

office-js/index.d.ts

@@ -983,14 +983,14 @@ declare namespace Office {
     }
     namespace AddinCommands {
         /**
-         * The `Event` object is passed as a parameter to add-in functions invoked by UI-less command buttons. The object allows the add-in to identify 
+         * The `Event` object is passed as a parameter to add-in functions invoked by function command buttons. The object allows the add-in to identify 
          * which button was clicked and to signal the host that it has completed its processing.
          * 
          * @remarks
          * 
          * See {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/add-in-commands-requirement-sets | Add-in commands requirement sets} for more support information.
          * 
-         * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level (Outlook)}**: Restricted
+         * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level (Outlook)}**: `Restricted`
          * 
          * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read
          */
@@ -1006,25 +1006,27 @@ declare namespace Office {
 
             /**
              * 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 UI-less button (i.e., an add-in command defined with an `Action` element where the `xsi:type` attribute is set to `ExecuteFunction`)
+             *
+             * 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`).
+             *
+             * - An event defined in the {@link https://docs.microsoft.com/javascript/api/manifest/extensionpoint#launchevent | LaunchEvent extension point}.
+             * For example, an `OnMessageSend` event. 
              * 
              * - An {@link https://docs.microsoft.com/javascript/api/manifest/event | event} defined in the
-             * {@link https://docs.microsoft.com/javascript/api/manifest/extensionpoint#events | Events extension point},
-             * e.g., an `ItemSend` event
-             * 
-             * [Api set: Mailbox 1.3]
+             * {@link https://docs.microsoft.com/javascript/api/manifest/extensionpoint#events | Events extension point}. For example, an `ItemSend` event.
              *
              * @remarks
+             *
+             * [Api set: Mailbox 1.3]
              * 
              * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `Restricted`
-             * 
+             *
              * **{@link https://docs.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.
-             * 
+             *
              * @param options Optional. An object that specifies behavior options for when the event is completed.
              */
             completed(options?: EventCompletedOptions): void;
@@ -1035,11 +1037,37 @@ declare namespace Office {
          */
         interface EventCompletedOptions {
             /**
-             * When the 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 `ItemSend` event can set `allowEvent` to `false` to cancel sending of the message.
+             * When the {@link https://docs.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://docs.microsoft.com/office/dev/add-ins/outlook/smart-alerts-onmessagesend-walkthrough | Smart Alerts walkthrough}.
+             * 
+             * @remarks
+             *
+             * [Api set: Mailbox 1.8]
+             * 
+             * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level (Outlook)}**: `Restricted`
+             *
+             * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
              */
             allowEvent: boolean;
+
+            /**
+             * When the {@link https://docs.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://docs.microsoft.com/office/dev/add-ins/outlook/smart-alerts-onmessagesend-walkthrough | Smart Alerts walkthrough}.
+             * 
+             * @remarks
+             * 
+             * [Api set: Mailbox 1.12]
+             * 
+             * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level (Outlook)}**: `Restricted`
+             *
+             * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
+             */
+            errorMessage?: string;
         }
 
         /**
@@ -9468,7 +9496,7 @@ declare namespace Office {
      * 
      * **Important**: This is an internal Outlook object, not directly exposed through existing interfaces. 
      * You should treat this as a mode of `Office.context.mailbox.item`. For more information, refer to the
-     * {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.11/office.context.mailbox.item | Object Model} page.
+     * {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.12/office.context.mailbox.item | Object Model} page.
      * 
      * Child interfaces:
      *
@@ -9483,7 +9511,7 @@ declare namespace Office {
      * 
      * **Important**: This is an internal Outlook object, not directly exposed through existing interfaces. 
      * You should treat this as a mode of `Office.context.mailbox.item`. For more information, refer to the
-     * {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.11/office.context.mailbox.item | Object Model} page.
+     * {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.12/office.context.mailbox.item | Object Model} page.
      * 
      * Parent interfaces:
      *
@@ -9868,7 +9896,7 @@ declare namespace Office {
          * Adds an event handler for a supported event. **Note**: Events are only available with task pane implementation.
          * 
          * For supported events, refer to the Item object model
-         * {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.11/office.context.mailbox.item#events | events section}.
+         * {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.12/office.context.mailbox.item#events | events section}.
          * 
          * @remarks
          * [Api set: Mailbox 1.7]
@@ -9890,7 +9918,7 @@ declare namespace Office {
          * Adds an event handler for a supported event. **Note**: Events are only available with task pane implementation.
          * 
          * For supported events, refer to the Item object model
-         * {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.11/office.context.mailbox.item#events | events section}.
+         * {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.12/office.context.mailbox.item#events | events section}.
          * 
          * @remarks
          * [Api set: Mailbox 1.7]
@@ -10392,7 +10420,7 @@ declare namespace Office {
          * Removes the event handlers for a supported event type. **Note**: Events are only available with task pane implementation.
          * 
          * For supported events, refer to the Item object model
-         * {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.11/office.context.mailbox.item#events | events section}.
+         * {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.12/office.context.mailbox.item#events | events section}.
          * 
          * @remarks
          * [Api set: Mailbox 1.7]
@@ -10412,7 +10440,7 @@ declare namespace Office {
          * Removes the event handlers for a supported event type. **Note**: Events are only available with task pane implementation.
          * 
          * For supported events, refer to the Item object model
-         * {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.11/office.context.mailbox.item#events | events section}.
+         * {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.12/office.context.mailbox.item#events | events section}.
          * 
          * @remarks
          * [Api set: Mailbox 1.7]
@@ -10737,7 +10765,7 @@ declare namespace Office {
      * 
      * **Important**: This is an internal Outlook object, not directly exposed through existing interfaces. 
      * You should treat this as a mode of `Office.context.mailbox.item`. For more information, refer to the
-     * {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.11/office.context.mailbox.item | Object Model} page.
+     * {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.12/office.context.mailbox.item | Object Model} page.
      * 
      * Parent interfaces:
      *
@@ -11057,7 +11085,7 @@ declare namespace Office {
          * Adds an event handler for a supported event. **Note**: Events are only available with task pane implementation.
          * 
          * For supported events, refer to the Item object model
-         * {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.11/office.context.mailbox.item#events | events section}.
+         * {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.12/office.context.mailbox.item#events | events section}.
          * 
          * @remarks
          * [Api set: Mailbox 1.7]
@@ -11079,7 +11107,7 @@ declare namespace Office {
          * Adds an event handler for a supported event. **Note**: Events are only available with task pane implementation.
          * 
          * For supported events, refer to the Item object model
-         * {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.11/office.context.mailbox.item#events | events section}.
+         * {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.12/office.context.mailbox.item#events | events section}.
          * 
          * @remarks
          * [Api set: Mailbox 1.7]
@@ -11568,7 +11596,7 @@ declare namespace Office {
          * Removes the event handlers for a supported event type. **Note**: Events are only available with task pane implementation.
          * 
          * For supported events, refer to the Item object model
-         * {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.11/office.context.mailbox.item#events | events section}.
+         * {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.12/office.context.mailbox.item#events | events section}.
          * 
          * @remarks
          * [Api set: Mailbox 1.7]
@@ -11588,7 +11616,7 @@ declare namespace Office {
          * Removes the event handlers for a supported event type. **Note**: Events are only available with task pane implementation.
          * 
          * For supported events, refer to the Item object model
-         * {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.11/office.context.mailbox.item#events | events section}.
+         * {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.12/office.context.mailbox.item#events | events section}.
          * 
          * @remarks
          * [Api set: Mailbox 1.7]
@@ -13135,7 +13163,7 @@ declare namespace Office {
      * You can determine the type of the item by using the `itemType` property.
      *
      * To see the full member list, refer to the
-     * {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.11/office.context.mailbox.item | Object Model} page.
+     * {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.12/office.context.mailbox.item | Object Model} page.
      *
      * If you want to see IntelliSense for only a specific type or mode, cast this item to one of the following:
      *
@@ -13160,7 +13188,7 @@ declare namespace Office {
      * 
      * **Important**: This is an internal Outlook object, not directly exposed through existing interfaces.
      * You should treat this as a mode of `Office.context.mailbox.item`. For more information, refer to the
-     * {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.11/office.context.mailbox.item | Object Model} page.
+     * {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.12/office.context.mailbox.item | Object Model} page.
      * 
      * Child interfaces:
      *
@@ -13175,7 +13203,7 @@ declare namespace Office {
      * 
      * **Important**: This is an internal Outlook object, not directly exposed through existing interfaces.
      * You should treat this as a mode of `Office.context.mailbox.item`. For more information, refer to the
-     * {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.11/office.context.mailbox.item | Object Model} page.
+     * {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.12/office.context.mailbox.item | Object Model} page.
      * 
      * Child interfaces:
      *
@@ -13496,7 +13524,7 @@ declare namespace Office {
          * Adds an event handler for a supported event. **Note**: Events are only available with task pane implementation.
          *
          * For supported events, refer to the Mailbox object model
-         * {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.11/office.context.mailbox#events | events section}.
+         * {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.12/office.context.mailbox#events | events section}.
          *
          * @remarks
          * [Api set: Mailbox 1.5]
@@ -13517,7 +13545,7 @@ declare namespace Office {
          * Adds an event handler for a supported event. **Note**: Events are only available with task pane implementation.
          *
          * For supported events, refer to the Mailbox object model
-         * {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.11/office.context.mailbox#events | events section}.
+         * {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.12/office.context.mailbox#events | events section}.
          *
          * @remarks
          * [Api set: Mailbox 1.5]
@@ -14220,7 +14248,7 @@ declare namespace Office {
          * Removes the event handlers for a supported event type. **Note**: Events are only available with task pane implementation.
          *
          * For supported events, refer to the Mailbox object model
-         * {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.11/office.context.mailbox#events | events section}.
+         * {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.12/office.context.mailbox#events | events section}.
          *
          * @remarks
          * [Api set: Mailbox 1.5]
@@ -14239,7 +14267,7 @@ declare namespace Office {
          * Removes the event handlers for a supported event type. **Note**: Events are only available with task pane implementation.
          *
          * For supported events, refer to the Mailbox object model
-         * {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.11/office.context.mailbox#events | events section}.
+         * {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.12/office.context.mailbox#events | events section}.
          *
          * @remarks
          * [Api set: Mailbox 1.5]
@@ -14431,7 +14459,7 @@ declare namespace Office {
      * 
      * **Important**: This is an internal Outlook object, not directly exposed through existing interfaces. 
      * You should treat this as a mode of `Office.context.mailbox.item`. For more information, refer to the
-     * {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.11/office.context.mailbox.item | Object Model} page.
+     * {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.12/office.context.mailbox.item | Object Model} page.
      * 
      * Child interfaces:
      *
@@ -14446,7 +14474,7 @@ declare namespace Office {
      * 
      * **Important**: This is an internal Outlook object, not directly exposed through existing interfaces. 
      * You should treat this as a mode of `Office.context.mailbox.item`. For more information, refer to the
-     * {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.11/office.context.mailbox.item | Object Model} page.
+     * {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.12/office.context.mailbox.item | Object Model} page.
      * 
      * Parent interfaces:
      *
@@ -14798,7 +14826,7 @@ declare namespace Office {
          * Adds an event handler for a supported event. **Note**: Events are only available with task pane implementation.
          * 
          * For supported events, refer to the Item object model
-         * {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.11/office.context.mailbox.item#events | events section}.
+         * {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.12/office.context.mailbox.item#events | events section}.
          * 
          * @remarks
          * [Api set: Mailbox 1.7]
@@ -14820,7 +14848,7 @@ declare namespace Office {
          * Adds an event handler for a supported event. **Note**: Events are only available with task pane implementation.
          * 
          * For supported events, refer to the Item object model
-         * {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.11/office.context.mailbox.item#events | events section}.
+         * {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.12/office.context.mailbox.item#events | events section}.
          * 
          * @remarks
          * [Api set: Mailbox 1.7]
@@ -15380,7 +15408,7 @@ declare namespace Office {
          * Removes the event handlers for a supported event type. **Note**: Events are only available with task pane implementation.
          * 
          * For supported events, refer to the Item object model
-         * {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.11/office.context.mailbox.item#events | events section}.
+         * {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.12/office.context.mailbox.item#events | events section}.
          * 
          * @remarks
          * [Api set: Mailbox 1.7]
@@ -15400,7 +15428,7 @@ declare namespace Office {
          * Removes the event handlers for a supported event type. **Note**: Events are only available with task pane implementation.
          * 
          * For supported events, refer to the Item object model
-         * {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.11/office.context.mailbox.item#events | events section}.
+         * {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.12/office.context.mailbox.item#events | events section}.
          * 
          * @remarks
          * [Api set: Mailbox 1.7]
@@ -15544,7 +15572,7 @@ declare namespace Office {
      * 
      * **Important**: This is an internal Outlook object, not directly exposed through existing interfaces. 
      * You should treat this as a mode of `Office.context.mailbox.item`. For more information, refer to the
-     * {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.11/office.context.mailbox.item | Object Model} page.
+     * {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.12/office.context.mailbox.item | Object Model} page.
      * 
      * Parent interfaces:
      *
@@ -15915,7 +15943,7 @@ declare namespace Office {
          * Adds an event handler for a supported event. **Note**: Events are only available with task pane implementation.
          * 
          * For supported events, refer to the Item object model
-         * {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.11/office.context.mailbox.item#events | events section}.
+         * {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.12/office.context.mailbox.item#events | events section}.
          * 
          * @remarks
          * [Api set: Mailbox 1.7]
@@ -15937,7 +15965,7 @@ declare namespace Office {
          * Adds an event handler for a supported event. **Note**: Events are only available with task pane implementation.
          * 
          * For supported events, refer to the Item object model
-         * {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.11/office.context.mailbox.item#events | events section}.
+         * {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.12/office.context.mailbox.item#events | events section}.
          * 
          * @remarks
          * [Api set: Mailbox 1.7]
@@ -16466,7 +16494,7 @@ declare namespace Office {
          * Removes the event handlers for a supported event type. **Note**: Events are only available with task pane implementation.
          * 
          * For supported events, refer to the Item object model
-         * {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.11/office.context.mailbox.item#events | events section}.
+         * {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.12/office.context.mailbox.item#events | events section}.
          * 
          * @remarks
          * [Api set: Mailbox 1.7]
@@ -16486,7 +16514,7 @@ declare namespace Office {
          * Removes the event handlers for a supported event type. **Note**: Events are only available with task pane implementation.
          * 
          * For supported events, refer to the Item object model
-         * {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.11/office.context.mailbox.item#events | events section}.
+         * {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.12/office.context.mailbox.item#events | events section}.
          * 
          * @remarks
          * [Api set: Mailbox 1.7]

office-js/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@types/office-js",
-    "version": "1.0.277",
+    "version": "1.0.278",
     "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": "260ca3c657efd4c18dd5d8ce31dae12da6a5d8593b0a810b7c2b6e706ef060af",
+    "typesPublisherContentHash": "88bfe3f560a440576b09e3f5a5b1ec26c79f29fc6b73b8e77281dc5ed35ae7d9",
     "typeScriptVersion": "4.1"
 }