@types/office-js-preview 1.0.460 → 1.0.462

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: Tue, 02 Apr 2024 15:35:41 GMT
+ * Last updated: Tue, 09 Apr 2024 18:07:35 GMT
  * Dependencies: none
 
 # Credits

office-js-preview/index.d.ts

@@ -11377,9 +11377,9 @@ declare namespace Office {
          */
         isAllDayEvent: boolean;
         /**
-         * Gets the Exchange Web Services item class of the selected item.
+         * Gets the Exchange Web Services item class of the selected appointment.
          *
-         * You can create custom message classes that extends a default message class, for example, a custom appointment message class `IPM.Appointment.Contoso`.
+         * Returns `IPM.Appointment` for non-recurring appointments and `IPM.Appointment.Occurrence` for recurring appointments.
          *
          * @remarks
          *
@@ -11387,26 +11387,7 @@ declare namespace Office {
          *
          * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee
          *
-         * The `itemClass` property specifies the message class of the selected item. The following are the default message classes for the message or appointment item.
-         *
-         * <table>
-         *   <tr>
-         *     <th>Type</th>
-         *     <th>Description</th>
-         *     <th>Item Class</th>
-         *   </tr>
-         *   <tr>
-         *     <td>Appointment items</td>
-         *     <td>These are calendar items of the item class IPM.Appointment or IPM.Appointment.Occurrence.</td>
-         *     <td>IPM.Appointment, IPM.Appointment.Occurrence</td>
-         *   </tr>
-         *   <tr>
-         *     <td>Message items</td>
-         *     <td>These include email messages that have the default message class IPM.Note, and meeting requests, responses, and cancellations, that use IPM.Schedule.Meeting as the base message class.</td>
-         *     <td>IPM.Note, IPM.Schedule.Meeting.Request, IPM.Schedule.Meeting.Neg, IPM.Schedule.Meeting.Pos, IPM.Schedule.Meeting.Tent, IPM.Schedule.Meeting.Canceled</td>
-         *   </tr>
-         * </table>
-         *
+         * **Important**: You can create custom classes that extend a default item class. For example, `IPM.Appointment.Contoso`.
          */
         itemClass: string;
         /**
@@ -15260,6 +15241,29 @@ declare namespace Office {
          *
          * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read
          *
+         * **Important**:
+         *
+         * - In October 2024, legacy Exchange {@link https://learn.microsoft.com/office/dev/add-ins/outlook/authentication#exchange-user-identity-token | user identity} and
+         * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/authentication#callback-tokens | callback} tokens will be turned off by default for all Exchange Online tenants.
+         * This is part of {@link https://blogs.microsoft.com/on-the-issues/2023/11/02/secure-future-initiative-sfi-cybersecurity-cyberattacks/ | Microsoft's Secure Future Initiative},
+         * which gives organizations the tools needed to respond to the current threat landscape. Exchange user identity tokens will still work for Exchange on-premises.
+         * Nested app authentication is the recommended approach for tokens going forward. For more information, see our {@link https://aka.ms/NAApreviewblog | blog post} and
+         * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/faq-nested-app-auth-outlook-legacy-tokens | FAQ page}.
+         *
+         * - This method is only supported in read mode in Outlook on Android and on iOS. For more information on supported APIs in Outlook mobile, see
+         * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
+         * 
+         * - EWS operations aren't supported in add-ins running in Outlook on iOS and on Android. A REST token is always returned in Outlook
+         * mobile clients even if `options.isRest` is set to `false`.
+         *
+         *- Calling the `getCallbackTokenAsync` method in read mode requires a minimum permission level of **read item**.
+         *
+         * - Calling the `getCallbackTokenAsync` method in compose mode requires you to have saved the item.
+         * The `saveAsync` method requires a minimum permission level of **read/write item**.
+         *
+         * - For guidance on delegate or shared scenarios, see the
+         * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/delegate-access | shared folders and shared mailbox} article.
+         *
          * *REST Tokens*
          *
          * When a REST token is requested (`options.isRest` = `true`), the resulting token won't work to authenticate EWS calls.
@@ -15294,22 +15298,6 @@ declare namespace Office {
          * attachment or item. For example, you can create a remote service to
          * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/get-attachments-of-an-outlook-item | get attachments from the selected item}.
          *
-         * **Important**:
-         *
-         * - This method is only supported in read mode in Outlook on Android and on iOS. For more information on supported APIs in Outlook mobile, see
-         * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
-         * 
-         * - EWS operations aren't supported in add-ins running in Outlook on iOS and on Android. A REST token is always returned in Outlook
-         * mobile clients even if `options.isRest` is set to `false`.
-         *
-         *- Calling the `getCallbackTokenAsync` method in read mode requires a minimum permission level of **read item**.
-         *
-         * - Calling the `getCallbackTokenAsync` method in compose mode requires you to have saved the item.
-         * The `saveAsync` method requires a minimum permission level of **read/write item**.
-         *
-         * - For guidance on delegate or shared scenarios, see the
-         * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/delegate-access | shared folders and shared mailbox} article.
-         *
          * **Errors**:
          *
          * - `HTTPRequestFailure`: The request has failed. Please look at the diagnostics object for the HTTP error code.
@@ -15343,6 +15331,13 @@ declare namespace Office {
          *
          * **Important**:
          *
+         * - In October 2024, legacy Exchange {@link https://learn.microsoft.com/office/dev/add-ins/outlook/authentication#exchange-user-identity-token | user identity} and
+         * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/authentication#callback-tokens | callback} tokens will be turned off by default for all Exchange Online tenants.
+         * This is part of {@link https://blogs.microsoft.com/on-the-issues/2023/11/02/secure-future-initiative-sfi-cybersecurity-cyberattacks/ | Microsoft's Secure Future Initiative},
+         * which gives organizations the tools needed to respond to the current threat landscape. Exchange user identity tokens will still work for Exchange on-premises.
+         * Nested app authentication is the recommended approach for tokens going forward. For more information, see our {@link https://aka.ms/NAApreviewblog | blog post} and
+         * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/faq-nested-app-auth-outlook-legacy-tokens | FAQ page}.
+         *
          * - You can pass both the token and either an attachment identifier or item identifier to an external system. That system uses
          * the token as a bearer authorization token to call the Exchange Web Services (EWS)
          * {@link https://learn.microsoft.com/exchange/client-developer/web-service-reference/getattachment-operation | GetAttachment} or
@@ -15431,7 +15426,16 @@ declare namespace Office {
          *
          * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read
          *
-         * The `getUserIdentityTokenAsync` method returns a token that you can use to identify and
+         * **Important**:
+         *
+         * - In October 2024, legacy Exchange {@link https://learn.microsoft.com/office/dev/add-ins/outlook/authentication#exchange-user-identity-token | user identity} and
+         * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/authentication#callback-tokens | callback} tokens will be turned off by default for all Exchange Online tenants.
+         * This is part of {@link https://blogs.microsoft.com/on-the-issues/2023/11/02/secure-future-initiative-sfi-cybersecurity-cyberattacks/ | Microsoft's Secure Future Initiative},
+         * which gives organizations the tools needed to respond to the current threat landscape. Exchange user identity tokens will still work for Exchange on-premises.
+         * Nested app authentication is the recommended approach for tokens going forward. For more information, see our {@link https://aka.ms/NAApreviewblog | blog post} and
+         * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/faq-nested-app-auth-outlook-legacy-tokens | FAQ page}.
+         *
+         * - The `getUserIdentityTokenAsync` method returns a token that you can use to identify and
          * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/authentication | authenticate the add-in and user with an external system}.
          *
          * **Errors**:
@@ -15463,6 +15467,13 @@ declare namespace Office {
          *
          * **Important**:
          *
+         * - In October 2024, legacy Exchange {@link https://learn.microsoft.com/office/dev/add-ins/outlook/authentication#exchange-user-identity-token | user identity} and
+         * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/authentication#callback-tokens | callback} tokens will be turned off by default for all Exchange Online tenants.
+         * This is part of {@link https://blogs.microsoft.com/on-the-issues/2023/11/02/secure-future-initiative-sfi-cybersecurity-cyberattacks/ | Microsoft's Secure Future Initiative},
+         * which gives organizations the tools needed to respond to the current threat landscape. Exchange user identity tokens will still work for Exchange on-premises.
+         * Nested app authentication is the recommended approach for tokens going forward. For more information, see our {@link https://aka.ms/NAApreviewblog | blog post} and
+         * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/faq-nested-app-auth-outlook-legacy-tokens | FAQ page}.
+         *
          * - To enable the `makeEwsRequestAsync` method to make EWS requests, the server administrator must set `OAuthAuthentication` to `true` on the
          * Client Access Server EWS directory .
          *
@@ -15882,6 +15893,26 @@ declare namespace Office {
          * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/mobile-event-based | Implement event-based activation in Outlook mobile add-ins}.
          */
         from: From;
+        /**
+         * Gets the message ID of the original message being replied to by the current message.
+         *
+         * @remarks
+         * [Api set: Mailbox preview]
+         *
+         * **{@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}**: Message Compose
+         *
+         * **Important**:
+         *
+         * - To preview the `inReplyTo` property, you must install Outlook on Windows Version 2402 (Build 17317.20000) or later. Then, join the
+         * {@link https://insider.microsoft365.com/join/Windows | Microsoft 365 Insider program} and select the **Beta Channel** option to access Office beta builds.
+         *
+         * - In Outlook on Windows, the `inReplyTo` value is maintained on all replies regardless of changes made by the user, such as changing the subject in a reply.
+         *
+         * @beta
+         */
+        inReplyTo: string;
         /**
          * Gets or sets the custom internet headers of a message.
          *
@@ -16561,6 +16592,54 @@ declare namespace Office {
          * An object with `ComposeType` and `CoercionType` enum values for the message item.
          */
         getComposeTypeAsync(callback: (asyncResult: Office.AsyncResult<any>) => void): void;
+        /**
+         * Gets the Base64-encoded position of the current message in a conversation thread.
+         *
+         * @remarks
+         * [Api set: Mailbox preview]
+         *
+         * **{@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}**: Message Compose
+         *
+         * **Important**: To preview the `getConversationIndexAsync` method, you must install Outlook on Windows Version 2402 (Build 17317.20000) or later. Then, join the
+         * {@link https://insider.microsoft365.com/join/Windows | Microsoft 365 Insider program} and select the **Beta Channel** option to access Office beta builds.
+         *
+         * **Tip**: You can use the conversation index to locate a message in a conversation thread. Then, use its contents
+         * to provide context for the current message being composed.
+         *
+         * @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, `asyncResult`, which is an
+         *                 `Office.AsyncResult` object. The Base64-encoded position of the current message in a conversation is returned in the `asyncResult.value`
+         *                 property.
+         *
+         * @beta
+         */
+        getConversationIndexAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<string>) => void): void;
+        /**
+         * Gets the Base64-encoded position of the current message in a conversation thread.
+         *
+         * @remarks
+         * [Api set: Mailbox preview]
+         *
+         * **{@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}**: Message Compose
+         *
+         * **Important**: To preview the `getConversationIndexAsync` method, you must install Outlook on Windows Version 2402 (Build 17317.20000) or later. Then, join the
+         * {@link https://insider.microsoft365.com/join/Windows | Microsoft 365 Insider program} and select the **Beta Channel** option to access Office beta builds.
+         *
+         * **Tip**: You can use the conversation index to locate a message in a conversation thread. Then, use its contents
+         * to provide context for the current message being composed.
+         *
+         * @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. The Base64-encoded position of the current message in a conversation is returned in the `asyncResult.value`
+         *                 property.
+         *
+         * @beta
+         */
+        getConversationIndexAsync(callback: (asyncResult: Office.AsyncResult<string>) => void): void;
         /**
          * Gets initialization data passed when the add-in is {@link https://learn.microsoft.com/outlook/actionable-messages/invoke-add-in | activated by an actionable message}.
          *
@@ -16576,7 +16655,7 @@ declare namespace Office {
          * @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter
          *                 of type `Office.AsyncResult`.
          *                 On success, the initialization context data is provided as a string (or an empty string if there's no initialization context)
-         *                 in the `asyncResult.value` property..
+         *                 in the `asyncResult.value` property.
          */
         getInitializationContextAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<string>) => void): void;
         /**
@@ -16595,6 +16674,116 @@ declare namespace Office {
          *                 in the `asyncResult.value` property.
          */
         getInitializationContextAsync(callback: (asyncResult: Office.AsyncResult<string>) => void): void;
