@types/office-js 1.0.333 → 1.0.334

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: Thu, 22 Jun 2023 22:32:44 GMT
+ * Last updated: Wed, 05 Jul 2023 22:32:45 GMT
  * Dependencies: none
  * Global values: `Excel`, `Office`, `OfficeCore`, `OfficeExtension`, `OneNote`, `PowerPoint`, `Visio`, `Word`
 

office-js/index.d.ts

@@ -11157,13 +11157,13 @@ declare namespace Office {
          * Provides access to the optional attendees of an event. The type of object and level of access depend on the mode of the current item.
          *
          * The `optionalAttendees` property returns an array that contains an {@link Office.EmailAddressDetails | EmailAddressDetails} object for
-         * each optional attendee to the meeting. Collection size limits:
+         * each optional attendee to the meeting. The maximum number of attendees returned varies per Outlook client.
          *
-         * - Windows: 500 members
+         * - Windows: 500 attendees
          *
-         * - Classic Mac UI: 100 members
+         * - Android, classic Mac UI, iOS: 100 attendees
          *
-         * - New Mac UI, web browser, Android: No limit
+         * - New Mac UI, web browser: No limit
          *
          * @remarks
          *
@@ -11205,13 +11205,13 @@ declare namespace Office {
          * Provides access to the required attendees of an event. The type of object and level of access depend on the mode of the current item.
          *
          * The `requiredAttendees` property returns an array that contains an {@link Office.EmailAddressDetails | EmailAddressDetails} object for
-         * each required attendee to the meeting. Collection size limits:
+         * each required attendee to the meeting. The maximum number of attendees returned varies per Outlook client.
          *
-         * - Windows: 500 members
+         * - Windows: 500 attendees
          *
-         * - Classic Mac UI: 100 members
+         * - Android, classic Mac UI, iOS: 100 attendees
          *
-         * - New Mac UI, web browser, Android: No limit
+         * - New Mac UI, web browser: No limit
          *
          * @remarks
          *
@@ -16206,15 +16206,15 @@ declare namespace Office {
          * current item.
          *
          * The `cc` property returns an array that contains an {@link Office.EmailAddressDetails | EmailAddressDetails} object for
-         * each recipient listed on the **Cc** line of the message. Collection size limits:
+         * each recipient listed on the **Cc** line of the message. The maximum number of recipients returned varies per Outlook client.
          *
-         * - Windows: 500 members
+         * - Windows: 500 recipients
          *
-         * - Classic Mac UI: 100 members
+         * - Android, classic Mac UI, iOS: 100 recipients
          *
-         * - Web browser: 20 members
+         * - Web browser: 20 recipients
          *
-         * - New Mac UI, Android: No limit
+         * - New Mac UI: No limit
          *
          * @remarks
          *
@@ -16504,15 +16504,15 @@ declare namespace Office {
          * current item.
          *
          * The `to` property returns an array that contains an {@link Office.EmailAddressDetails | EmailAddressDetails} object for
-         * each recipient listed on the **To** line of the message. Collection size limits:
+         * each recipient listed on the **To** line of the message. The maximum number of recipients returned varies per Outlook client.
          *
-         * - Windows: 500 members
+         * - Windows: 500 recipients
          *
-         * - Classic Mac UI: 100 members
+         * - Android, classic Mac UI, iOS: 100 recipients
          *
-         * - Web browser: 20 members
+         * - Web browser: 20 recipients
          *
-         * - New Mac UI, Android: No limit
+         * - New Mac UI: No limit
          *
          * @remarks
          *
@@ -17516,23 +17516,6 @@ declare namespace Office {
         /**
          * Adds a recipient list to the existing recipients for an appointment or message.
          *
-         * The recipients parameter can be an array of one of the following:
-         *
-         * - Strings containing SMTP email addresses
-         *
-         * - {@link Office.EmailUser | EmailUser} objects
-         *
-         * - {@link Office.EmailAddressDetails | EmailAddressDetails} objects
-         *
-         * Maximum number that can be added:
-         *
-         * - 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
-         *
-         * - New Mac UI, Android: No limit
-         *
          * @remarks
          * [Api set: Mailbox 1.1]
          *
@@ -17540,11 +17523,23 @@ declare namespace Office {
          *
          * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
          *
+         * **Important**: With the `addAsync` method, you can add a maximum of 100 recipients to a mail item in Outlook on Windows, on Mac (classic UI),
+         * on the web, on Android, and on iOS. However, take note of the following:
+         *
+         * - In Outlook on Windows, on Mac (classic UI), and on the web, you can have a maximum of 500 recipients in a target field.
+         * If you need to add more than 100 recipients to a mail item, you can call `addAsync` repeatedly, but be mindful of the recipient limit of the field.
+         *
+         * - In Outlook on Android and on iOS, the `addAsync` method isn't supported in Message Compose mode. Only the Appointment Organizer mode is
+         * supported.
+         *
+         * There's no recipient limit if you call `addAsync` in Outlook on Mac (new UI).
+         *
          * **Errors**:
          *
          * - `NumberOfRecipientsExceeded`: The number of recipients exceeded 100 entries.
          *
-         * @param recipients - The recipients to add to the recipients list.
+         * @param recipients - The recipients to add to the recipients list. The array of recipients can contain strings of SMTP email addresses,
+         *        {@link Office.EmailUser | EmailUser} objects, or {@link Office.EmailAddressDetails | EmailAddressDetails} objects.
          * @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 function.
          * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter
@@ -17554,23 +17549,6 @@ declare namespace Office {
         /**
          * Adds a recipient list to the existing recipients for an appointment or message.
          *
-         * The recipients parameter can be an array of one of the following:
-         *
-         * - Strings containing SMTP email addresses
-         *
-         * - {@link Office.EmailUser | EmailUser} objects
-         *
-         * - {@link Office.EmailAddressDetails | EmailAddressDetails} objects
-         *
-         * Maximum number that can be added:
-         *
-         * - 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
-         *
-         * - New Mac UI, Android: No limit
-         *
          * @remarks
          * [Api set: Mailbox 1.1]
          *
@@ -17578,11 +17556,23 @@ declare namespace Office {
          *
          * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
          *
+         * **Important**: With the `addAsync` method, you can add a maximum of 100 recipients to a mail item in Outlook on Windows, on Mac (classic UI),
+         * on the web, on Android, and on iOS. However, take note of the following:
+         *
+         * - In Outlook on Windows, on Mac (classic UI), and on the web, you can have a maximum of 500 recipients in a target field.
+         * If you need to add more than 100 recipients to a mail item, you can call `addAsync` repeatedly, but be mindful of the recipient limit of the field.
+         *
+         * - In Outlook on Android and on iOS, the `addAsync` method isn't supported in Message Compose mode. Only the Appointment Organizer mode is
+         * supported.
+         *
+         * There's no recipient limit if you call `addAsync` in Outlook on Mac (new UI).
+         *
          * **Errors**:
          *
          * - `NumberOfRecipientsExceeded`: The number of recipients exceeded 100 entries.
          *
-         * @param recipients - The recipients to add to the recipients list.
+         * @param recipients - The recipients to add to the recipients list. The array of recipients can contain strings of SMTP email addresses,
+         *        {@link Office.EmailUser | EmailUser} objects, or {@link Office.EmailAddressDetails | EmailAddressDetails} objects.
          * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter
          *                 of type `Office.AsyncResult`. If adding the recipients fails, the `asyncResult.error` property will contain an error code.
          */
@@ -17590,54 +17580,51 @@ declare namespace Office {
         /**
          * Gets a recipient list for an appointment or message.
          *
-         * When the call completes, the `asyncResult.value` property will contain an array of {@link Office.EmailAddressDetails | EmailAddressDetails}
-         * objects. Collection size limits:
-         *
-         * - Windows, classic Mac UI, web browser: 500 members
-         *
-         * - New Mac UI, Android: No limit
-         *
          * @remarks
          * [Api set: Mailbox 1.1]
          *
          * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
          *
          * **{@link https://learn.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.
-         * 
+         *
+         * **Important**:
+         *
+         * The maximum number of recipients returned by this method varies per Outlook client.
+         *
+         * - Windows, web browser, Mac (classic UI): 500 recipients
+         *
+         * - Android, iOS: 100 recipients
+         *
+         * - Mac (new UI): No limit
+         *
+         * 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 
+         *
+         * 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.
          *
+         * 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
+         * {@link Office.EmailAddressDetails | EmailAddressDetails} object instead of the contact's saved name. For more details, see
+         * {@link https://github.com/OfficeDev/office-js/issues/2201 | related GitHub issue}.
+         *
          * @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 function.
-         * @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.
+         * @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter, `asyncResult`,
+         *                 of type `Office.AsyncResult`. The `asyncResult.value` property of the result is an array of
+         *                 {@link Office.EmailAddressDetails | EmailAddressDetails} objects.
          */
         getAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<EmailAddressDetails[]>) => void): void;
         /**
          * Gets a recipient list for an appointment or message.
          *
-         * When the call completes, the `asyncResult.value` property will contain an array of {@link Office.EmailAddressDetails | EmailAddressDetails}
-         * objects. Collection size limits:
-         *
-         * - Windows, classic Mac UI, web browser: 500 members
-         *
-         * - New Mac UI, Android: No limit
-         *
          * @remarks
          * [Api set: Mailbox 1.1]
          *
@@ -17645,26 +17632,37 @@ declare namespace Office {
          *
          * **{@link https://learn.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.
-         * 
+         * **Important**:
+         *
+         * The maximum number of recipients returned by this method varies per Outlook client.
+         *
+         * - Windows, web browser, Mac (classic UI): 500 recipients
+         *
+         * - Android, iOS: 100 recipients
+         *
+         * - Mac (new UI): No limit
+         *
+         * 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 
+         *
+         * 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.
+         * 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
+         * {@link Office.EmailAddressDetails | EmailAddressDetails} object instead of the contact's saved name. For more details, see
+         * {@link https://github.com/OfficeDev/office-js/issues/2201 | related GitHub issue}.
+         *
+         * @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter, `asyncResult`,
+         *                 of type `Office.AsyncResult`. The `asyncResult.value` property of the result is an array of
+         *                 {@link Office.EmailAddressDetails | EmailAddressDetails} objects.
          */
         getAsync(callback: (asyncResult: Office.AsyncResult<EmailAddressDetails[]>) => void): void;
         /**
@@ -17672,23 +17670,6 @@ declare namespace Office {
          *
          * The `setAsync` method overwrites the current recipient list.
          *
-         * The recipients parameter can be an array of one of the following:
-         *
-         * - Strings containing SMTP email addresses
-         *
-         * - {@link Office.EmailUser | EmailUser} objects
-         *
-         * - {@link Office.EmailAddressDetails | EmailAddressDetails} objects
-         *
-         * Maximum number that can be set:
-         *
-         * - 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
-         *
-         * - New Mac UI, Android: No limit
-         *
          * @remarks
          * [Api set: Mailbox 1.1]
          *
@@ -17696,11 +17677,23 @@ declare namespace Office {
          *
          * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
          *
+         * **Important**: With the `setAsync` method, you can set a maximum of 100 recipients in Outlook on Windows, on Mac (classic UI),
+         * on the web, on Android, and on iOS. However, take note of the following:
+         *
+         * - In Outlook on Windows, on Mac (classic UI), and on the web, you can have a maximum of 500 recipients in a target field.
+         * If you need to set more than 100 recipients, you can call `setAsync` repeatedly, but be mindful of the recipient limit of the field.
+         *
+         * - In Outlook on Android and on iOS, the `setAsync` method isn't supported in the Message Compose mode. Only the Appointment Organizer mode is
+         * supported.
+         *
+         * There's no recipient limit if you call `setAsync` in Outlook on Mac (new UI).
+         *
          * **Errors**:
          *
          * - `NumberOfRecipientsExceeded`: The number of recipients exceeded 100 entries.
          *
-         * @param recipients - The recipients to add to the recipients list.
+         * @param recipients - The recipients to add to the recipients list. The array of recipients can contain strings of SMTP email addresses,
+         *        {@link Office.EmailUser | EmailUser} objects, or {@link Office.EmailAddressDetails | EmailAddressDetails} objects.
          * @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 function.
          * @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter of
@@ -17713,23 +17706,6 @@ declare namespace Office {
          *
          * The `setAsync` method overwrites the current recipient list.
          *
-         * The recipients parameter can be an array of one of the following:
-         *
-         * - Strings containing SMTP email addresses
-         *
-         * - {@link Office.EmailUser | EmailUser} objects
-         *
-         * - {@link Office.EmailAddressDetails | EmailAddressDetails} objects
-         *
-         * Maximum number that can be set:
-         *
-         * - 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
-         *
-         * - New Mac UI, Android: No limit
-         *
          * @remarks
          * [Api set: Mailbox 1.1]
          *
@@ -17737,11 +17713,23 @@ declare namespace Office {
          *
          * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
          *
+         * **Important**: With the `setAsync` method, you can set a maximum of 100 recipients in Outlook on Windows, on Mac (classic UI),
+         * on the web, on Android, and on iOS. However, take note of the following:
+         *
+         * - In Outlook on Windows, on Mac (classic UI), and on the web, you can have a maximum of 500 recipients in a target field.
+         * If you need to set more than 100 recipients, you can call `setAsync` repeatedly, but be mindful of the recipient limit of the field.
+         *
+         * - In Outlook on Android and on iOS, the `setAsync` method isn't supported in the Message Compose mode. Only the Appointment Organizer mode is
+         * supported.
+         *
+         * There's no recipient limit if you call `setAsync` in Outlook on Mac (new UI).
+         *
          * **Errors**:
          *
          * - `NumberOfRecipientsExceeded`: The number of recipients exceeded 100 entries.
          *
-         * @param recipients - The recipients to add to the recipients list.
+         * @param recipients - The recipients to add to the recipients list. The array of recipients can contain strings of SMTP email addresses,
+         *        {@link Office.EmailUser | EmailUser} objects, or {@link Office.EmailAddressDetails | EmailAddressDetails} objects.
          * @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter of
          *                 type `Office.AsyncResult`. If setting the recipients fails the `asyncResult.error` property will contain a code that
          *                 indicates any error that occurred while adding the data.

office-js/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@types/office-js",
-    "version": "1.0.333",
+    "version": "1.0.334",
     "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": "73aeaaa098e54c895e33987e7e2717756b293a2dda4237c18b98fc58f2120ea1",
+    "typesPublisherContentHash": "2428e1df634be62898a3b56a33fbb8a4f129d6bfdaa95ab4fb9131c5a7f4409a",
     "typeScriptVersion": "4.3"
 }