Merge pull request #2147 from OfficeDev/main

[Admin] (Publish)
OfficeDev · Dec 3, 2024 · 5a71564 · 5a71564
2 parents bdf6d43 + 8de9e75
commit 5a71564
Show file tree

Hide file tree

Showing 67 changed files with 2,238 additions and 196 deletions.
diff --git a/docs/code-snippets/outlook-snippets.yaml b/docs/code-snippets/outlook-snippets.yaml
@@ -769,6 +769,31 @@ Office.Mailbox#convertToUtcClientTime:member(1):
     
     // Output should be "2019-08-26T22:37:02.002Z".
     console.log(result.toISOString());
+Office.Mailbox#getIsIdentityManaged:member(1):
+  - |-
+    // Checks if the mailbox is managed by Microsoft Intune.
+    const isIdentityManaged = Office.context.mailbox.getIsIdentityManaged();
+    console.log(`Intune-managed mailbox: ${isIdentityManaged}`);
+Office.Mailbox#getIsOpenFromLocationAllowed:member(1):
+  - |-
+    // Checks if the add-in can access data from the device's photo library.
+    const isOpenFromPhotoLibraryAllowed = Office.context.mailbox.getIsOpenFromLocationAllowed(Office.MailboxEnums.OpenLocation.PhotoLibrary);
+    if (isOpenFromPhotoLibraryAllowed) {
+        console.log("Access to the photo library is allowed.");
+        // Do something.
+    } else {
+        console.log("Access to the photo library isn't allowed.");
+    }
+Office.Mailbox#getIsSaveToLocationAllowed:member(1):
+  - |-
+    // Checks if the add-in can save data to SharePoint.
+    const isSaveToSharePointAllowed = Office.context.mailbox.getIsSaveToLocationAllowed(Office.MailboxEnums.SaveLocation.SharePoint);
+    if (isSaveToSharePointAllowed) {
+        console.log("Saving to SharePoint is allowed.");
+        // Do something.
+    } else {
+        console.log("Saving to SharePoint isn't allowed.");
+    }
 Office.Mailbox#makeEwsRequestAsync:member(1):
   - |-
     function getSubjectRequest(id) {
@@ -975,6 +1000,26 @@ Office.MailboxEnums.MoveSpamItemTo:enum:
             });
         });
     }
+Office.MailboxEnums.OpenLocation:enum:
+  - |-
+    // Checks if the add-in can access data from the device's photo library.
+    const isOpenFromPhotoLibraryAllowed = Office.context.mailbox.getIsOpenFromLocationAllowed(Office.MailboxEnums.OpenLocation.PhotoLibrary);
+    if (isOpenFromPhotoLibraryAllowed) {
+        console.log("Access to the photo library is allowed.");
+        // Do something.
+    } else {
+        console.log("Access to the photo library isn't allowed.");
+    }
+Office.MailboxEnums.SaveLocation:enum:
+  - |-
+    // Checks if the add-in can save data to SharePoint.
+    const isSaveToSharePointAllowed = Office.context.mailbox.getIsSaveToLocationAllowed(Office.MailboxEnums.SaveLocation.SharePoint);
+    if (isSaveToSharePointAllowed) {
+        console.log("Saving to SharePoint is allowed.");
+        // Do something.
+    } else {
+        console.log("Saving to SharePoint isn't allowed.");
+    }
 Office.MailboxEnums.SendModeOverride:enum:
   - |-
     // The following example checks whether a location is specified in an appointment before it's sent.

diff --git a/docs/docs-ref-autogen/office/office/office.auth.yml b/docs/docs-ref-autogen/office/office/office.auth.yml
@@ -113,9 +113,6 @@ methods:
 
       **Important**: In Outlook, this API isn't supported if the add-in is loaded in an Outlook.com or Gmail
       mailbox.
-
-
-      **Warning**: `getAccessTokenAsync` has been deprecated. Use `Office.auth.getAccessToken` instead.
     remarks: >-
       **Applications**: Excel, OneNote, Outlook, PowerPoint, Word
 
