@types/office-js-preview 1.0.330 → 1.0.331

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

office-js-preview/index.d.ts

@@ -1048,14 +1048,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
          */
@@ -1072,18 +1072,20 @@ 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.
+             * 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`)
+             * - 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
@@ -1100,20 +1102,35 @@ 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 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, refer to the 
+             * 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 preview]
+             * [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`
              *
-             * @beta
+             * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
              */
             errorMessage?: string;
         }

office-js-preview/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@types/office-js-preview",
-    "version": "1.0.330",
+    "version": "1.0.331",
     "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": "02da0d528889632af2e050454a3b6404f621c2ed70d30777c9ec6dd1286e5a1d",
+    "typesPublisherContentHash": "70d011d63461712003d9ef8b6dc17144de655cab40981c06f84e050214a1b5ba",
     "typeScriptVersion": "4.1"
 }