diff --git a/docs/code-snippets/outlook-snippets.yaml b/docs/code-snippets/outlook-snippets.yaml index 3e07b73c36..0f1ae33d46 100644 --- 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 index 9bcf29fe85..7014fe521d 100644 --- 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 index 2d5a9ad5f9..6b7bdf4759 100644 --- 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 index 446eb9d932..a19eb2623e 100644 --- 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 index a048d16946..eb50e05041 100644 --- 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 index 2d5a9ad5f9..6b7bdf4759 100644 --- 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 index 446eb9d932..a19eb2623e 100644 --- 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 index 9aab34f870..75817a7ebe 100644 --- 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 index ecc8a4a6ab..f8d87420bc 100644 --- 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 index eb499cff1d..bd4b6ad925 100644 --- 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 index ea57680320..eaf0070470 100644 --- 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 index ecc8a4a6ab..f8d87420bc 100644 --- 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: diff --git a/docs/docs-ref-autogen/outlook_1_1/outlook/office.mailboxenums.savelocation.yml b/docs/docs-ref-autogen/outlook_1_1/outlook/office.mailboxenums.savelocation.yml index eb499cff1d..bd4b6ad925 100644 --- a/docs/docs-ref-autogen/outlook_1_1/outlook/office.mailboxenums.savelocation.yml +++ b/docs/docs-ref-autogen/outlook_1_1/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_10/outlook/office.mailbox.yml b/docs/docs-ref-autogen/outlook_1_10/outlook/office.mailbox.yml index cf9f537a54..ca5d3f426c 100644 --- a/docs/docs-ref-autogen/outlook_1_10/outlook/office.mailbox.yml +++ b/docs/docs-ref-autogen/outlook_1_10/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_1_10/outlook/office.mailboxenums.openlocation.yml b/docs/docs-ref-autogen/outlook_1_10/outlook/office.mailboxenums.openlocation.yml index ecc8a4a6ab..f8d87420bc 100644 --- a/docs/docs-ref-autogen/outlook_1_10/outlook/office.mailboxenums.openlocation.yml +++ b/docs/docs-ref-autogen/outlook_1_10/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_1_10/outlook/office.mailboxenums.savelocation.yml b/docs/docs-ref-autogen/outlook_1_10/outlook/office.mailboxenums.savelocation.yml index eb499cff1d..bd4b6ad925 100644 --- a/docs/docs-ref-autogen/outlook_1_10/outlook/office.mailboxenums.savelocation.yml +++ b/docs/docs-ref-autogen/outlook_1_10/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_11/outlook/office.mailbox.yml b/docs/docs-ref-autogen/outlook_1_11/outlook/office.mailbox.yml index 814f516d5b..5e7b433a01 100644 --- a/docs/docs-ref-autogen/outlook_1_11/outlook/office.mailbox.yml +++ b/docs/docs-ref-autogen/outlook_1_11/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_1_11/outlook/office.mailboxenums.openlocation.yml b/docs/docs-ref-autogen/outlook_1_11/outlook/office.mailboxenums.openlocation.yml index ecc8a4a6ab..f8d87420bc 100644 --- a/docs/docs-ref-autogen/outlook_1_11/outlook/office.mailboxenums.openlocation.yml +++ b/docs/docs-ref-autogen/outlook_1_11/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_1_11/outlook/office.mailboxenums.savelocation.yml b/docs/docs-ref-autogen/outlook_1_11/outlook/office.mailboxenums.savelocation.yml index eb499cff1d..bd4b6ad925 100644 --- a/docs/docs-ref-autogen/outlook_1_11/outlook/office.mailboxenums.savelocation.yml +++ b/docs/docs-ref-autogen/outlook_1_11/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_12/outlook/office.mailbox.yml b/docs/docs-ref-autogen/outlook_1_12/outlook/office.mailbox.yml index c3010d8e6f..4534da8258 100644 --- a/docs/docs-ref-autogen/outlook_1_12/outlook/office.mailbox.yml +++ b/docs/docs-ref-autogen/outlook_1_12/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_1_12/outlook/office.mailboxenums.openlocation.yml b/docs/docs-ref-autogen/outlook_1_12/outlook/office.mailboxenums.openlocation.yml index ecc8a4a6ab..f8d87420bc 100644 --- a/docs/docs-ref-autogen/outlook_1_12/outlook/office.mailboxenums.openlocation.yml +++ b/docs/docs-ref-autogen/outlook_1_12/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_1_12/outlook/office.mailboxenums.savelocation.yml b/docs/docs-ref-autogen/outlook_1_12/outlook/office.mailboxenums.savelocation.yml index eb499cff1d..bd4b6ad925 100644 --- a/docs/docs-ref-autogen/outlook_1_12/outlook/office.mailboxenums.savelocation.yml +++ b/docs/docs-ref-autogen/outlook_1_12/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_13/outlook/office.mailbox.yml b/docs/docs-ref-autogen/outlook_1_13/outlook/office.mailbox.yml index 7b073a875a..fb522b064c 100644 --- a/docs/docs-ref-autogen/outlook_1_13/outlook/office.mailbox.yml +++ b/docs/docs-ref-autogen/outlook_1_13/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_1_13/outlook/office.mailboxenums.openlocation.yml b/docs/docs-ref-autogen/outlook_1_13/outlook/office.mailboxenums.openlocation.yml index ecc8a4a6ab..f8d87420bc 100644 --- a/docs/docs-ref-autogen/outlook_1_13/outlook/office.mailboxenums.openlocation.yml +++ b/docs/docs-ref-autogen/outlook_1_13/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_1_13/outlook/office.mailboxenums.savelocation.yml b/docs/docs-ref-autogen/outlook_1_13/outlook/office.mailboxenums.savelocation.yml index eb499cff1d..bd4b6ad925 100644 --- a/docs/docs-ref-autogen/outlook_1_13/outlook/office.mailboxenums.savelocation.yml +++ b/docs/docs-ref-autogen/outlook_1_13/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_14/outlook/office.mailbox.yml b/docs/docs-ref-autogen/outlook_1_14/outlook/office.mailbox.yml index b0a5ab6809..9103dfdf89 100644 --- a/docs/docs-ref-autogen/outlook_1_14/outlook/office.mailbox.yml +++ b/docs/docs-ref-autogen/outlook_1_14/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_1_14/outlook/office.mailboxenums.openlocation.yml b/docs/docs-ref-autogen/outlook_1_14/outlook/office.mailboxenums.openlocation.yml index ecc8a4a6ab..f8d87420bc 100644 --- a/docs/docs-ref-autogen/outlook_1_14/outlook/office.mailboxenums.openlocation.yml +++ b/docs/docs-ref-autogen/outlook_1_14/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_1_14/outlook/office.mailboxenums.savelocation.yml b/docs/docs-ref-autogen/outlook_1_14/outlook/office.mailboxenums.savelocation.yml index eb499cff1d..bd4b6ad925 100644 --- a/docs/docs-ref-autogen/outlook_1_14/outlook/office.mailboxenums.savelocation.yml +++ b/docs/docs-ref-autogen/outlook_1_14/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_2/outlook/office.mailbox.yml b/docs/docs-ref-autogen/outlook_1_2/outlook/office.mailbox.yml index ea57680320..eaf0070470 100644 --- a/docs/docs-ref-autogen/outlook_1_2/outlook/office.mailbox.yml +++ b/docs/docs-ref-autogen/outlook_1_2/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_2/outlook/office.mailboxenums.openlocation.yml b/docs/docs-ref-autogen/outlook_1_2/outlook/office.mailboxenums.openlocation.yml index ecc8a4a6ab..f8d87420bc 100644 --- a/docs/docs-ref-autogen/outlook_1_2/outlook/office.mailboxenums.openlocation.yml +++ b/docs/docs-ref-autogen/outlook_1_2/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_1_2/outlook/office.mailboxenums.savelocation.yml b/docs/docs-ref-autogen/outlook_1_2/outlook/office.mailboxenums.savelocation.yml index eb499cff1d..bd4b6ad925 100644 --- a/docs/docs-ref-autogen/outlook_1_2/outlook/office.mailboxenums.savelocation.yml +++ b/docs/docs-ref-autogen/outlook_1_2/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_3/outlook/office.mailbox.yml b/docs/docs-ref-autogen/outlook_1_3/outlook/office.mailbox.yml index 32d4ac93d8..d9ef616744 100644 --- a/docs/docs-ref-autogen/outlook_1_3/outlook/office.mailbox.yml +++ b/docs/docs-ref-autogen/outlook_1_3/outlook/office.mailbox.yml @@ -914,6 +914,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: @@ -952,6 +966,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: @@ -994,6 +1028,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_3/outlook/office.mailboxenums.openlocation.yml b/docs/docs-ref-autogen/outlook_1_3/outlook/office.mailboxenums.openlocation.yml index ecc8a4a6ab..f8d87420bc 100644 --- a/docs/docs-ref-autogen/outlook_1_3/outlook/office.mailboxenums.openlocation.yml +++ b/docs/docs-ref-autogen/outlook_1_3/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_1_3/outlook/office.mailboxenums.savelocation.yml b/docs/docs-ref-autogen/outlook_1_3/outlook/office.mailboxenums.savelocation.yml index eb499cff1d..bd4b6ad925 100644 --- a/docs/docs-ref-autogen/outlook_1_3/outlook/office.mailboxenums.savelocation.yml +++ b/docs/docs-ref-autogen/outlook_1_3/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_4/outlook/office.mailbox.yml b/docs/docs-ref-autogen/outlook_1_4/outlook/office.mailbox.yml index 32d4ac93d8..d9ef616744 100644 --- a/docs/docs-ref-autogen/outlook_1_4/outlook/office.mailbox.yml +++ b/docs/docs-ref-autogen/outlook_1_4/outlook/office.mailbox.yml @@ -914,6 +914,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: @@ -952,6 +966,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: @@ -994,6 +1028,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_4/outlook/office.mailboxenums.openlocation.yml b/docs/docs-ref-autogen/outlook_1_4/outlook/office.mailboxenums.openlocation.yml index ecc8a4a6ab..f8d87420bc 100644 --- a/docs/docs-ref-autogen/outlook_1_4/outlook/office.mailboxenums.openlocation.yml +++ b/docs/docs-ref-autogen/outlook_1_4/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_1_4/outlook/office.mailboxenums.savelocation.yml b/docs/docs-ref-autogen/outlook_1_4/outlook/office.mailboxenums.savelocation.yml index eb499cff1d..bd4b6ad925 100644 --- a/docs/docs-ref-autogen/outlook_1_4/outlook/office.mailboxenums.savelocation.yml +++ b/docs/docs-ref-autogen/outlook_1_4/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_5/outlook/office.mailbox.yml b/docs/docs-ref-autogen/outlook_1_5/outlook/office.mailbox.yml index b09d41bf18..0a10ecfeaa 100644 --- a/docs/docs-ref-autogen/outlook_1_5/outlook/office.mailbox.yml +++ b/docs/docs-ref-autogen/outlook_1_5/outlook/office.mailbox.yml @@ -1286,6 +1286,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: @@ -1324,6 +1338,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: @@ -1366,6 +1400,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_5/outlook/office.mailboxenums.openlocation.yml b/docs/docs-ref-autogen/outlook_1_5/outlook/office.mailboxenums.openlocation.yml index ecc8a4a6ab..f8d87420bc 100644 --- a/docs/docs-ref-autogen/outlook_1_5/outlook/office.mailboxenums.openlocation.yml +++ b/docs/docs-ref-autogen/outlook_1_5/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_1_5/outlook/office.mailboxenums.savelocation.yml b/docs/docs-ref-autogen/outlook_1_5/outlook/office.mailboxenums.savelocation.yml index eb499cff1d..bd4b6ad925 100644 --- a/docs/docs-ref-autogen/outlook_1_5/outlook/office.mailboxenums.savelocation.yml +++ b/docs/docs-ref-autogen/outlook_1_5/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_6/outlook/office.mailbox.yml b/docs/docs-ref-autogen/outlook_1_6/outlook/office.mailbox.yml index f28434ef07..cbc0a3c489 100644 --- a/docs/docs-ref-autogen/outlook_1_6/outlook/office.mailbox.yml +++ b/docs/docs-ref-autogen/outlook_1_6/outlook/office.mailbox.yml @@ -1400,6 +1400,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: @@ -1438,6 +1452,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: @@ -1480,6 +1514,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_6/outlook/office.mailboxenums.openlocation.yml b/docs/docs-ref-autogen/outlook_1_6/outlook/office.mailboxenums.openlocation.yml index ecc8a4a6ab..f8d87420bc 100644 --- a/docs/docs-ref-autogen/outlook_1_6/outlook/office.mailboxenums.openlocation.yml +++ b/docs/docs-ref-autogen/outlook_1_6/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_1_6/outlook/office.mailboxenums.savelocation.yml b/docs/docs-ref-autogen/outlook_1_6/outlook/office.mailboxenums.savelocation.yml index eb499cff1d..bd4b6ad925 100644 --- a/docs/docs-ref-autogen/outlook_1_6/outlook/office.mailboxenums.savelocation.yml +++ b/docs/docs-ref-autogen/outlook_1_6/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_7/outlook/office.mailbox.yml b/docs/docs-ref-autogen/outlook_1_7/outlook/office.mailbox.yml index 128fa83a26..ed18261a4b 100644 --- a/docs/docs-ref-autogen/outlook_1_7/outlook/office.mailbox.yml +++ b/docs/docs-ref-autogen/outlook_1_7/outlook/office.mailbox.yml @@ -1400,6 +1400,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: @@ -1438,6 +1452,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: @@ -1480,6 +1514,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_7/outlook/office.mailboxenums.openlocation.yml b/docs/docs-ref-autogen/outlook_1_7/outlook/office.mailboxenums.openlocation.yml index ecc8a4a6ab..f8d87420bc 100644 --- a/docs/docs-ref-autogen/outlook_1_7/outlook/office.mailboxenums.openlocation.yml +++ b/docs/docs-ref-autogen/outlook_1_7/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_1_7/outlook/office.mailboxenums.savelocation.yml b/docs/docs-ref-autogen/outlook_1_7/outlook/office.mailboxenums.savelocation.yml index eb499cff1d..bd4b6ad925 100644 --- a/docs/docs-ref-autogen/outlook_1_7/outlook/office.mailboxenums.savelocation.yml +++ b/docs/docs-ref-autogen/outlook_1_7/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_8/outlook/office.mailbox.yml b/docs/docs-ref-autogen/outlook_1_8/outlook/office.mailbox.yml index 85aaad309c..3c20844dfc 100644 --- a/docs/docs-ref-autogen/outlook_1_8/outlook/office.mailbox.yml +++ b/docs/docs-ref-autogen/outlook_1_8/outlook/office.mailbox.yml @@ -1484,6 +1484,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: @@ -1522,6 +1536,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: @@ -1564,6 +1598,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_8/outlook/office.mailboxenums.openlocation.yml b/docs/docs-ref-autogen/outlook_1_8/outlook/office.mailboxenums.openlocation.yml index ecc8a4a6ab..f8d87420bc 100644 --- a/docs/docs-ref-autogen/outlook_1_8/outlook/office.mailboxenums.openlocation.yml +++ b/docs/docs-ref-autogen/outlook_1_8/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_1_8/outlook/office.mailboxenums.savelocation.yml b/docs/docs-ref-autogen/outlook_1_8/outlook/office.mailboxenums.savelocation.yml index eb499cff1d..bd4b6ad925 100644 --- a/docs/docs-ref-autogen/outlook_1_8/outlook/office.mailboxenums.savelocation.yml +++ b/docs/docs-ref-autogen/outlook_1_8/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_9/outlook/office.mailbox.yml b/docs/docs-ref-autogen/outlook_1_9/outlook/office.mailbox.yml index b36604f69b..904cfd4308 100644 --- a/docs/docs-ref-autogen/outlook_1_9/outlook/office.mailbox.yml +++ b/docs/docs-ref-autogen/outlook_1_9/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_1_9/outlook/office.mailboxenums.openlocation.yml b/docs/docs-ref-autogen/outlook_1_9/outlook/office.mailboxenums.openlocation.yml index ecc8a4a6ab..f8d87420bc 100644 --- a/docs/docs-ref-autogen/outlook_1_9/outlook/office.mailboxenums.openlocation.yml +++ b/docs/docs-ref-autogen/outlook_1_9/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_1_9/outlook/office.mailboxenums.savelocation.yml b/docs/docs-ref-autogen/outlook_1_9/outlook/office.mailboxenums.savelocation.yml index eb499cff1d..bd4b6ad925 100644 --- a/docs/docs-ref-autogen/outlook_1_9/outlook/office.mailboxenums.savelocation.yml +++ b/docs/docs-ref-autogen/outlook_1_9/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/powerpoint/powerpoint/powerpoint.shapetype.yml b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.shapetype.yml index dcc27d61b3..0b83e827e9 100644 --- a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.shapetype.yml +++ b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.shapetype.yml @@ -41,52 +41,42 @@ fields: - name: callout uid: 'powerpoint!PowerPoint.ShapeType.callout:member' package: powerpoint! - summary: >- + summary: |- The shape is a callout. - - * \[ [API set: PowerPointApi BETA (PREVIEW - ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets) \] + * \[ [API set: PowerPointApi 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets) \] value: '"Callout"' - name: chart uid: 'powerpoint!PowerPoint.ShapeType.chart:member' package: powerpoint! - summary: >- + summary: |- The shape is a chart. - - * \[ [API set: PowerPointApi BETA (PREVIEW - ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets) \] + * \[ [API set: PowerPointApi 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets) \] value: '"Chart"' - name: contentApp uid: 'powerpoint!PowerPoint.ShapeType.contentApp:member' package: powerpoint! - summary: >- + summary: |- The shape is a content Office Add-in. - - * \[ [API set: PowerPointApi BETA (PREVIEW - ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets) \] + * \[ [API set: PowerPointApi 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets) \] value: '"ContentApp"' - name: diagram uid: 'powerpoint!PowerPoint.ShapeType.diagram:member' package: powerpoint! - summary: >- + summary: |- The shape is a diagram. - - * \[ [API set: PowerPointApi BETA (PREVIEW - ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets) \] + * \[ [API set: PowerPointApi 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets) \] value: '"Diagram"' - name: freeform uid: 'powerpoint!PowerPoint.ShapeType.freeform:member' package: powerpoint! - summary: >- + summary: |- The shape is a freeform object. - - * \[ [API set: PowerPointApi BETA (PREVIEW - ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets) \] + * \[ [API set: PowerPointApi 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets) \] value: '"Freeform"' - name: geometricShape uid: 'powerpoint!PowerPoint.ShapeType.geometricShape:member' @@ -99,12 +89,10 @@ fields: - name: graphic uid: 'powerpoint!PowerPoint.ShapeType.graphic:member' package: powerpoint! - summary: >- + summary: |- The shape is a graphic. - - * \[ [API set: PowerPointApi BETA (PREVIEW - ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets) \] + * \[ [API set: PowerPointApi 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets) \] value: '"Graphic"' - name: group uid: 'powerpoint!PowerPoint.ShapeType.group:member' @@ -125,12 +113,10 @@ fields: - name: ink uid: 'powerpoint!PowerPoint.ShapeType.ink:member' package: powerpoint! - summary: >- + summary: |- The shape is an ink object. - - * \[ [API set: PowerPointApi BETA (PREVIEW - ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets) \] + * \[ [API set: PowerPointApi 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets) \] value: '"Ink"' - name: line uid: 'powerpoint!PowerPoint.ShapeType.line:member' @@ -143,72 +129,58 @@ fields: - name: media uid: 'powerpoint!PowerPoint.ShapeType.media:member' package: powerpoint! - summary: >- + summary: |- The shape is a media object. - - * \[ [API set: PowerPointApi BETA (PREVIEW - ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets) \] + * \[ [API set: PowerPointApi 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets) \] value: '"Media"' - name: model3D uid: 'powerpoint!PowerPoint.ShapeType.model3D:member' package: powerpoint! - summary: >- + summary: |- The shape is a 3D model. - - * \[ [API set: PowerPointApi BETA (PREVIEW - ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets) \] + * \[ [API set: PowerPointApi 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets) \] value: '"Model3D"' - name: ole uid: 'powerpoint!PowerPoint.ShapeType.ole:member' package: powerpoint! - summary: >- + summary: |- The shape is an OLE (Object Linking and Embedding) object. - - * \[ [API set: PowerPointApi BETA (PREVIEW - ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets) \] + * \[ [API set: PowerPointApi 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets) \] value: '"Ole"' - name: placeholder uid: 'powerpoint!PowerPoint.ShapeType.placeholder:member' package: powerpoint! - summary: >- + summary: |- The shape is a placeholder. - - * \[ [API set: PowerPointApi BETA (PREVIEW - ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets) \] + * \[ [API set: PowerPointApi 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets) \] value: '"Placeholder"' - name: smartArt uid: 'powerpoint!PowerPoint.ShapeType.smartArt:member' package: powerpoint! - summary: >- + summary: |- The shape is a SmartArt graphic. - - * \[ [API set: PowerPointApi BETA (PREVIEW - ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets) \] + * \[ [API set: PowerPointApi 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets) \] value: '"SmartArt"' - name: table uid: 'powerpoint!PowerPoint.ShapeType.table:member' package: powerpoint! - summary: >- + summary: |- The shape is a table. - - * \[ [API set: PowerPointApi BETA (PREVIEW - ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets) \] + * \[ [API set: PowerPointApi 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets) \] value: '"Table"' - name: textBox uid: 'powerpoint!PowerPoint.ShapeType.textBox:member' package: powerpoint! - summary: >- + summary: |- The shape is a text box. - - * \[ [API set: PowerPointApi BETA (PREVIEW - ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets) \] + * \[ [API set: PowerPointApi 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets) \] value: '"TextBox"' - name: unsupported uid: 'powerpoint!PowerPoint.ShapeType.unsupported:member' diff --git a/docs/docs-ref-autogen/powerpoint_1_4/powerpoint/powerpoint.shapetype.yml b/docs/docs-ref-autogen/powerpoint_1_4/powerpoint/powerpoint.shapetype.yml index 69d0858dc6..0b83e827e9 100644 --- a/docs/docs-ref-autogen/powerpoint_1_4/powerpoint/powerpoint.shapetype.yml +++ b/docs/docs-ref-autogen/powerpoint_1_4/powerpoint/powerpoint.shapetype.yml @@ -38,6 +38,46 @@ remarks: >- isPreview: false isDeprecated: false fields: + - name: callout + uid: 'powerpoint!PowerPoint.ShapeType.callout:member' + package: powerpoint! + summary: |- + The shape is a callout. + + * \[ [API set: PowerPointApi 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets) \] + value: '"Callout"' + - name: chart + uid: 'powerpoint!PowerPoint.ShapeType.chart:member' + package: powerpoint! + summary: |- + The shape is a chart. + + * \[ [API set: PowerPointApi 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets) \] + value: '"Chart"' + - name: contentApp + uid: 'powerpoint!PowerPoint.ShapeType.contentApp:member' + package: powerpoint! + summary: |- + The shape is a content Office Add-in. + + * \[ [API set: PowerPointApi 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets) \] + value: '"ContentApp"' + - name: diagram + uid: 'powerpoint!PowerPoint.ShapeType.diagram:member' + package: powerpoint! + summary: |- + The shape is a diagram. + + * \[ [API set: PowerPointApi 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets) \] + value: '"Diagram"' + - name: freeform + uid: 'powerpoint!PowerPoint.ShapeType.freeform:member' + package: powerpoint! + summary: |- + The shape is a freeform object. + + * \[ [API set: PowerPointApi 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets) \] + value: '"Freeform"' - name: geometricShape uid: 'powerpoint!PowerPoint.ShapeType.geometricShape:member' package: powerpoint! @@ -46,6 +86,14 @@ fields: * \[ [API set: PowerPointApi 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets) \] value: '"GeometricShape"' + - name: graphic + uid: 'powerpoint!PowerPoint.ShapeType.graphic:member' + package: powerpoint! + summary: |- + The shape is a graphic. + + * \[ [API set: PowerPointApi 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets) \] + value: '"Graphic"' - name: group uid: 'powerpoint!PowerPoint.ShapeType.group:member' package: powerpoint! @@ -62,6 +110,14 @@ fields: * \[ [API set: PowerPointApi 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets) \] value: '"Image"' + - name: ink + uid: 'powerpoint!PowerPoint.ShapeType.ink:member' + package: powerpoint! + summary: |- + The shape is an ink object. + + * \[ [API set: PowerPointApi 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets) \] + value: '"Ink"' - name: line uid: 'powerpoint!PowerPoint.ShapeType.line:member' package: powerpoint! @@ -70,6 +126,62 @@ fields: * \[ [API set: PowerPointApi 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets) \] value: '"Line"' + - name: media + uid: 'powerpoint!PowerPoint.ShapeType.media:member' + package: powerpoint! + summary: |- + The shape is a media object. + + * \[ [API set: PowerPointApi 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets) \] + value: '"Media"' + - name: model3D + uid: 'powerpoint!PowerPoint.ShapeType.model3D:member' + package: powerpoint! + summary: |- + The shape is a 3D model. + + * \[ [API set: PowerPointApi 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets) \] + value: '"Model3D"' + - name: ole + uid: 'powerpoint!PowerPoint.ShapeType.ole:member' + package: powerpoint! + summary: |- + The shape is an OLE (Object Linking and Embedding) object. + + * \[ [API set: PowerPointApi 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets) \] + value: '"Ole"' + - name: placeholder + uid: 'powerpoint!PowerPoint.ShapeType.placeholder:member' + package: powerpoint! + summary: |- + The shape is a placeholder. + + * \[ [API set: PowerPointApi 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets) \] + value: '"Placeholder"' + - name: smartArt + uid: 'powerpoint!PowerPoint.ShapeType.smartArt:member' + package: powerpoint! + summary: |- + The shape is a SmartArt graphic. + + * \[ [API set: PowerPointApi 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets) \] + value: '"SmartArt"' + - name: table + uid: 'powerpoint!PowerPoint.ShapeType.table:member' + package: powerpoint! + summary: |- + The shape is a table. + + * \[ [API set: PowerPointApi 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets) \] + value: '"Table"' + - name: textBox + uid: 'powerpoint!PowerPoint.ShapeType.textBox:member' + package: powerpoint! + summary: |- + The shape is a text box. + + * \[ [API set: PowerPointApi 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets) \] + value: '"TextBox"' - name: unsupported uid: 'powerpoint!PowerPoint.ShapeType.unsupported:member' package: powerpoint! diff --git a/docs/docs-ref-autogen/powerpoint_1_5/powerpoint/powerpoint.shapetype.yml b/docs/docs-ref-autogen/powerpoint_1_5/powerpoint/powerpoint.shapetype.yml index 69d0858dc6..0b83e827e9 100644 --- a/docs/docs-ref-autogen/powerpoint_1_5/powerpoint/powerpoint.shapetype.yml +++ b/docs/docs-ref-autogen/powerpoint_1_5/powerpoint/powerpoint.shapetype.yml @@ -38,6 +38,46 @@ remarks: >- isPreview: false isDeprecated: false fields: + - name: callout + uid: 'powerpoint!PowerPoint.ShapeType.callout:member' + package: powerpoint! + summary: |- + The shape is a callout. + + * \[ [API set: PowerPointApi 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets) \] + value: '"Callout"' + - name: chart + uid: 'powerpoint!PowerPoint.ShapeType.chart:member' + package: powerpoint! + summary: |- + The shape is a chart. + + * \[ [API set: PowerPointApi 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets) \] + value: '"Chart"' + - name: contentApp + uid: 'powerpoint!PowerPoint.ShapeType.contentApp:member' + package: powerpoint! + summary: |- + The shape is a content Office Add-in. + + * \[ [API set: PowerPointApi 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets) \] + value: '"ContentApp"' + - name: diagram + uid: 'powerpoint!PowerPoint.ShapeType.diagram:member' + package: powerpoint! + summary: |- + The shape is a diagram. + + * \[ [API set: PowerPointApi 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets) \] + value: '"Diagram"' + - name: freeform + uid: 'powerpoint!PowerPoint.ShapeType.freeform:member' + package: powerpoint! + summary: |- + The shape is a freeform object. + + * \[ [API set: PowerPointApi 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets) \] + value: '"Freeform"' - name: geometricShape uid: 'powerpoint!PowerPoint.ShapeType.geometricShape:member' package: powerpoint! @@ -46,6 +86,14 @@ fields: * \[ [API set: PowerPointApi 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets) \] value: '"GeometricShape"' + - name: graphic + uid: 'powerpoint!PowerPoint.ShapeType.graphic:member' + package: powerpoint! + summary: |- + The shape is a graphic. + + * \[ [API set: PowerPointApi 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets) \] + value: '"Graphic"' - name: group uid: 'powerpoint!PowerPoint.ShapeType.group:member' package: powerpoint! @@ -62,6 +110,14 @@ fields: * \[ [API set: PowerPointApi 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets) \] value: '"Image"' + - name: ink + uid: 'powerpoint!PowerPoint.ShapeType.ink:member' + package: powerpoint! + summary: |- + The shape is an ink object. + + * \[ [API set: PowerPointApi 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets) \] + value: '"Ink"' - name: line uid: 'powerpoint!PowerPoint.ShapeType.line:member' package: powerpoint! @@ -70,6 +126,62 @@ fields: * \[ [API set: PowerPointApi 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets) \] value: '"Line"' + - name: media + uid: 'powerpoint!PowerPoint.ShapeType.media:member' + package: powerpoint! + summary: |- + The shape is a media object. + + * \[ [API set: PowerPointApi 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets) \] + value: '"Media"' + - name: model3D + uid: 'powerpoint!PowerPoint.ShapeType.model3D:member' + package: powerpoint! + summary: |- + The shape is a 3D model. + + * \[ [API set: PowerPointApi 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets) \] + value: '"Model3D"' + - name: ole + uid: 'powerpoint!PowerPoint.ShapeType.ole:member' + package: powerpoint! + summary: |- + The shape is an OLE (Object Linking and Embedding) object. + + * \[ [API set: PowerPointApi 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets) \] + value: '"Ole"' + - name: placeholder + uid: 'powerpoint!PowerPoint.ShapeType.placeholder:member' + package: powerpoint! + summary: |- + The shape is a placeholder. + + * \[ [API set: PowerPointApi 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets) \] + value: '"Placeholder"' + - name: smartArt + uid: 'powerpoint!PowerPoint.ShapeType.smartArt:member' + package: powerpoint! + summary: |- + The shape is a SmartArt graphic. + + * \[ [API set: PowerPointApi 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets) \] + value: '"SmartArt"' + - name: table + uid: 'powerpoint!PowerPoint.ShapeType.table:member' + package: powerpoint! + summary: |- + The shape is a table. + + * \[ [API set: PowerPointApi 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets) \] + value: '"Table"' + - name: textBox + uid: 'powerpoint!PowerPoint.ShapeType.textBox:member' + package: powerpoint! + summary: |- + The shape is a text box. + + * \[ [API set: PowerPointApi 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets) \] + value: '"TextBox"' - name: unsupported uid: 'powerpoint!PowerPoint.ShapeType.unsupported:member' package: powerpoint! diff --git a/docs/docs-ref-autogen/powerpoint_1_6/powerpoint/powerpoint.shapetype.yml b/docs/docs-ref-autogen/powerpoint_1_6/powerpoint/powerpoint.shapetype.yml index 69d0858dc6..0b83e827e9 100644 --- a/docs/docs-ref-autogen/powerpoint_1_6/powerpoint/powerpoint.shapetype.yml +++ b/docs/docs-ref-autogen/powerpoint_1_6/powerpoint/powerpoint.shapetype.yml @@ -38,6 +38,46 @@ remarks: >- isPreview: false isDeprecated: false fields: + - name: callout + uid: 'powerpoint!PowerPoint.ShapeType.callout:member' + package: powerpoint! + summary: |- + The shape is a callout. + + * \[ [API set: PowerPointApi 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets) \] + value: '"Callout"' + - name: chart + uid: 'powerpoint!PowerPoint.ShapeType.chart:member' + package: powerpoint! + summary: |- + The shape is a chart. + + * \[ [API set: PowerPointApi 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets) \] + value: '"Chart"' + - name: contentApp + uid: 'powerpoint!PowerPoint.ShapeType.contentApp:member' + package: powerpoint! + summary: |- + The shape is a content Office Add-in. + + * \[ [API set: PowerPointApi 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets) \] + value: '"ContentApp"' + - name: diagram + uid: 'powerpoint!PowerPoint.ShapeType.diagram:member' + package: powerpoint! + summary: |- + The shape is a diagram. + + * \[ [API set: PowerPointApi 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets) \] + value: '"Diagram"' + - name: freeform + uid: 'powerpoint!PowerPoint.ShapeType.freeform:member' + package: powerpoint! + summary: |- + The shape is a freeform object. + + * \[ [API set: PowerPointApi 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets) \] + value: '"Freeform"' - name: geometricShape uid: 'powerpoint!PowerPoint.ShapeType.geometricShape:member' package: powerpoint! @@ -46,6 +86,14 @@ fields: * \[ [API set: PowerPointApi 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets) \] value: '"GeometricShape"' + - name: graphic + uid: 'powerpoint!PowerPoint.ShapeType.graphic:member' + package: powerpoint! + summary: |- + The shape is a graphic. + + * \[ [API set: PowerPointApi 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets) \] + value: '"Graphic"' - name: group uid: 'powerpoint!PowerPoint.ShapeType.group:member' package: powerpoint! @@ -62,6 +110,14 @@ fields: * \[ [API set: PowerPointApi 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets) \] value: '"Image"' + - name: ink + uid: 'powerpoint!PowerPoint.ShapeType.ink:member' + package: powerpoint! + summary: |- + The shape is an ink object. + + * \[ [API set: PowerPointApi 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets) \] + value: '"Ink"' - name: line uid: 'powerpoint!PowerPoint.ShapeType.line:member' package: powerpoint! @@ -70,6 +126,62 @@ fields: * \[ [API set: PowerPointApi 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets) \] value: '"Line"' + - name: media + uid: 'powerpoint!PowerPoint.ShapeType.media:member' + package: powerpoint! + summary: |- + The shape is a media object. + + * \[ [API set: PowerPointApi 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets) \] + value: '"Media"' + - name: model3D + uid: 'powerpoint!PowerPoint.ShapeType.model3D:member' + package: powerpoint! + summary: |- + The shape is a 3D model. + + * \[ [API set: PowerPointApi 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets) \] + value: '"Model3D"' + - name: ole + uid: 'powerpoint!PowerPoint.ShapeType.ole:member' + package: powerpoint! + summary: |- + The shape is an OLE (Object Linking and Embedding) object. + + * \[ [API set: PowerPointApi 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets) \] + value: '"Ole"' + - name: placeholder + uid: 'powerpoint!PowerPoint.ShapeType.placeholder:member' + package: powerpoint! + summary: |- + The shape is a placeholder. + + * \[ [API set: PowerPointApi 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets) \] + value: '"Placeholder"' + - name: smartArt + uid: 'powerpoint!PowerPoint.ShapeType.smartArt:member' + package: powerpoint! + summary: |- + The shape is a SmartArt graphic. + + * \[ [API set: PowerPointApi 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets) \] + value: '"SmartArt"' + - name: table + uid: 'powerpoint!PowerPoint.ShapeType.table:member' + package: powerpoint! + summary: |- + The shape is a table. + + * \[ [API set: PowerPointApi 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets) \] + value: '"Table"' + - name: textBox + uid: 'powerpoint!PowerPoint.ShapeType.textBox:member' + package: powerpoint! + summary: |- + The shape is a text box. + + * \[ [API set: PowerPointApi 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets) \] + value: '"TextBox"' - name: unsupported uid: 'powerpoint!PowerPoint.ShapeType.unsupported:member' package: powerpoint! diff --git a/docs/requirement-sets/common/nested-app-auth-requirement-sets.md b/docs/requirement-sets/common/nested-app-auth-requirement-sets.md index d51a78ebad..f2d71d6cda 100644 --- a/docs/requirement-sets/common/nested-app-auth-requirement-sets.md +++ b/docs/requirement-sets/common/nested-app-auth-requirement-sets.md @@ -1,7 +1,7 @@ --- title: Nested app auth requirement sets description: Nested app auth requirement set information for Office Add-ins. -ms.date: 10/31/2024 +ms.date: 11/22/2024 ms.topic: overview ms.localizationpriority: medium --- @@ -28,12 +28,12 @@ NAA supports both Microsoft Accounts and Microsoft Entra ID (work/school) identi | Application | Web | Windows | Mac | iOS/iPad | Android | |-------------|------------|------------------------------------------------------|------------|--------------------|----------------| | Excel | In preview | In preview | In preview | In preview on iPad | Not applicable | -| Outlook | GA | GA in Current Channel, Preview in all other channels | GA | GA (iOS) | GA | +| Outlook | GA | GA in Current Channel and Monthly Enterprise Channel, Preview in Semi-Annual Channels | GA | GA (iOS) | GA | | PowerPoint | In preview | In preview | In preview | In preview on iPad | Not applicable | | Word | In preview | In preview | In preview | In preview on iPad | Not applicable | > [!IMPORTANT] -> To use NAA on platforms that are still in preview, join the Microsoft 365 Insider Program (https://insider.microsoft365.com/join) and choose **Current Channel (Preview)**. Don't use NAA in production add-ins for any preview platforms. We invite you to try out NAA in test or development environments and welcome feedback on your experience through GitHub (see the **Feedback** section at the end of this page). +> To use NAA on platforms that are still in preview (Word, Excel, and PowerPoint), join the Microsoft 365 Insider Program (https://insider.microsoft365.com/join) and choose **Current Channel (Preview)**. Don't use NAA in production add-ins for any preview platforms. We invite you to try out NAA in test or development environments and welcome feedback on your experience through GitHub (see the **Feedback** section at the end of this page). ## Outlook and NestedAppAuth requirement set diff --git a/generate-docs/API Coverage Report.csv b/generate-docs/API Coverage Report.csv index 95eacb1930..f5d923af24 100644 --- a/generate-docs/API Coverage Report.csv +++ b/generate-docs/API Coverage Report.csv @@ -8988,9 +8988,9 @@ Office.Mailbox,"displayNewMessageFormAsync(parameters, options, callback)",Metho Office.Mailbox,"displayNewMessageFormAsync(parameters, callback)",Method,Fine,false Office.Mailbox,"getCallbackTokenAsync(options, callback)",Method,Fine,false Office.Mailbox,"getCallbackTokenAsync(callback, userContext)",Method,Fine,true -Office.Mailbox,"getIsIdentityManaged()",Method,Fine,false -Office.Mailbox,"getIsOpenFromLocationAllowed(openLocation)",Method,Fine,false -Office.Mailbox,"getIsSaveToLocationAllowed(saveLocation)",Method,Fine,false +Office.Mailbox,"getIsIdentityManaged()",Method,Fine,true +Office.Mailbox,"getIsOpenFromLocationAllowed(openLocation)",Method,Fine,true +Office.Mailbox,"getIsSaveToLocationAllowed(saveLocation)",Method,Fine,true Office.Mailbox,"getSelectedItemsAsync(options, callback)",Method,Poor,false Office.Mailbox,"getSelectedItemsAsync(callback)",Method,Poor,true Office.Mailbox,"getUserIdentityTokenAsync(callback, userContext)",Method,Fine,true @@ -9111,7 +9111,7 @@ Office.MailboxEnums.MoveSpamItemTo,"CustomFolder",EnumField,Fine,false Office.MailboxEnums.MoveSpamItemTo,"DeletedItemsFolder",EnumField,Fine,false Office.MailboxEnums.MoveSpamItemTo,"JunkFolder",EnumField,Fine,false Office.MailboxEnums.MoveSpamItemTo,"NoMove",EnumField,Fine,false -Office.MailboxEnums.OpenLocation,N/A,Enum,Good,false +Office.MailboxEnums.OpenLocation,N/A,Enum,Good,true Office.MailboxEnums.OpenLocation,"AccountDocument",EnumField,Fine,false Office.MailboxEnums.OpenLocation,"Camera",EnumField,Poor,false Office.MailboxEnums.OpenLocation,"Local",EnumField,Poor,false @@ -9282,7 +9282,7 @@ Office.MailboxEnums.RestVersion,N/A,Enum,Good,true Office.MailboxEnums.RestVersion,"v1_0",EnumField,Poor,false Office.MailboxEnums.RestVersion,"v2_0",EnumField,Poor,false Office.MailboxEnums.RestVersion,"Beta",EnumField,Poor,false -Office.MailboxEnums.SaveLocation,N/A,Enum,Good,false +Office.MailboxEnums.SaveLocation,N/A,Enum,Good,true Office.MailboxEnums.SaveLocation,"AccountDocument",EnumField,Fine,false Office.MailboxEnums.SaveLocation,"Box",EnumField,Poor,false Office.MailboxEnums.SaveLocation,"Dropbox",EnumField,Poor,false diff --git a/generate-docs/api-extractor-inputs-office-release/office.d.ts b/generate-docs/api-extractor-inputs-office-release/office.d.ts index 2b3a04c514..fde510dd29 100644 --- a/generate-docs/api-extractor-inputs-office-release/office.d.ts +++ b/generate-docs/api-extractor-inputs-office-release/office.d.ts @@ -3510,8 +3510,6 @@ export declare namespace Office { * * **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. - * * @deprecated Use `Office.auth.getAccessToken` instead. * * @remarks @@ -3535,8 +3533,6 @@ export declare namespace Office { * * **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. - * * @deprecated Use `Office.auth.getAccessToken` instead. * * @remarks @@ -3607,8 +3603,6 @@ export declare namespace Office { /** * 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. - * * @deprecated Use `allowSignInPrompt` instead. */ forceAddAccount?: boolean; @@ -3616,8 +3610,6 @@ export declare namespace Office { * 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. - * * @deprecated Use `allowConsentPrompt` instead. */ forceConsent?: boolean; @@ -7156,8 +7148,6 @@ export declare namespace Office { /** * 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. - * * @deprecated Use the string overload of `isSetSupported` instead. * @param name - The requirement set name (e.g., "ExcelApi"). * @param minVersionNumber - The minimum required version (e.g., 1.4). diff --git a/generate-docs/api-extractor-inputs-office/office.d.ts b/generate-docs/api-extractor-inputs-office/office.d.ts index ca7c49fe4f..6c5bcc3dcf 100644 --- a/generate-docs/api-extractor-inputs-office/office.d.ts +++ b/generate-docs/api-extractor-inputs-office/office.d.ts @@ -3514,8 +3514,6 @@ export declare namespace Office { * * **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. - * * @deprecated Use `Office.auth.getAccessToken` instead. * * @remarks @@ -3539,8 +3537,6 @@ export declare namespace Office { * * **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. - * * @deprecated Use `Office.auth.getAccessToken` instead. * * @remarks @@ -3624,8 +3620,6 @@ export declare namespace Office { /** * 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. - * * @deprecated Use `allowSignInPrompt` instead. */ forceAddAccount?: boolean; @@ -3633,8 +3627,6 @@ export declare namespace Office { * 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. - * * @deprecated Use `allowConsentPrompt` instead. */ forceConsent?: boolean; @@ -7208,8 +7200,6 @@ export declare namespace Office { /** * 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. - * * @deprecated Use the string overload of `isSetSupported` instead. * @param name - The requirement set name (e.g., "ExcelApi"). * @param minVersionNumber - The minimum required version (e.g., 1.4). diff --git a/generate-docs/api-extractor-inputs-powerpoint-release/PowerPoint_1_4/powerpoint.d.ts b/generate-docs/api-extractor-inputs-powerpoint-release/PowerPoint_1_4/powerpoint.d.ts index 4d478c0ac8..fc952ae497 100644 --- a/generate-docs/api-extractor-inputs-powerpoint-release/PowerPoint_1_4/powerpoint.d.ts +++ b/generate-docs/api-extractor-inputs-powerpoint-release/PowerPoint_1_4/powerpoint.d.ts @@ -2364,6 +2364,90 @@ export declare namespace PowerPoint { * [Api set: PowerPointApi 1.4] */ line = "Line", + /** + * The shape is a table. + * @remarks + * [Api set: PowerPointApi 1.4] + */ + table = "Table", + /** + * The shape is a callout. + * @remarks + * [Api set: PowerPointApi 1.4] + */ + callout = "Callout", + /** + * The shape is a chart. + * @remarks + * [Api set: PowerPointApi 1.4] + */ + chart = "Chart", + /** + * The shape is a content Office Add-in. + * @remarks + * [Api set: PowerPointApi 1.4] + */ + contentApp = "ContentApp", + /** + * The shape is a diagram. + * @remarks + * [Api set: PowerPointApi 1.4] + */ + diagram = "Diagram", + /** + * The shape is a freeform object. + * @remarks + * [Api set: PowerPointApi 1.4] + */ + freeform = "Freeform", + /** + * The shape is a graphic. + * @remarks + * [Api set: PowerPointApi 1.4] + */ + graphic = "Graphic", + /** + * The shape is an ink object. + * @remarks + * [Api set: PowerPointApi 1.4] + */ + ink = "Ink", + /** + * The shape is a media object. + * @remarks + * [Api set: PowerPointApi 1.4] + */ + media = "Media", + /** + * The shape is a 3D model. + * @remarks + * [Api set: PowerPointApi 1.4] + */ + model3D = "Model3D", + /** + * The shape is an OLE (Object Linking and Embedding) object. + * @remarks + * [Api set: PowerPointApi 1.4] + */ + ole = "Ole", + /** + * The shape is a placeholder. + * @remarks + * [Api set: PowerPointApi 1.4] + */ + placeholder = "Placeholder", + /** + * The shape is a SmartArt graphic. + * @remarks + * [Api set: PowerPointApi 1.4] + */ + smartArt = "SmartArt", + /** + * The shape is a text box. + * @remarks + * [Api set: PowerPointApi 1.4] + */ + textBox = "TextBox", } /** * Determines the type of automatic sizing allowed. diff --git a/generate-docs/api-extractor-inputs-powerpoint-release/PowerPoint_1_5/powerpoint.d.ts b/generate-docs/api-extractor-inputs-powerpoint-release/PowerPoint_1_5/powerpoint.d.ts index 71ff6983ef..18186707fd 100644 --- a/generate-docs/api-extractor-inputs-powerpoint-release/PowerPoint_1_5/powerpoint.d.ts +++ b/generate-docs/api-extractor-inputs-powerpoint-release/PowerPoint_1_5/powerpoint.d.ts @@ -2415,6 +2415,90 @@ export declare namespace PowerPoint { * [Api set: PowerPointApi 1.4] */ line = "Line", + /** + * The shape is a table. + * @remarks + * [Api set: PowerPointApi 1.4] + */ + table = "Table", + /** + * The shape is a callout. + * @remarks + * [Api set: PowerPointApi 1.4] + */ + callout = "Callout", + /** + * The shape is a chart. + * @remarks + * [Api set: PowerPointApi 1.4] + */ + chart = "Chart", + /** + * The shape is a content Office Add-in. + * @remarks + * [Api set: PowerPointApi 1.4] + */ + contentApp = "ContentApp", + /** + * The shape is a diagram. + * @remarks + * [Api set: PowerPointApi 1.4] + */ + diagram = "Diagram", + /** + * The shape is a freeform object. + * @remarks + * [Api set: PowerPointApi 1.4] + */ + freeform = "Freeform", + /** + * The shape is a graphic. + * @remarks + * [Api set: PowerPointApi 1.4] + */ + graphic = "Graphic", + /** + * The shape is an ink object. + * @remarks + * [Api set: PowerPointApi 1.4] + */ + ink = "Ink", + /** + * The shape is a media object. + * @remarks + * [Api set: PowerPointApi 1.4] + */ + media = "Media", + /** + * The shape is a 3D model. + * @remarks + * [Api set: PowerPointApi 1.4] + */ + model3D = "Model3D", + /** + * The shape is an OLE (Object Linking and Embedding) object. + * @remarks + * [Api set: PowerPointApi 1.4] + */ + ole = "Ole", + /** + * The shape is a placeholder. + * @remarks + * [Api set: PowerPointApi 1.4] + */ + placeholder = "Placeholder", + /** + * The shape is a SmartArt graphic. + * @remarks + * [Api set: PowerPointApi 1.4] + */ + smartArt = "SmartArt", + /** + * The shape is a text box. + * @remarks + * [Api set: PowerPointApi 1.4] + */ + textBox = "TextBox", } /** * Determines the type of automatic sizing allowed. diff --git a/generate-docs/api-extractor-inputs-powerpoint-release/PowerPoint_1_6/powerpoint.d.ts b/generate-docs/api-extractor-inputs-powerpoint-release/PowerPoint_1_6/powerpoint.d.ts index b53ecbfc19..84741572e4 100644 --- a/generate-docs/api-extractor-inputs-powerpoint-release/PowerPoint_1_6/powerpoint.d.ts +++ b/generate-docs/api-extractor-inputs-powerpoint-release/PowerPoint_1_6/powerpoint.d.ts @@ -2522,6 +2522,90 @@ export declare namespace PowerPoint { * [Api set: PowerPointApi 1.4] */ line = "Line", + /** + * The shape is a table. + * @remarks + * [Api set: PowerPointApi 1.4] + */ + table = "Table", + /** + * The shape is a callout. + * @remarks + * [Api set: PowerPointApi 1.4] + */ + callout = "Callout", + /** + * The shape is a chart. + * @remarks + * [Api set: PowerPointApi 1.4] + */ + chart = "Chart", + /** + * The shape is a content Office Add-in. + * @remarks + * [Api set: PowerPointApi 1.4] + */ + contentApp = "ContentApp", + /** + * The shape is a diagram. + * @remarks + * [Api set: PowerPointApi 1.4] + */ + diagram = "Diagram", + /** + * The shape is a freeform object. + * @remarks + * [Api set: PowerPointApi 1.4] + */ + freeform = "Freeform", + /** + * The shape is a graphic. + * @remarks + * [Api set: PowerPointApi 1.4] + */ + graphic = "Graphic", + /** + * The shape is an ink object. + * @remarks + * [Api set: PowerPointApi 1.4] + */ + ink = "Ink", + /** + * The shape is a media object. + * @remarks + * [Api set: PowerPointApi 1.4] + */ + media = "Media", + /** + * The shape is a 3D model. + * @remarks + * [Api set: PowerPointApi 1.4] + */ + model3D = "Model3D", + /** + * The shape is an OLE (Object Linking and Embedding) object. + * @remarks + * [Api set: PowerPointApi 1.4] + */ + ole = "Ole", + /** + * The shape is a placeholder. + * @remarks + * [Api set: PowerPointApi 1.4] + */ + placeholder = "Placeholder", + /** + * The shape is a SmartArt graphic. + * @remarks + * [Api set: PowerPointApi 1.4] + */ + smartArt = "SmartArt", + /** + * The shape is a text box. + * @remarks + * [Api set: PowerPointApi 1.4] + */ + textBox = "TextBox", } /** * Determines the type of automatic sizing allowed. diff --git a/generate-docs/api-extractor-inputs-powerpoint/powerpoint.d.ts b/generate-docs/api-extractor-inputs-powerpoint/powerpoint.d.ts index 142dcece06..c7fb5b90c8 100644 --- a/generate-docs/api-extractor-inputs-powerpoint/powerpoint.d.ts +++ b/generate-docs/api-extractor-inputs-powerpoint/powerpoint.d.ts @@ -2864,99 +2864,85 @@ export declare namespace PowerPoint { /** * The shape is a table. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.4] */ table = "Table", /** * The shape is a callout. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.4] */ callout = "Callout", /** * The shape is a chart. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.4] */ chart = "Chart", /** * The shape is a content Office Add-in. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.4] */ contentApp = "ContentApp", /** * The shape is a diagram. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.4] */ diagram = "Diagram", /** * The shape is a freeform object. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.4] */ freeform = "Freeform", /** * The shape is a graphic. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.4] */ graphic = "Graphic", /** * The shape is an ink object. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.4] */ ink = "Ink", /** * The shape is a media object. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.4] */ media = "Media", /** * The shape is a 3D model. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.4] */ model3D = "Model3D", /** * The shape is an OLE (Object Linking and Embedding) object. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.4] */ ole = "Ole", /** * The shape is a placeholder. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.4] */ placeholder = "Placeholder", /** * The shape is a SmartArt graphic. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.4] */ smartArt = "SmartArt", /** * The shape is a text box. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.4] */ textBox = "TextBox", } diff --git a/generate-docs/script-inputs/local-repo-snippets.yaml b/generate-docs/script-inputs/local-repo-snippets.yaml index 8c84e95f82..c6c2ca7653 100644 --- a/generate-docs/script-inputs/local-repo-snippets.yaml +++ b/generate-docs/script-inputs/local-repo-snippets.yaml @@ -8378,6 +8378,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) { @@ -8584,6 +8609,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/generate-docs/script-inputs/office.d.ts b/generate-docs/script-inputs/office.d.ts index 42208c8eb3..9d0de9db84 100644 --- a/generate-docs/script-inputs/office.d.ts +++ b/generate-docs/script-inputs/office.d.ts @@ -3515,8 +3515,6 @@ declare namespace Office { * * **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. - * * @deprecated Use `Office.auth.getAccessToken` instead. * * @remarks @@ -3540,8 +3538,6 @@ declare namespace Office { * * **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. - * * @deprecated Use `Office.auth.getAccessToken` instead. * * @remarks @@ -3612,8 +3608,6 @@ declare namespace Office { /** * 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. - * * @deprecated Use `allowSignInPrompt` instead. */ forceAddAccount?: boolean; @@ -3621,8 +3615,6 @@ declare namespace Office { * 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. - * * @deprecated Use `allowConsentPrompt` instead. */ forceConsent?: boolean; @@ -7161,8 +7153,6 @@ declare namespace Office { /** * 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. - * * @deprecated Use the string overload of `isSetSupported` instead. * @param name - The requirement set name (e.g., "ExcelApi"). * @param minVersionNumber - The minimum required version (e.g., 1.4). @@ -119921,6 +119911,90 @@ declare namespace PowerPoint { * [Api set: PowerPointApi 1.4] */ line = "Line", + /** + * The shape is a table. + * @remarks + * [Api set: PowerPointApi 1.4] + */ + table = "Table", + /** + * The shape is a callout. + * @remarks + * [Api set: PowerPointApi 1.4] + */ + callout = "Callout", + /** + * The shape is a chart. + * @remarks + * [Api set: PowerPointApi 1.4] + */ + chart = "Chart", + /** + * The shape is a content Office Add-in. + * @remarks + * [Api set: PowerPointApi 1.4] + */ + contentApp = "ContentApp", + /** + * The shape is a diagram. + * @remarks + * [Api set: PowerPointApi 1.4] + */ + diagram = "Diagram", + /** + * The shape is a freeform object. + * @remarks + * [Api set: PowerPointApi 1.4] + */ + freeform = "Freeform", + /** + * The shape is a graphic. + * @remarks + * [Api set: PowerPointApi 1.4] + */ + graphic = "Graphic", + /** + * The shape is an ink object. + * @remarks + * [Api set: PowerPointApi 1.4] + */ + ink = "Ink", + /** + * The shape is a media object. + * @remarks + * [Api set: PowerPointApi 1.4] + */ + media = "Media", + /** + * The shape is a 3D model. + * @remarks + * [Api set: PowerPointApi 1.4] + */ + model3D = "Model3D", + /** + * The shape is an OLE (Object Linking and Embedding) object. + * @remarks + * [Api set: PowerPointApi 1.4] + */ + ole = "Ole", + /** + * The shape is a placeholder. + * @remarks + * [Api set: PowerPointApi 1.4] + */ + placeholder = "Placeholder", + /** + * The shape is a SmartArt graphic. + * @remarks + * [Api set: PowerPointApi 1.4] + */ + smartArt = "SmartArt", + /** + * The shape is a text box. + * @remarks + * [Api set: PowerPointApi 1.4] + */ + textBox = "TextBox", } /** * Determines the type of automatic sizing allowed. diff --git a/generate-docs/script-inputs/office_preview.d.ts b/generate-docs/script-inputs/office_preview.d.ts index 4ba1c4e304..26765f3e56 100644 --- a/generate-docs/script-inputs/office_preview.d.ts +++ b/generate-docs/script-inputs/office_preview.d.ts @@ -3519,8 +3519,6 @@ declare namespace Office { * * **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. - * * @deprecated Use `Office.auth.getAccessToken` instead. * * @remarks @@ -3544,8 +3542,6 @@ declare namespace Office { * * **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. - * * @deprecated Use `Office.auth.getAccessToken` instead. * * @remarks @@ -3629,8 +3625,6 @@ declare namespace Office { /** * 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. - * * @deprecated Use `allowSignInPrompt` instead. */ forceAddAccount?: boolean; @@ -3638,8 +3632,6 @@ declare namespace Office { * 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. - * * @deprecated Use `allowConsentPrompt` instead. */ forceConsent?: boolean; @@ -7213,8 +7205,6 @@ declare namespace Office { /** * 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. - * * @deprecated Use the string overload of `isSetSupported` instead. * @param name - The requirement set name (e.g., "ExcelApi"). * @param minVersionNumber - The minimum required version (e.g., 1.4). @@ -128808,99 +128798,85 @@ declare namespace PowerPoint { /** * The shape is a table. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.4] */ table = "Table", /** * The shape is a callout. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.4] */ callout = "Callout", /** * The shape is a chart. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.4] */ chart = "Chart", /** * The shape is a content Office Add-in. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.4] */ contentApp = "ContentApp", /** * The shape is a diagram. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.4] */ diagram = "Diagram", /** * The shape is a freeform object. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.4] */ freeform = "Freeform", /** * The shape is a graphic. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.4] */ graphic = "Graphic", /** * The shape is an ink object. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.4] */ ink = "Ink", /** * The shape is a media object. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.4] */ media = "Media", /** * The shape is a 3D model. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.4] */ model3D = "Model3D", /** * The shape is an OLE (Object Linking and Embedding) object. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.4] */ ole = "Ole", /** * The shape is a placeholder. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.4] */ placeholder = "Placeholder", /** * The shape is a SmartArt graphic. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.4] */ smartArt = "SmartArt", /** * The shape is a text box. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.4] */ textBox = "TextBox", }