@@ -176,9 +173,6 @@ methods:
 
       **Important**: In Outlook, this API isn't supported if the add-in is loaded in an Outlook.com or Gmail
       mailbox.
-
-
-      **Warning**: `getAccessTokenAsync` has been deprecated. Use `Office.auth.getAccessToken` instead.
     remarks: >-
       **Applications**: Excel, OneNote, Outlook, PowerPoint, Word
 

diff --git a/docs/docs-ref-autogen/office/office/office.authoptions.yml b/docs/docs-ref-autogen/office/office/office.authoptions.yml
@@ -83,9 +83,6 @@ properties:
     summary: >-
       Prompts the user to add their Office account (or to switch to it, if it is already added). Default value is
       `false`<!-- -->.
-
-
-      **Warning**: `forceAddAccount` has been deprecated. Use `allowSignInPrompt` instead.
     remarks: ''
     isPreview: false
     isDeprecated: true
@@ -101,9 +98,6 @@ properties:
     summary: >-
       Causes Office to display the add-in consent experience. Useful if the add-in's Azure permissions have changed or
       if the user's consent has been revoked. Default value is `false`<!-- -->.
-
-
-      **Warning**: `forceConsent` has been deprecated. Use `allowConsentPrompt` instead.
     remarks: ''
     isPreview: false
     isDeprecated: true

diff --git a/docs/docs-ref-autogen/office/office/office.requirementsetsupport.yml b/docs/docs-ref-autogen/office/office/office.requirementsetsupport.yml
@@ -33,12 +33,7 @@ methods:
     uid: 'office!Office.RequirementSetSupport#isSetSupported:member(2)'
     package: office!
     fullName: 'isSetSupported(name, minVersionNumber)'
-    summary: >-
-      Check if the specified requirement set is supported by the Office application.
-
-
-      **Warning**: This overload of `isSetSupported` (where `minVersionNumber` is a number) has been deprecated. Use
-      the string overload of `isSetSupported` instead.
+    summary: Check if the specified requirement set is supported by the Office application.
     remarks: ''
     isPreview: false
     isDeprecated: true

diff --git a/docs/docs-ref-autogen/office_release/office/office.auth.yml b/docs/docs-ref-autogen/office_release/office/office.auth.yml
@@ -113,9 +113,6 @@ methods:
 
       **Important**: In Outlook, this API isn't supported if the add-in is loaded in an Outlook.com or Gmail
       mailbox.
-
-
-      **Warning**: `getAccessTokenAsync` has been deprecated. Use `Office.auth.getAccessToken` instead.
     remarks: >-
       **Applications**: Excel, OneNote, Outlook, PowerPoint, Word
 
@@ -176,9 +173,6 @@ methods:
 
       **Important**: In Outlook, this API isn't supported if the add-in is loaded in an Outlook.com or Gmail
       mailbox.
-
-
-      **Warning**: `getAccessTokenAsync` has been deprecated. Use `Office.auth.getAccessToken` instead.
     remarks: >-
       **Applications**: Excel, OneNote, Outlook, PowerPoint, Word
 

diff --git a/docs/docs-ref-autogen/office_release/office/office.authoptions.yml b/docs/docs-ref-autogen/office_release/office/office.authoptions.yml
@@ -83,9 +83,6 @@ properties:
     summary: >-
       Prompts the user to add their Office account (or to switch to it, if it is already added). Default value is
       `false`<!-- -->.
-
-
-      **Warning**: `forceAddAccount` has been deprecated. Use `allowSignInPrompt` instead.
     remarks: ''
     isPreview: false
     isDeprecated: true
@@ -101,9 +98,6 @@ properties:
     summary: >-
       Causes Office to display the add-in consent experience. Useful if the add-in's Azure permissions have changed or
       if the user's consent has been revoked. Default value is `false`<!-- -->.
-
-
-      **Warning**: `forceConsent` has been deprecated. Use `allowConsentPrompt` instead.
     remarks: ''
     isPreview: false
     isDeprecated: true