+        /**
+         * Gets the Exchange Web Services item class of the selected message.
+         *
+         * @remarks
+         * [Api set: Mailbox preview]
+         *
+         * **{@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}**: Message Compose
+         *
+         * **Important**:
+         *
+         * To preview the `getItemClassAsync` method, you must install Outlook on Windows Version 2402 (Build 17317.20000) or later. Then, join the
+         * {@link https://insider.microsoft365.com/join/Windows | Microsoft 365 Insider program} and select the **Beta Channel** option to access Office beta builds.
+         *
+         * The following table lists the default message classes.
+         *
+         * <table>
+         *   <tr>
+         *     <th>Item class</th>
+         *     <th>Description</th>
+         *   </tr>
+         *   <tr>
+         *     <td>IPM.Note</td>
+         *     <td>New messages and message replies</td>
+         *   </tr>
+         *   <tr>
+         *     <td>IPM.Schedule.Meeting.Request</td>
+         *     <td>Meeting requests</td>
+         *   </tr>
+         *   <tr>
+         *     <td>IPM.Schedule.Meeting.Canceled</td>
+         *     <td>Meeting cancellations</td>
+         *   </tr>
+         *   <tr>
+         *     <td>IPM.Schedule.Meeting.Resp.Neg</td>
+         *     <td>Responses to decline meeting requests</td>
+         *   </tr>
+         *   <tr>
+         *     <td>IPM.Schedule.Meeting.Resp.Pos</td>
+         *     <td>Responses to accept meeting requests</td>
+         *   </tr>
+         *   <tr>
+         *     <td>IPM.Schedule.Meeting.Resp.Tent</td>
+         *     <td>Responses to tentatively accept meeting requests</td>
+         *   </tr>
+         * </table>
+         *
+         * @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, `asyncResult`, which is an
+         *                   `Office.AsyncResult` object. The message class is returned in the `asyncResult.value` property.
+         *
+         * @beta
+         */
+        getItemClassAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<string>) => void): void;
+        /**
+         * Gets the Exchange Web Services item class of the selected message.
+         *
+         * @remarks
+         * [Api set: Mailbox preview]
+         *
+         * **{@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}**: Message Compose
+         *
+         * **Important**:
+         *
+         * To preview the `getItemClassAsync` method, you must install Outlook on Windows Version 2402 (Build 17317.20000) or later. Then, join the
+         * {@link https://insider.microsoft365.com/join/Windows | Microsoft 365 Insider program} and select the **Beta Channel** option to access Office beta builds.
+         *
+         * The following table lists the default message classes.
+         *
+         * <table>
+         *   <tr>
+         *     <th>Item class</th>
+         *     <th>Description</th>
+         *   </tr>
+         *   <tr>
+         *     <td>IPM.Note</td>
+         *     <td>New messages and message replies</td>
+         *   </tr>
+         *   <tr>
+         *     <td>IPM.Schedule.Meeting.Request</td>
+         *     <td>Meeting requests</td>
+         *   </tr>
+         *   <tr>
+         *     <td>IPM.Schedule.Meeting.Canceled</td>
+         *     <td>Meeting cancellations</td>
+         *   </tr>
+         *   <tr>
+         *     <td>IPM.Schedule.Meeting.Resp.Neg</td>
+         *     <td>Responses to decline meeting requests</td>
+         *   </tr>
+         *   <tr>
+         *     <td>IPM.Schedule.Meeting.Resp.Pos</td>
+         *     <td>Responses to accept meeting requests</td>
+         *   </tr>
+         *   <tr>
+         *     <td>IPM.Schedule.Meeting.Resp.Tent</td>
+         *     <td>Responses to tentatively accept meeting requests</td>
+         *   </tr>
+         * </table>
+         *
+         * @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. The message class is returned in the `asyncResult.value` property.
+         *
+         * @beta
+         */
+        getItemClassAsync(callback: (asyncResult: Office.AsyncResult<string>) => void): void;
         /**
          * Asynchronously gets the ID of a saved item.
          *
@@ -17243,10 +17432,7 @@ declare namespace Office {
          */
         internetMessageId: string;
         /**
-         * Gets the Exchange Web Services item class of the selected item.
-         *
-         * You can create custom message classes that extends a default message class, for example, a custom appointment message class
-         * `IPM.Appointment.Contoso`.
+         * Gets the Exchange Web Services item class of the selected message.
          *
          * @remarks
          *
@@ -17254,27 +17440,42 @@ declare namespace Office {
          *
          * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read
          *
-         * The `itemClass` property specifies the message class of the selected item.
-         * The following are the default message classes for the message or appointment item.
+         * **Important**:
+         *
+         * The following table lists the default item classes for messages.
          *
          * <table>
          *   <tr>
-         *     <th>Type</th>
+         *     <th>Item class</th>
          *     <th>Description</th>
-         *     <th>Item Class</th>
          *   </tr>
          *   <tr>
-         *     <td>Appointment items</td>
-         *     <td>These are calendar items of the item class IPM.Appointment or IPM.Appointment.Occurrence.</td>
-         *     <td>IPM.Appointment, IPM.Appointment.Occurrence</td>
+         *     <td>IPM.Note</td>
+         *     <td>New messages and message replies</td>
+         *   </tr>
+         *   <tr>
+         *     <td>IPM.Schedule.Meeting.Request</td>
+         *     <td>Meeting requests</td>
+         *   </tr>
+         *   <tr>
+         *     <td>IPM.Schedule.Meeting.Canceled</td>
+         *     <td>Meeting cancellations</td>
+         *   </tr>
+         *   <tr>
+         *     <td>IPM.Schedule.Meeting.Resp.Neg</td>
+         *     <td>Responses to decline meeting requests</td>
+         *   </tr>
+         *   <tr>
+         *     <td>IPM.Schedule.Meeting.Resp.Pos</td>
+         *     <td>Responses to accept meeting requests</td>
          *   </tr>
          *   <tr>
-         *     <td>Message items</td>
-         *     <td>These include email messages that have the default message class IPM.Note, and meeting requests, responses, and cancellations, that use IPM.Schedule.Meeting as the base message class.</td>
-         *     <td>IPM.Note, IPM.Schedule.Meeting.Request, IPM.Schedule.Meeting.Neg, IPM.Schedule.Meeting.Pos, IPM.Schedule.Meeting.Tent, IPM.Schedule.Meeting.Canceled</td>
+         *     <td>IPM.Schedule.Meeting.Resp.Tent</td>
+         *     <td>Responses to tentatively accept meeting requests</td>
          *   </tr>
          * </table>
          *
+         * You can create custom classes that extend a default item class. For example, `IPM.Note.Contoso`.
          */
         itemClass: string;
         /**

office-js-preview/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@types/office-js-preview",
-    "version": "1.0.460",
+    "version": "1.0.462",
     "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": "6d8437911871583e8bced0e12e47bd0f255cabdceb85e0373a27f7dd6845ef9b",
+    "typesPublisherContentHash": "54eeb9c6a05e90d9e031c3dc7722618c217a413fa27092d699e4c32bb4d809b8",
     "typeScriptVersion": "4.7",
     "nonNpm": true
 }