@types/office-js-preview 1.0.314 → 1.0.317

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: Wed, 15 Jun 2022 19:01:37 GMT
+ * Last updated: Tue, 28 Jun 2022 23:32:26 GMT
  * Dependencies: none
  * Global values: `Excel`, `Office`, `OfficeCore`, `OfficeExtension`, `OneNote`, `PowerPoint`, `Visio`, `Word`
 

office-js-preview/index.d.ts

@@ -1536,9 +1536,15 @@ declare namespace Office {
          *
          * **Hosts**: Excel, OneNote, Outlook, PowerPoint, Word
          * 
-         * **Important**: In Outlook, this API is not supported if the add-in is loaded in an Outlook.com or Gmail mailbox. 
-         *
          * **Requirement set**: {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/identity-api-requirement-sets | IdentityAPI 1.3}
+         * 
+         * **Important**: In Outlook, this API isn't supported if the add-in is loaded in an Outlook.com or Gmail mailbox.
+         * 
+         * **Note**: In an Outlook event-based activation add-in, this API is supported in Outlook on Windows starting from version 2111 (build 14701.20000).
+         * To retrieve an access token in older builds, use 
+         * {@link https://docs.microsoft.com/javascript/api/office-runtime/officeruntime.auth?view=common-js-preview#office-runtime-officeruntime-auth-getaccesstoken-member(1) | 
+         * OfficeRuntime.auth.getAccessToken} instead. For more information, see 
+         * {@link https://docs.microsoft.com/office/dev/add-ins/outlook/use-sso-in-event-based-activation | Enable single sign-on (SSO) in Outlook add-ins that use event-based activation}.
          *
          * @param options - Optional. Accepts an `AuthOptions` object to define sign-on behaviors.
          * @returns Promise to the access token.
@@ -10819,9 +10825,9 @@ declare namespace Office {
         *
         * - Windows: 500 members
         *
-        * - Mac: 100 members
+        * - Classic Mac UI: 100 members
         *
-        * - Other: No limit
+        * - New Mac UI, web browser, Android: No limit
         *
         * *Compose mode*
         *
@@ -10856,9 +10862,9 @@ declare namespace Office {
         *
         * - Windows: 500 members
         *
-        * - Mac: 100 members
+        * - Classic Mac UI: 100 members
         *
-        * - Other: No limit
+        * - New Mac UI, web browser, Android: No limit
         *
         * *Compose mode*
         *
@@ -11141,11 +11147,11 @@ declare namespace Office {
          * The `optionalAttendees` property returns an array that contains an {@link Office.EmailAddressDetails | EmailAddressDetails} object for
          * each optional attendee to the meeting. Collection size limits:
          *
-         * - Windows: 500 members
-         *
-         * - Mac: 100 members
-         *
-         * - Other: No limit
+        * - Windows: 500 members
+        *
+        * - Classic Mac UI: 100 members
+        *
+        * - New Mac UI, web browser, Android: No limit
          *
          * @remarks
          *
@@ -11189,11 +11195,11 @@ declare namespace Office {
          * The `requiredAttendees` property returns an array that contains an {@link Office.EmailAddressDetails | EmailAddressDetails} object for
          * each required attendee to the meeting. Collection size limits:
          *
-         * - Windows: 500 members
-         *
-         * - Mac: 100 members
-         *
-         * - Other: No limit
+        * - Windows: 500 members
+        *
+        * - Classic Mac UI: 100 members
+        *
+        * - New Mac UI, web browser, Android: No limit
          *
          * @remarks
          *
@@ -15995,11 +16001,11 @@ declare namespace Office {
          *
          * - Windows: 500 members
          *
-         * - Mac: 100 members
+         * - Classic Mac UI: 100 members
          *
          * - Web browser: 20 members
          *
-         * - Other: No limit
+         * - New Mac UI, Android: No limit
          *
          * @remarks
          *
@@ -16293,11 +16299,11 @@ declare namespace Office {
          *
          * - Windows: 500 members
          *
-         * - Mac: 100 members
+         * - Classic Mac UI: 100 members
          *
          * - Web browser: 20 members
          *
-         * - Other: No limit
+         * - New Mac UI, Android: No limit
          *
          * @remarks
          *
@@ -17440,9 +17446,9 @@ declare namespace Office {
          * - Windows: 100 recipients.
          * **Note**: Can call API repeatedly but the maximum number of recipients in the target field on the item is 500 recipients.
          *
-         * - Mac, web browser: 100 recipients
+         * - Classic Mac UI, web browser: 100 recipients
          *
-         * - Other: No limit
+         * - New Mac UI, Android: No limit
          *
          * @remarks
          * [Api set: Mailbox 1.1]
@@ -17478,9 +17484,9 @@ declare namespace Office {
          * - Windows: 100 recipients.
          * **Note**: Can call API repeatedly but the maximum number of recipients in the target field on the item is 500 recipients.
          *
-         * - Mac, web browser: 100 recipients
+         * - Classic Mac UI, web browser: 100 recipients
          *
-         * - Other: No limit
+         * - New Mac UI, Android: No limit
          *
          * @remarks
          * [Api set: Mailbox 1.1]
@@ -17504,14 +17510,9 @@ declare namespace Office {
          * When the call completes, the `asyncResult.value` property will contain an array of {@link Office.EmailAddressDetails | EmailAddressDetails}
          * objects. Collection size limits:
          *
-         * - Windows, Mac, web browser: 500 members
-         *
-         * - Other: No limit
+         * - Windows, classic Mac UI, web browser: 500 members
          *
-         * **Important**: In Outlook on the web, if a user created a new message by activating a contact's email address link from their contact or
-         * profile card, your add-in's `getAsync` call currently won't return a value in the `displayName` property of the
-         * associated `EmailAddressDetails` object. For more details, refer to the
-         * {@link https://github.com/OfficeDev/office-js/issues/2201 | related GitHub issue}.
+         * - New Mac UI, Android: No limit
          *
          * @remarks
          * [Api set: Mailbox 1.1]
@@ -17519,6 +17520,24 @@ declare namespace Office {
          * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem`
          *
          * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
+         * 
+         * **Important**: In Outlook on the web and on Windows, if a user creates a new message by activating a contact's email address link from their contact
+         * or profile card, your add-in's `Recipients.getAsync` call returns the contact's email address in the `displayName` property of the associated
+         * `EmailAddressDetails` object instead of the contact's saved name. For more details, refer to the
+         * {@link https://github.com/OfficeDev/office-js/issues/2201 | related GitHub issue}.
+         * 
+         * **Important**: The `getAsync` method only returns recipients resolved by the Outlook client. A resolved recipient has the following characteristics.
+         * 
+         * - If the recipient has a saved entry in the sender's address book, Outlook resolves the email address to the recipient's saved display name.
+         * 
+         * - A Teams meeting status icon appears before the recipient's name or email address.
+         * 
+         * - A semicolon appears after the recipient's name or email address.
+         * 
+         * - The recipient's name or email address is underlined or enclosed in a box.
+         * 
+         * To resolve an email address once it's added to a mail item, the sender must use the **Tab** key or select a suggested contact or email address from 
+         * the auto-complete list.
          *
          * @param options - An object literal that contains one or more of the following properties.
          *        `asyncContext`: Developers can provide any object they wish to access in the callback method.
@@ -17532,14 +17551,9 @@ declare namespace Office {
          * When the call completes, the `asyncResult.value` property will contain an array of {@link Office.EmailAddressDetails | EmailAddressDetails}
          * objects. Collection size limits:
          *
-         * - Windows, Mac, web browser: 500 members
-         *
-         * - Other: No limit
+         * - Windows, classic Mac UI, web browser: 500 members
          *
-         * **Important**: In Outlook on the web, if a user created a new message by activating a contact's email address link from their contact or
-         * profile card, your add-in's `getAsync` call currently won't return a value in the `displayName` property of the
-         * associated `EmailAddressDetails` object. For more details, refer to the
-         * {@link https://github.com/OfficeDev/office-js/issues/2201 | related GitHub issue}.
+         * - New Mac UI, Android: No limit
          *
          * @remarks
          * [Api set: Mailbox 1.1]
@@ -17547,6 +17561,24 @@ declare namespace Office {
          * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem`
          *
          * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
+         * 
+         * **Important**: In Outlook on the web and on Windows, if a user creates a new message by activating a contact's email address link from their contact
+         * or profile card, your add-in's `Recipients.getAsync` call returns the contact's email address in the `displayName` property of the associated
+         * `EmailAddressDetails` object instead of the contact's saved name. For more details, refer to the
+         * {@link https://github.com/OfficeDev/office-js/issues/2201 | related GitHub issue}.
+         * 
+         * **Important**: The `getAsync` method only returns recipients resolved by the Outlook client. A resolved recipient has the following characteristics.
+         * 
+         * - If the recipient has a saved entry in the sender's address book, Outlook resolves the email address to the recipient's saved display name.
+         * 
+         * - A Teams meeting status icon appears before the recipient's name or email address.
+         * 
+         * - A semicolon appears after the recipient's name or email address.
+         * 
+         * - The recipient's name or email address is underlined or enclosed in a box.
+         * 
+         * To resolve an email address once it's added to a mail item, the sender must use the **Tab** key or select a suggested contact or email address from 
+         * the auto-complete list.
          *
          * @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter
          *                 of type `Office.AsyncResult`. The `value` property of the result is an array of `EmailAddressDetails` objects.
@@ -17567,9 +17599,12 @@ declare namespace Office {
          *
          * Maximum number that can be set:
          *
-         * - Windows, Mac, web browser: 100 recipients
+         * - Windows: 100 recipients.
+         * **Note**: Can call API repeatedly but the maximum number of recipients in the target field on the item is 500 recipients.
+         *
+         * - Classic Mac UI, web browser: 100 recipients
          *
-         * - Other: No limit
+         * - New Mac UI, Android: No limit
          *
          * @remarks
          * [Api set: Mailbox 1.1]
@@ -17605,9 +17640,12 @@ declare namespace Office {
          *
          * Maximum number that can be set:
          *
-         * - Windows, Mac, web browser: 100 recipients
+         * - Windows: 100 recipients.
+         * **Note**: Can call API repeatedly but the maximum number of recipients in the target field on the item is 500 recipients.
+         *
+         * - Classic Mac UI, web browser: 100 recipients
          *
-         * - Other: No limit
+         * - New Mac UI, Android: No limit
          *
          * @remarks
          * [Api set: Mailbox 1.1]

office-js-preview/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@types/office-js-preview",
-    "version": "1.0.314",
+    "version": "1.0.317",
     "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": "6d76cd8d1b85ff8d38e7c351dcbd2c4d888c5cd51d7f84d58b3c54db021594b5",
+    "typesPublisherContentHash": "f19ecff4c37e5e2bfe90d4e84f785282ed2b85d00355182d4fb4e0c340eea623",
     "typeScriptVersion": "4.0"
 }