diff --git a/docs/docs-ref-autogen/office_release/office/office.requirementsetsupport.yml b/docs/docs-ref-autogen/office_release/office/office.requirementsetsupport.yml
@@ -33,12 +33,7 @@ methods:
     uid: 'office!Office.RequirementSetSupport#isSetSupported:member(2)'
     package: office!
     fullName: 'isSetSupported(name, minVersionNumber)'
-    summary: >-
-      Check if the specified requirement set is supported by the Office application.
-
-
-      **Warning**: This overload of `isSetSupported` (where `minVersionNumber` is a number) has been deprecated. Use
-      the string overload of `isSetSupported` instead.
+    summary: Check if the specified requirement set is supported by the Office application.
     remarks: ''
     isPreview: false
     isDeprecated: true

diff --git a/docs/docs-ref-autogen/outlook/outlook/office.mailbox.yml b/docs/docs-ref-autogen/outlook/outlook/office.mailbox.yml
@@ -2163,6 +2163,20 @@ methods:
 
 
       - `MAMServiceNotAvailable`<!-- -->: The client is unable to fetch the mobile application management (MAM) policy.
+
+
+      #### Examples
+
+
+      ```TypeScript
+
+      // Checks if the mailbox is managed by Microsoft Intune.
+
+      const isIdentityManaged = Office.context.mailbox.getIsIdentityManaged();
+
+      console.log(`Intune-managed mailbox: ${isIdentityManaged}`);
+
+      ```
     isPreview: false
     isDeprecated: false
     syntax:
@@ -2201,6 +2215,26 @@ methods:
 
 
       - `MAMServiceNotAvailable`<!-- -->: The client is unable to fetch the MAM policy.
+
+
+      #### Examples
+
+
+      ```TypeScript
+
+      // Checks if the add-in can access data from the device's photo library.
+
+      const isOpenFromPhotoLibraryAllowed =
+      Office.context.mailbox.getIsOpenFromLocationAllowed(Office.MailboxEnums.OpenLocation.PhotoLibrary);
+
+      if (isOpenFromPhotoLibraryAllowed) {
+          console.log("Access to the photo library is allowed.");
+          // Do something.
+      } else {
+          console.log("Access to the photo library isn't allowed.");
+      }
+
+      ```
     isPreview: false
     isDeprecated: false
     syntax:
@@ -2243,6 +2277,26 @@ methods:
 
 
       - `MAMServiceNotAvailable`<!-- -->: The client is unable to fetch the MAM policy.
+
+
+      #### Examples
+
+
+      ```TypeScript
+
+      // Checks if the add-in can save data to SharePoint.
+
+      const isSaveToSharePointAllowed =
+      Office.context.mailbox.getIsSaveToLocationAllowed(Office.MailboxEnums.SaveLocation.SharePoint);
+
+      if (isSaveToSharePointAllowed) {
+          console.log("Saving to SharePoint is allowed.");
+          // Do something.
+      } else {
+          console.log("Saving to SharePoint isn't allowed.");
+      }
+
+      ```
     isPreview: false
     isDeprecated: false
     syntax:

diff --git a/docs/docs-ref-autogen/outlook/outlook/office.mailboxenums.openlocation.yml b/docs/docs-ref-autogen/outlook/outlook/office.mailboxenums.openlocation.yml
@@ -13,6 +13,26 @@ remarks: >-
   **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 [Outlook JavaScript APIs supported in Outlook on mobile
   devices](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis)<!-- -->.
+
+
+  #### Examples
+
+
+  ```TypeScript
+
+  // Checks if the add-in can access data from the device's photo library.
+
+  const isOpenFromPhotoLibraryAllowed =
+  Office.context.mailbox.getIsOpenFromLocationAllowed(Office.MailboxEnums.OpenLocation.PhotoLibrary);
+
+  if (isOpenFromPhotoLibraryAllowed) {
+      console.log("Access to the photo library is allowed.");
+      // Do something.
+  } else {
+      console.log("Access to the photo library isn't allowed.");
+  }
+
+  ```
 isPreview: false
 isDeprecated: false
 fields:

diff --git a/docs/docs-ref-autogen/outlook/outlook/office.mailboxenums.savelocation.yml b/docs/docs-ref-autogen/outlook/outlook/office.mailboxenums.savelocation.yml
@@ -13,6 +13,26 @@ remarks: >-
   **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 [Outlook JavaScript APIs supported in Outlook on mobile
   devices](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis)<!-- -->.
