@types/office-js-preview 1.0.267 → 1.0.271

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: Mon, 08 Nov 2021 22:01:42 GMT
+ * Last updated: Fri, 03 Dec 2021 19:01:09 GMT
  * Dependencies: none
  * Global values: `Excel`, `Office`, `OfficeCore`, `OfficeExtension`, `OneNote`, `PowerPoint`, `Visio`, `Word`
 

office-js-preview/index.d.ts

@@ -607,12 +607,12 @@ declare namespace Office {
          */
         hide(): Promise<void>;
         /**
-         * Adds a listener for the `onVisibilityModeChanged` event.
-         * @param listener - The listener function that is called when the event is emitted. This function takes in a message for the receiving component.
-         * @returns A promise that resolves to a function when the listener is added. Calling it removes the listener.
+         * Adds a handler for the `onVisibilityModeChanged` event.
+         * @param handler - The handler function that is called when the event is emitted. This function takes in a message for the receiving component.
+         * @returns A promise that resolves to a function when the handler is added. Calling it removes the handler.
          */
         onVisibilityModeChanged(
-            listener: (message: VisibilityModeChangedMessage) => void,
+            handler: (message: VisibilityModeChangedMessage) => void,
         ): Promise<() => Promise<void>>;
 
         /**
@@ -657,7 +657,7 @@ declare namespace Office {
          * This event handler will be triggered if one of the following conditions is met:
          * 1. When the notification dialog is open, the end user clicks the **Don't close** button within the dialog, clicks the Close button in the upper right corner of the dialog, or presses the Esc key.
          * 2. When the add-in calls the `enable` method on the `BeforeDocumentCloseNotification` object.
-         * @param listener The event handler that is called when the dialog is cancelled.
+         * @param handler The event handler that is called when the dialog is cancelled.
          * @returns A promise that resolves when the event handler is added.
          * 
          * @remarks
@@ -665,7 +665,7 @@ declare namespace Office {
          * @beta
         */
         onCloseActionCancelled(
-            listener: () => void
+            handler: () => void
         ): Promise<() => Promise<void>>;     
     }
     /**
@@ -1078,10 +1078,24 @@ declare namespace Office {
          *
          * @param eventType Specifies the type of event to add. This must be `Office.EventType.DialogParentMessageReceived`.
          * @param handler The event handler function to add, whose only parameter is of type {@link Office.DialogParentMessageReceivedEventArgs}.
-         * @param options Optional. Provides an option for preserving context data of any type, unchanged, for use in a callback.
+         * @param options Provides an option for preserving context data of any type, unchanged, for use in a callback.
          * @param callback Optional. A function that is invoked when the handler registration returns, whose only parameter is of type {@link Office.AsyncResult}.
          */
-        addHandlerAsync(eventType: Office.EventType, handler: (result: DialogParentMessageReceivedEventArgs) => void, options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<void>) => void): void;
+        addHandlerAsync(eventType: Office.EventType, handler: (result: DialogParentMessageReceivedEventArgs) => void, options: Office.AsyncContextOptions, callback?: (result: AsyncResult<void>) => void): void;
+        /**
+          * Adds an event handler to the object using the specified event type.
+          *
+          * @remarks
+          *
+          * **Requirement set**: {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/dialog-api-requirement-sets | DialogApi 1.2}
+          *
+          * You can add multiple event handlers for the specified event type as long as the name of each event handler function is unique.
+          *
+          * @param eventType Specifies the type of event to add. This must be `Office.EventType.DialogParentMessageReceived`.
+          * @param handler The event handler function to add, whose only parameter is of type {@link Office.DialogParentMessageReceivedEventArgs}.
+          * @param callback Optional. A function that is invoked when the handler registration returns, whose only parameter is of type {@link Office.AsyncResult}.
+          */
+        addHandlerAsync(eventType: Office.EventType, handler: (result: DialogParentMessageReceivedEventArgs) => void, callback?: (result: AsyncResult<void>) => void): void;
         /**
         * Displays a dialog to show or collect information from the user or to facilitate Web navigation.
         *
@@ -9712,6 +9726,8 @@ declare namespace Office {
         /**
          * Manages the {@link Office.SessionData | SessionData} of an item in Compose mode.
          *
+         * **Important**: The entire SessionData object is limited to 50,000 characters per add-in.
+         *
          * @remarks
          * [Api set: Mailbox 1.11]
          *
@@ -10524,6 +10540,9 @@ declare namespace Office {
          * appointment on the user's calendar. For new appointments that have not been saved before, no invitation will be sent.
          * Saving an existing appointment will send an update to added or removed attendees.
          *
+         * When working with HTML-formatted content, it's important to note that the Outlook client may modify the content. This means that
+         * subsequent calls to methods like `Body.getAsync`, `Body.setAsync`, and even `saveAsync` may not result in the same content.
+         *
          * **Note**: If your add-in calls `saveAsync` on an item in compose mode in order to get an item ID to use with EWS or the REST API, be aware
          * that when Outlook is in cached mode, it may take some time before the item is actually synced to the server.
          * Until the item is synced, using the item ID will return an error.
@@ -10559,6 +10578,9 @@ declare namespace Office {
          * appointment on the user's calendar. For new appointments that have not been saved before, no invitation will be sent.
          * Saving an existing appointment will send an update to added or removed attendees.
          *
+         * When working with HTML-formatted content, it's important to note that the Outlook client may modify the content. This means that
+         * subsequent calls to methods like `Body.getAsync`, `Body.setAsync`, and even `saveAsync` may not result in the same content.
+         *
          * **Note**: If your add-in calls `saveAsync` on an item in compose mode in order to get an item ID to use with EWS or the REST API, be aware that
          * when Outlook is in cached mode, it may take some time before the item is actually synced to the server.
          * Until the item is synced, using the item ID will return an error.
@@ -11962,6 +11984,8 @@ declare namespace Office {
          *
          * **Important**: To use `appendOnSendAsync`, the `ExtendedPermissions` manifest node must include the `AppendOnSend` extended permission.
          *
+         * **Recommended**: Call `getTypeAsync` then pass the returned value to the `options.coercionType` parameter.
+         *
          * **Note**: To clear data from a previous `appendOnSendAsync` call, you can call it again with the `data` parameter set to `null`.
          *
          * @remarks
@@ -11997,6 +12021,8 @@ declare namespace Office {
          *
          * **Important**: To use `appendOnSendAsync`, the `ExtendedPermissions` manifest node must include the `AppendOnSend` extended permission.
          *
+         * **Recommended**: Call `getTypeAsync` then pass the returned value to the `options.coercionType` parameter.
+         *
          * **Note**: To clear data from a previous `appendOnSendAsync` call, you can call it again with the `data` parameter set to `null`.
          *
          * @remarks
@@ -12106,6 +12132,8 @@ declare namespace Office {
          * When including links in HTML markup, you can disable online link preview by setting the `id` attribute on the anchor (\<a\>) to "LPNoLP"
          * (see the **Examples** section for a sample).
          *
+         * **Recommended**: Call `getTypeAsync` then pass the returned value to the `options.coercionType` parameter.
+         *
          * @remarks
          * [Api set: Mailbox 1.1]
          *
@@ -12138,6 +12166,8 @@ declare namespace Office {
          * When including links in HTML markup, you can disable online link preview by setting the `id` attribute on the anchor (\<a\>) to "LPNoLP"
          * (see the **Examples** section for a sample).
          *
+         * **Recommended**: Call `getTypeAsync` then pass the returned value to the `options.coercionType` parameter.
+         *
          * @remarks
          * [Api set: Mailbox 1.1]
          *
@@ -12164,6 +12194,10 @@ declare namespace Office {
          * When including links in HTML markup, you can disable online link preview by setting the `id` attribute on the anchor (\<a\>) to "LPNoLP"
          * (see the **Examples** section for a sample).
          *
+         * **Recommended**: Call `getTypeAsync` then pass the returned value to the `options.coercionType` parameter.
+         *
+         * **Important**: In Outlook on Windows and on Mac, the add-in user won't be able to revert this action with the **Undo** command.
+         *
          * @remarks
          * [Api set: Mailbox 1.3]
          *
@@ -12195,6 +12229,10 @@ declare namespace Office {
          * When including links in HTML markup, you can disable online link preview by setting the `id` attribute on the anchor (\<a\>) to "LPNoLP"
          * (see the **Examples** section for a sample).
          *
+         * **Recommended**: Call `getTypeAsync` then pass the returned value to the `options.coercionType` parameter.
+         *
+         * **Important**: In Outlook on Windows and on Mac, the add-in user won't be able to revert this action with the **Undo** command.
+         *
          * @remarks
          * [Api set: Mailbox 1.3]
          *
@@ -12223,6 +12261,8 @@ declare namespace Office {
          * When including links in HTML markup, you can disable online link preview by setting the id attribute on the anchor (\<a\>) to "LPNoLP"
          * (see the **Examples** section for a sample).
          *
+         * **Recommended**: Call `getTypeAsync` then pass the returned value to the `options.coercionType` parameter.
+         *
          * @remarks
          * [Api set: Mailbox 1.1]
          *
@@ -12254,6 +12294,8 @@ declare namespace Office {
          * When including links in HTML markup, you can disable online link preview by setting the id attribute on the anchor (\<a\>) to "LPNoLP"
          * (see the **Examples** section for a sample).
          *
+         * **Recommended**: Call `getTypeAsync` then pass the returned value to the `options.coercionType` parameter.
+         *
          * @remarks
          * [Api set: Mailbox 1.1]
          *
@@ -14784,6 +14826,8 @@ declare namespace Office {
         /**
          * Manages the {@link Office.SessionData | SessionData} of an item in Compose mode.
          *
+         * **Important**: The entire SessionData object is limited to 50,000 characters per add-in.
+         *
          * @remarks
          * [Api set: Mailbox 1.11]
          *
@@ -15664,6 +15708,9 @@ declare namespace Office {
          * appointment on the user's calendar. For new appointments that have not been saved before, no invitation will be sent.
          * Saving an existing appointment will send an update to added or removed attendees.
          *
+         * When working with HTML-formatted content, it's important to note that the Outlook client may modify the content. This means that
+         * subsequent calls to methods like `Body.getAsync`, `Body.setAsync`, and even `saveAsync` may not result in the same content.
+         *
          * **Note**: If your add-in calls `saveAsync` on an item in compose mode in order to get an item ID to use with EWS or the REST API, be aware
          * that when Outlook is in cached mode, it may take some time before the item is actually synced to the server.
          * Until the item is synced, using the itemId will return an error.
@@ -15696,6 +15743,9 @@ declare namespace Office {
          * appointment on the user's calendar. For new appointments that have not been saved before, no invitation will be sent.
          * Saving an existing appointment will send an update to added or removed attendees.
          *
+         * When working with HTML-formatted content, it's important to note that the Outlook client may modify the content. This means that
+         * subsequent calls to methods like `Body.getAsync`, `Body.setAsync`, and even `saveAsync` may not result in the same content.
+         *
          * **Note**: If your add-in calls `saveAsync` on an item in compose mode in order to get an item ID to use with EWS or the REST API, be aware
          * that when Outlook is in cached mode, it may take some time before the item is actually synced to the server.
          * Until the item is synced, using the `itemId` will return an error.
@@ -18193,7 +18243,9 @@ declare namespace Office {
         setStartTime(time: string): void;
     }
     /**
-     * Provides methods to  manage an item's session data.
+     * Provides methods to manage an item's session data.
+     *
+     * **Important**: The entire SessionData object is limited to 50,000 characters per add-in.
      *
      * @remarks
      * [Api set: Mailbox 1.11]
@@ -18297,6 +18349,8 @@ declare namespace Office {
         /**
          * Sets a session data key-value pair.
          *
+         * **Important**: The entire SessionData object is limited to 50,000 characters per add-in.
+         *
          * @remarks
          * [Api set: Mailbox 1.11]
          *
@@ -18315,6 +18369,8 @@ declare namespace Office {
         /**
          * Sets a session data key-value pair.
          *
+         * **Important**: The entire SessionData object is limited to 50,000 characters per add-in.
+         *
          * @remarks
          * [Api set: Mailbox 1.11]
          *

office-js-preview/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@types/office-js-preview",
-    "version": "1.0.267",
+    "version": "1.0.271",
     "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": "b0c3bbab29cdf1d5f7472e9b980a09b896e6fc80880ab136046b53e694430074",
-    "typeScriptVersion": "3.7"
+    "typesPublisherContentHash": "de34b23aa02f883d8af3ad56cbecf1c9ae0fc4880eb6d7c677336e52912793fa",
+    "typeScriptVersion": "3.8"
 }