@types/office-js 1.0.447 → 1.0.449

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: Tue, 19 Nov 2024 18:38:08 GMT
+ * Last updated: Thu, 21 Nov 2024 00:04:08 GMT
  * Dependencies: none
 
 # Credits

office-js/index.d.ts

@@ -9335,9 +9335,9 @@ declare namespace Office {
          * method. If you're on an Outlook on Windows version that only supports the `postProcessingAction` property,
          * you must assign it different string values. For a list of supported string values, see
          * {@link https://learn.microsoft.com/javascript/api/outlook/office.spamreportingeventcompletedoptions#outlook-office-spamreportingeventcompletedoptions-postprocessingaction-member |
-        * Office.SpamReportingEventCompletedOptions.postProcessingAction}.
-        */
-       enum MoveSpamItemTo {
+         * Office.SpamReportingEventCompletedOptions.postProcessingAction}.
+         */
+        enum MoveSpamItemTo {
            /**
             * Specifies that a reported message is moved to a custom folder in the mailbox.
             */
@@ -9354,7 +9354,49 @@ declare namespace Office {
             * Specifies that a reported message remains in its current folder in the mailbox.
             */
            NoMove = "noMove"
-       }
+        }
+        /**
+         * Specifies the location from which an add-in wants to access data.
+         *
+         * @remarks
+         *
+         * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose, Read
+         *
+         * **Important**: This enum is only supported in Outlook on Android and on iOS starting in Version 4.2443.0. To learn more about APIs supported in Outlook on mobile devices, see
+         * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
+         */
+        enum OpenLocation {
+            /**
+             * A location associated with an account within an add-in.
+             */
+            AccountDocument,
+            /**
+             * The device's camera.
+             */
+            Camera,
+            /**
+             * Local storage on a device.
+             */
+            Local,
+            /**
+             * OneDrive for Business.
+             *
+             * **Important**: For OneDrive Personal, use OTHER.
+             */
+            OnedriveForBusiness,
+            /**
+             * Other cloud storage providers, including OneDrive Personal.
+             */
+            Other,
+            /**
+             * The device's photo library.
+             */
+            PhotoLibrary,
+            /**
+             * SharePoint. Includes both SharePoint Online and SharePoint on-premises (if accessed with a Microsoft Entra ID account).
+             */
+            SharePoint
+        }
         /**
          * Represents the current view of Outlook on the web.
          */
@@ -10061,6 +10103,56 @@ declare namespace Office {
              */
             Beta = "beta"
         }
+        /**
+         * Specifies the location in which an add-in wants to save data.
+         *
+         * @remarks
+         *
+         * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose, Read
+         *
+         * **Important**: This enum is only supported in Outlook on Android and on iOS starting in Version 4.2443.0. To learn more about APIs supported in Outlook on mobile devices, see
+         * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
+         */
+        enum SaveLocation {
+            /**
+             * A location associated with an account within an add-in.
+             */
+            AccountDocument,
+            /**
+             * Box.
+             */
+            Box,
+            /**
+             * Dropbox.
+             */
+            Dropbox,
+            /**
+             * Google Drive.
+             */
+            GoogleDrive,
+            /**
+             * Local storage on a device.
+             */
+            Local,
+            /**
+             * OneDrive for Business.
+             *
+             * **Important**: For OneDrive Personal, use OTHER.
+             */
+            OnedriveForBusiness,
+            /**
+             * Other cloud storage providers, including OneDrive Personal.
+             */
+            Other,
+            /**
+             * The device's photo library.
+             */
+            PhotoLibrary,
+            /**
+             * SharePoint. Includes both SharePoint Online and SharePoint on-premises (if accessed with a Microsoft Entra ID account).
+             */
+            SharePoint
+        }
         /**
          * Specifies the {@link https://learn.microsoft.com/office/dev/add-ins/outlook/onmessagesend-onappointmentsend-events#available-send-mode-options | send mode option}
          * that overrides the option set in the manifest at runtime.
@@ -10420,7 +10512,7 @@ declare namespace Office {
          * The `addFileAttachmentAsync` method uploads the file at the specified URI and attaches it to the item in the compose form.
          *
          * @remarks
-         * [Api set: Mailbox 1.1]
+         * [Api set: Mailbox 1.1 for Outlook on Windows (classic) and on Mac, Mailbox 1.8 for Outlook on the web and new Outlook on Windows]
          *
          * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item**
          *
@@ -10428,8 +10520,11 @@ declare namespace Office {
          *
          * **Important**:
          *
+         * - This method isn't supported in Outlook on iOS or Android. 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}.
+         *
          * - In recent builds of classic Outlook on Windows, a bug was introduced that incorrectly appends an `Authorization: Bearer` header to
-         * this action (whether using this API or the Outlook UI). To work around this issue, you can try using the `addFileAttachmentFromBase64` API
+         * this action (whether using this API or the Outlook UI). To work around this issue, use the `addFileAttachmentFromBase64` API
          * introduced with requirement set 1.8.
          *
          * - The URI of the file to be attached must support caching in production. The server hosting the image shouldn't return a `Cache-Control` header that
@@ -10464,7 +10559,7 @@ declare namespace Office {
          * The `addFileAttachmentAsync` method uploads the file at the specified URI and attaches it to the item in the compose form.
          *
          * @remarks
-         * [Api set: Mailbox 1.1]
+         * [Api set: Mailbox 1.1 for Outlook on Windows (classic) and on Mac, Mailbox 1.8 for Outlook on the web and new Outlook on Windows]
          *
          * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item**
          *
@@ -10472,8 +10567,11 @@ declare namespace Office {
          *
          * **Important**:
          *
+         * - This method isn't supported in Outlook on iOS or Android. 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}.
+         *
          * - In recent builds of classic Outlook on Windows, a bug was introduced that incorrectly appends an `Authorization: Bearer` header to
-         * this action (whether using this API or the Outlook UI). To work around this issue, you can try using the `addFileAttachmentFromBase64` API
+         * this action (whether using this API or the Outlook UI). To work around this issue, use the `addFileAttachmentFromBase64` API
          * introduced with requirement set 1.8.
          *
          * - The URI of the file to be attached must support caching in production. The server hosting the image shouldn't return a `Cache-Control` header that
@@ -15591,6 +15689,73 @@ declare namespace Office {
          * @param userContext - Optional. Any state data that is passed to the asynchronous method.
          */
         getCallbackTokenAsync(callback: (asyncResult: Office.AsyncResult<string>) => void, userContext?: any): void;
+        /**
+         * Returns true if the current mailbox is managed by {@link https://learn.microsoft.com/mem/intune/fundamentals/what-is-intune | Microsoft Intune}.
+         *
+         * @remarks
+         *
+         * **{@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, Read
+         *
+         * **Important**: This method is only supported in Outlook on Android and on iOS starting in Version 4.2443.0.To learn more about APIs supported in Outlook on mobile devices, see
+         * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
+         *
+         * **Errors**:
+         *
+         * - `MAMServiceNotAvailable`: The client is unable to fetch the mobile application management (MAM) policy.
+         *
+         * @returns True if the current mailbox is managed by Microsoft Intune.
+         */
+        getIsIdentityManaged(): boolean;
+        /**
+         * Returns true if an organization's {@link https://learn.microsoft.com/mem/intune/apps/app-management | Intune mobile application management (MAM) policy}
+         * allows an add-in to access data from the specified location.
+         *
+         * @remarks
+         *
+         * **{@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, Read
+         *
+         * **Important**: This method is only supported in Outlook on Android and on iOS starting in Version 4.2443.0. To learn more about APIs supported in Outlook on mobile devices, see
+         * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
+         *
+         * **Errors**:
+         *
+         * - `InvalidOpenLocationInput`: The value of the specified location is invalid.
+         *
+         * - `MAMServiceNotAvailable`: The client is unable to fetch the MAM policy.
+         *
+         * @param openLocation - The location from which the add-in is attempting to access data.
+         *
+         * @returns True if an organization's Intune MAM policy allows an add-in to access data from the specified location.
+         */
+        getIsOpenFromLocationAllowed(openLocation: MailboxEnums.OpenLocation): boolean;
+        /**
+         * Returns true if an organization's {@link https://learn.microsoft.com/mem/intune/apps/app-management | Intune mobile application management (MAM) policy}
+         * allows an add-in to save data to the specified location.
+         *
+         * @remarks
+         *
+         * **{@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, Read
+         *
+         * **Important**: This method is only supported in Outlook on Android and on iOS starting in Version 4.2443.0. To learn more about APIs supported in Outlook on mobile devices, see
+         * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
+         *
+         * **Errors**:
+         *
+         * - `InvalidSaveLocationInput`: The value of the specified location is invalid.
+         *
+         * - `MAMServiceNotAvailable`: The client is unable to fetch the MAM policy.
+         *
+         * @param saveLocation - The location in which the add-in is attempting to save data.
+         *
+         * @returns True if an organization's Intune MAM policy allows an add-in to save data to the specified location.
+         */
+        getIsSaveToLocationAllowed(saveLocation: MailboxEnums.SaveLocation): boolean;
         /**
          * Gets currently selected messages on which an add-in can activate and perform operations. An add-in can activate on a maximum of 100 messages at a time.
          * To learn more about item multi-select, see
@@ -16307,7 +16472,7 @@ declare namespace Office {
          * The `addFileAttachmentAsync` method uploads the file at the specified URI and attaches it to the item in the compose form.
          *
          * @remarks
-         * [Api set: Mailbox 1.1]
+         * [Api set: Mailbox 1.1 for Outlook on Windows (classic) and on Mac, Mailbox 1.8 for Outlook on the web and new Outlook on Windows]
          *
          * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item**
          *
@@ -16315,8 +16480,11 @@ declare namespace Office {
          *
          * **Important**:
          *
+         * - This method isn't supported in Outlook on iOS or Android. 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}.
+         *
          * - In recent builds of classic Outlook on Windows, a bug was introduced that incorrectly appends an `Authorization: Bearer` header to
-         * this action (whether using this API or the Outlook UI). To work around this issue, you can try using the `addFileAttachmentFromBase64` API
+         * this action (whether using this API or the Outlook UI). To work around this issue, use the `addFileAttachmentFromBase64` API
          * introduced with requirement set 1.8.
          *
          * - The URI of the file to be attached must support caching in production. The server hosting the image shouldn't return a `Cache-Control` header that
@@ -16350,7 +16518,7 @@ declare namespace Office {
          * The `addFileAttachmentAsync` method uploads the file at the specified URI and attaches it to the item in the compose form.
          *
          * @remarks
-         * [Api set: Mailbox 1.1]
+         * [Api set: Mailbox 1.1 for Outlook on Windows (classic) and on Mac, Mailbox 1.8 for Outlook on the web and new Outlook on Windows]
          *
          * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item**
          *
@@ -16358,8 +16526,11 @@ declare namespace Office {
          *
          * **Important**:
          *
+         * - This method isn't supported in Outlook on iOS or Android. 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}.
+         *
          * - In recent builds of classic Outlook on Windows, a bug was introduced that incorrectly appends an `Authorization: Bearer` header to
-         * this action (whether using this API or the Outlook UI). To work around this issue, you can try using the `addFileAttachmentFromBase64` API
+         * this action (whether using this API or the Outlook UI). To work around this issue, use the `addFileAttachmentFromBase64` API
          * introduced with requirement set 1.8.
          *
          * - The URI of the file to be attached must support caching in production. The server hosting the image shouldn't return a `Cache-Control` header that

office-js/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@types/office-js",
-    "version": "1.0.447",
+    "version": "1.0.449",
     "description": "TypeScript definitions for office-js",
     "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-js",
     "license": "MIT",
@@ -46,6 +46,6 @@
     "scripts": {},
     "dependencies": {},
     "peerDependencies": {},
-    "typesPublisherContentHash": "399996e9f6742b2a3843d349365e7d2f44843f68f8d3fa315676a29655edda7e",
+    "typesPublisherContentHash": "fbe1ad460bb063e92ca5da8df34257cef4f2c54925e43ab7c08e540a646f4200",
     "typeScriptVersion": "4.9"
 }