+
+
+  #### Examples
+
+
+  ```TypeScript
+
+  // Checks if the add-in can save data to SharePoint.
+
+  const isSaveToSharePointAllowed =
+  Office.context.mailbox.getIsSaveToLocationAllowed(Office.MailboxEnums.SaveLocation.SharePoint);
+
+  if (isSaveToSharePointAllowed) {
+      console.log("Saving to SharePoint is allowed.");
+      // Do something.
+  } else {
+      console.log("Saving to SharePoint isn't allowed.");
+  }
+
+  ```
 isPreview: false
 isDeprecated: false
 fields:

diff --git a/docs/docs-ref-autogen/outlook_1_1/outlook/office.mailbox.yml b/docs/docs-ref-autogen/outlook_1_1/outlook/office.mailbox.yml
@@ -741,6 +741,20 @@ methods:
 
 
       - `MAMServiceNotAvailable`<!-- -->: The client is unable to fetch the mobile application management (MAM) policy.
+
+
+      #### Examples
+
+
+      ```TypeScript
+
+      // Checks if the mailbox is managed by Microsoft Intune.
+
+      const isIdentityManaged = Office.context.mailbox.getIsIdentityManaged();
+
+      console.log(`Intune-managed mailbox: ${isIdentityManaged}`);
+
+      ```
     isPreview: false
     isDeprecated: false
     syntax:
@@ -779,6 +793,26 @@ methods:
 
 
       - `MAMServiceNotAvailable`<!-- -->: The client is unable to fetch the MAM policy.
+
+
+      #### Examples
+
+
+      ```TypeScript
+
+      // Checks if the add-in can access data from the device's photo library.
+
+      const isOpenFromPhotoLibraryAllowed =
+      Office.context.mailbox.getIsOpenFromLocationAllowed(Office.MailboxEnums.OpenLocation.PhotoLibrary);
+
+      if (isOpenFromPhotoLibraryAllowed) {
+          console.log("Access to the photo library is allowed.");
+          // Do something.
+      } else {
+          console.log("Access to the photo library isn't allowed.");
+      }
+
+      ```
     isPreview: false
     isDeprecated: false
     syntax:
@@ -821,6 +855,26 @@ methods:
 
 
       - `MAMServiceNotAvailable`<!-- -->: The client is unable to fetch the MAM policy.
+
+
+      #### Examples
+
+
+      ```TypeScript
+
+      // Checks if the add-in can save data to SharePoint.
+
+      const isSaveToSharePointAllowed =
+      Office.context.mailbox.getIsSaveToLocationAllowed(Office.MailboxEnums.SaveLocation.SharePoint);
+
+      if (isSaveToSharePointAllowed) {
+          console.log("Saving to SharePoint is allowed.");
+          // Do something.
+      } else {
+          console.log("Saving to SharePoint isn't allowed.");
+      }
+
+      ```
     isPreview: false
     isDeprecated: false
     syntax:

diff --git a/docs/docs-ref-autogen/outlook_1_1/outlook/office.mailboxenums.openlocation.yml b/docs/docs-ref-autogen/outlook_1_1/outlook/office.mailboxenums.openlocation.yml
@@ -13,6 +13,26 @@ remarks: >-
   **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 [Outlook JavaScript APIs supported in Outlook on mobile
   devices](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis)<!-- -->.
+
+
+  #### Examples
+
+
+  ```TypeScript
+
+  // Checks if the add-in can access data from the device's photo library.
+
+  const isOpenFromPhotoLibraryAllowed =
+  Office.context.mailbox.getIsOpenFromLocationAllowed(Office.MailboxEnums.OpenLocation.PhotoLibrary);
+
+  if (isOpenFromPhotoLibraryAllowed) {
+      console.log("Access to the photo library is allowed.");
+      // Do something.
+  } else {
+      console.log("Access to the photo library isn't allowed.");
+  }
+
+  ```
 isPreview: false
 isDeprecated: false
 fields: