@types/office-js-preview 1.0.480 → 1.0.481

office-js-preview/README.md

@@ -8,7 +8,7 @@ This package contains type definitions for office-js-preview (https://github.com
 Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-js-preview.
 
 ### Additional Details
- * Last updated: Mon, 24 Jun 2024 22:08:06 GMT
+ * Last updated: Tue, 25 Jun 2024 17:07:23 GMT
  * Dependencies: none
 
 # Credits

office-js-preview/index.d.ts

@@ -5331,6 +5331,13 @@ declare namespace Office {
          *
          * This method returns a promise. Use it with Excel, PowerPoint, and Word add-ins.
          *
+         * If a user grants access to a device capability for the first time, the promise resolves with `true`.
+         * You must then reload the add-in before you can run code that uses the device capability.
+         * For example, you can call `window.location.reload()` to reload your add-in.
+         * If a user had previously granted access to a device capability, the promise resolves with `false`.
+         * You don't need to reload your add-in to run code that uses the device capability, as the permission is already set.
+         * If a user denies access to a device capability, the promise rejects with a "User denied the permission request" error message.
+         *
          * @remarks
          *
          * **Important**:
@@ -5341,9 +5348,6 @@ declare namespace Office {
          * Use {@link https://learn.microsoft.com/javascript/api/office/office.context#office-office-context-platform-member | Office.context.platform} and verify that it returns
          * `Office.PlatformType.OfficeOnline`. Otherwise, the `requestPermissions` call will return an error.
          *
-         * - If the user allows access to their camera or microphone, the add-in must be reloaded in the browser for the permissions to take effect.
-         * For example, you can call `window.location.reload()` to reload your add-in.
-         *
          * - If a user selects **Allow** from the dialog, the permission persists until the add-in is uninstalled or until the
          * cache of the browser on which the add-in is running is cleared. If a user wants to change an add-in’s access to their camera or microphone,
          * they must uninstall the add-in or clear their browser cache.
@@ -5371,9 +5375,6 @@ declare namespace Office {
          *
          * - For Excel, PowerPoint, and Word add-ins, use the `requestPermissions` method instead.
          *
-         * - If the user allows access to their camera, geolocation, or microphone, the add-in must be reloaded in the browser for the permissions to take effect.
-         * For example, you can call `window.location.reload()` to reload your add-in.
-         *
          * - If your add-in uses the same code for both Office on the web and Office desktop clients, verify the platform on which the add-in is running before calling `requestPermissionsAsync`.
          * Use {@link https://learn.microsoft.com/javascript/api/outlook/office.diagnostics#outlook-office-diagnostics-hostname-member | Office.context.mailbox.diagnostics.hostName}
          * and verify that it returns `OutlookWebApp`. Otherwise, the `requestPermissionsAsync` call will return an error.
@@ -5393,7 +5394,11 @@ declare namespace Office {
          *     In Outlook on the web, an add-in can request access to a user's camera, geolocation, and microphone.
          * @param options An object literal that contains the `asyncContext` property. Assign any object you wish to access in the callback function to the `asyncContext` property.
          * @param callback When the method completes, the function passed in the `callback` parameter is called with a single parameter, `asyncResult`, which is an `Office.AsyncResult` object.
-         *     If the user grants permission to access the requested device capabilities, `true` is returned in the `asyncResult.value` property.
+         *     If the user grants permission to access the requested device capabilities, `true` is returned in the `asyncResult.value` property. You must then reload the add-in before you can
+         *     run code that uses the device capabilities. For example, you can call `window.location.reload()` to reload your add-in.
+         *     If the user had previously granted permission to access the requested device capabilities, `false` is returned in the `asyncResult.value` property. You don't need to
+         *     reload your add-in to run code that uses the device capability, as the permission is already set.
+         *     If a user denies access to the requested device capabilities, `Office.AsyncResultStatus.Failed` is returned in the `asyncResult.status` property.
          */
         requestPermissionsAsync(permissions: Office.DevicePermissionType[], options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<boolean>) => void): void;
         /**
@@ -5410,9 +5415,6 @@ declare namespace Office {
          *
          * - For Excel, PowerPoint, and Word add-ins, use the `requestPermissions` method instead.
          *
-         * - If the user allows access to their camera, geolocation, or microphone, the add-in must be reloaded in the browser for the permissions to take effect.
-         * For example, you can call `window.location.reload()` to reload your add-in.
-         *
          * - If your add-in uses the same code for both Office on the web and Office desktop clients, verify the platform on which the add-in is running before calling `requestPermissionsAsync`.
          * Use {@link https://learn.microsoft.com/javascript/api/outlook/office.diagnostics#outlook-office-diagnostics-hostname-member | Office.context.mailbox.diagnostics.hostName}
          * and verify that it returns `OutlookWebApp`. Otherwise, the `requestPermissionsAsync` call will return an error.
@@ -5431,7 +5433,11 @@ declare namespace Office {
          * @param permissions An array of device capabilities to which an add-in is requesting access.
          *     In Outlook on the web, an add-in can request access to a user's camera, geolocation, and microphone.
          * @param callback When the method completes, the function passed in the `callback` parameter is called with a single parameter, `asyncResult`, which is an `Office.AsyncResult` object.
-         *     If the user grants permission to access the requested device capabilities, `true` is returned in the `asyncResult.value` property.
+         *     If the user grants permission to access the requested device capabilities, `true` is returned in the `asyncResult.value` property. You must then reload the add-in before you can
+         *     run code that uses the device capabilities. For example, you can call `window.location.reload()` to reload your add-in.
+         *     If the user had previously granted permission to access the requested device capabilities, `false` is returned in the `asyncResult.value` property. You don't need to
+         *     reload your add-in to run code that uses the device capability, as the permission is already set.
+         *     If a user denies access to the requested device capabilities, `Office.AsyncResultStatus.Failed` is returned in the `asyncResult.status` property.
          */
         requestPermissionsAsync(permissions: Office.DevicePermissionType[], callback: (asyncResult: Office.AsyncResult<boolean>) => void): void;
     }
@@ -20805,6 +20811,32 @@ declare namespace Office {
          * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
          */
         errorMessage?: string;
+        /**
+         * When you use the {@link https://learn.microsoft.com/javascript/api/outlook/office.mailboxevent#outlook-office-mailboxevent-completed-member(1) | completed method} to signal completion of an event handler
+         * and set its `allowEvent` property to `false`, this property sets the error message displayed to the user. The error message is formatted using Markdown. 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 preview]
+         *
+         * **{@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
+         *
+         * **Important**
+         *
+         * - The formatted error message must be 500 characters or less.
+         *
+         * - For guidance on supported Markdown elements, see 
+         * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/onmessagesend-onappointmentsend-events#limitations-to-formatting-the-dialog-message-using-markdown | Limitations to formatting the dialog message using Markdown}.
+         *
+         * - If you format the dialog message using the `errorMessageMarkdown` property, we recommend you also add a plaintext version of the message using the `errorMessage` property.
+         * This ensures that the message is displayed properly in Outlook clients that don't support Markdown.
+         *
+         * @beta
+         */
+        errorMessageMarkdown?: string;
         /**
          * When you use the {@link https://learn.microsoft.com/javascript/api/outlook/office.mailboxevent#outlook-office-mailboxevent-completed-member(1) | completed method} to signal completion of an event handler
          * and set its `allowEvent` property to `false`, this property overrides the

office-js-preview/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@types/office-js-preview",
-    "version": "1.0.480",
+    "version": "1.0.481",
     "description": "TypeScript definitions for office-js-preview",
     "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-js-preview",
     "license": "MIT",
@@ -45,7 +45,7 @@
     },
     "scripts": {},
     "dependencies": {},
-    "typesPublisherContentHash": "26c34f19ddc0e745cd7e95a25fd885755fa2135940062b76d1552105eb9f2a2c",
+    "typesPublisherContentHash": "006d9fc8b7e36f77d28348c499b68a1d4f2bd7cc1a501e8b8f3dff6e4f091d9b",
     "typeScriptVersion": "4.8",
     "nonNpm": true
 }