diff --git a/docs/docs-ref-autogen/outlook/outlook.yml b/docs/docs-ref-autogen/outlook/outlook.yml index 4a83a0549f..3526ca61c5 100644 --- a/docs/docs-ref-autogen/outlook/outlook.yml +++ b/docs/docs-ref-autogen/outlook/outlook.yml @@ -100,12 +100,14 @@ enums: - 'outlook!Office.MailboxEnums.LocationType:enum' - 'outlook!Office.MailboxEnums.Month:enum' - 'outlook!Office.MailboxEnums.MoveSpamItemTo:enum' + - 'outlook!Office.MailboxEnums.OpenLocation:enum' - 'outlook!Office.MailboxEnums.OWAView:enum' - 'outlook!Office.MailboxEnums.RecipientType:enum' - 'outlook!Office.MailboxEnums.RecurrenceTimeZone:enum' - 'outlook!Office.MailboxEnums.RecurrenceType:enum' - 'outlook!Office.MailboxEnums.ResponseType:enum' - 'outlook!Office.MailboxEnums.RestVersion:enum' + - 'outlook!Office.MailboxEnums.SaveLocation:enum' - 'outlook!Office.MailboxEnums.SendModeOverride:enum' - 'outlook!Office.MailboxEnums.SourceProperty:enum' - 'outlook!Office.MailboxEnums.WeekNumber:enum' diff --git a/docs/docs-ref-autogen/outlook/outlook/office.mailbox.yml b/docs/docs-ref-autogen/outlook/outlook/office.mailbox.yml index 7ccfeb0cd2..9aab34f870 100644 --- a/docs/docs-ref-autogen/outlook/outlook/office.mailbox.yml +++ b/docs/docs-ref-autogen/outlook/outlook/office.mailbox.yml @@ -2136,6 +2136,124 @@ methods: return: type: void description: '' + - name: getIsIdentityManaged() + uid: 'outlook!Office.Mailbox#getIsIdentityManaged:member(1)' + package: outlook! + fullName: getIsIdentityManaged() + summary: >- + Returns true if the current mailbox is managed by [Microsoft + Intune](https://learn.microsoft.com/mem/intune/fundamentals/what-is-intune). + remarks: >- + **[Minimum permission + level](https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions)**: **read item** + + + **[Applicable Outlook + mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)**: Compose, Read + + + **Important**: This method is only supported in Outlook on Android and on iOS starting in Version 4.2443.0. To + learn more about APIs supported in Outlook on mobile devices, see [Outlook JavaScript APIs supported in Outlook on + mobile devices](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis). + + + **Errors**: + + + - `MAMServiceNotAvailable`: The client is unable to fetch the mobile application management (MAM) policy. + isPreview: false + isDeprecated: false + syntax: + content: 'getIsIdentityManaged(): boolean;' + return: + type: boolean + description: True if the current mailbox is managed by Microsoft Intune. + - name: getIsOpenFromLocationAllowed(openLocation) + uid: 'outlook!Office.Mailbox#getIsOpenFromLocationAllowed:member(1)' + package: outlook! + fullName: getIsOpenFromLocationAllowed(openLocation) + summary: >- + Returns true if an organization's [Intune mobile application management (MAM) + policy](https://learn.microsoft.com/mem/intune/apps/app-management) allows an add-in to access data from the + specified location. + remarks: >- + **[Minimum permission + level](https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions)**: **read item** + + + **[Applicable Outlook + mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)**: Compose, Read + + + **Important**: This method is only supported in Outlook on Android and on iOS starting in Version 4.2443.0. To + learn more about APIs supported in Outlook on mobile devices, see [Outlook JavaScript APIs supported in Outlook on + mobile devices](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis). + + + **Errors**: + + + - `InvalidOpenLocationInput`: The value of the specified location is invalid. + + + - `MAMServiceNotAvailable`: The client is unable to fetch the MAM policy. + isPreview: false + isDeprecated: false + syntax: + content: 'getIsOpenFromLocationAllowed(openLocation: MailboxEnums.OpenLocation): boolean;' + parameters: + - id: openLocation + description: The location from which the add-in is attempting to access data. + type: '' + return: + type: boolean + description: True if an organization's Intune MAM policy allows an add-in to access data from the specified location. + - name: getIsSaveToLocationAllowed(saveLocation) + uid: 'outlook!Office.Mailbox#getIsSaveToLocationAllowed:member(1)' + package: outlook! + fullName: getIsSaveToLocationAllowed(saveLocation) + summary: >- + Returns true if an organization's [Intune mobile application management (MAM) + policy](https://learn.microsoft.com/mem/intune/apps/app-management) allows an add-in to save data to the specified + location. + remarks: >- + **[Minimum permission + level](https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions)**: **read item** + + + **[Applicable Outlook + mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)**: Compose, Read + + + **Important**: This method is only supported in Outlook on Android and on iOS starting in Version 4.2443.0. To + learn more about APIs supported in Outlook on mobile devices, see [Outlook JavaScript APIs supported in Outlook on + mobile devices](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis). + + + **Errors**: + + + - `InvalidSaveLocationInput`: The value of the specified location is invalid. + + + - `MAMServiceNotAvailable`: The client is unable to fetch the MAM policy. + isPreview: false + isDeprecated: false + syntax: + content: 'getIsSaveToLocationAllowed(saveLocation: MailboxEnums.SaveLocation): boolean;' + parameters: + - id: saveLocation + description: The location in which the add-in is attempting to save data. + type: '' + return: + type: boolean + description: True if an organization's Intune MAM policy allows an add-in to save data to the specified location. - name: 'getSelectedItemsAsync(options, callback)' uid: 'outlook!Office.Mailbox#getSelectedItemsAsync:member(1)' package: outlook! diff --git a/docs/docs-ref-autogen/outlook/outlook/office.mailboxenums.openlocation.yml b/docs/docs-ref-autogen/outlook/outlook/office.mailboxenums.openlocation.yml new file mode 100644 index 0000000000..ecc8a4a6ab --- /dev/null +++ b/docs/docs-ref-autogen/outlook/outlook/office.mailboxenums.openlocation.yml @@ -0,0 +1,51 @@ +### YamlMime:TSEnum +name: Office.MailboxEnums.OpenLocation +uid: 'outlook!Office.MailboxEnums.OpenLocation:enum' +package: outlook! +fullName: Office.MailboxEnums.OpenLocation +summary: Specifies the location from which an add-in wants to access data. +remarks: >- + **[Applicable Outlook + mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)**: + Compose, Read + + + **Important**: This enum is only supported in Outlook on Android and on iOS starting in Version 4.2443.0. To learn + more about APIs supported in Outlook on mobile devices, see [Outlook JavaScript APIs supported in Outlook on mobile + devices](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis). +isPreview: false +isDeprecated: false +fields: + - name: AccountDocument + uid: 'outlook!Office.MailboxEnums.OpenLocation.AccountDocument:member' + package: outlook! + summary: A location associated with an account within an add-in. + - name: Camera + uid: 'outlook!Office.MailboxEnums.OpenLocation.Camera:member' + package: outlook! + summary: The device's camera. + - name: Local + uid: 'outlook!Office.MailboxEnums.OpenLocation.Local:member' + package: outlook! + summary: Local storage on a device. + - name: OnedriveForBusiness + uid: 'outlook!Office.MailboxEnums.OpenLocation.OnedriveForBusiness:member' + package: outlook! + summary: |- + OneDrive for Business. + + **Important**: For OneDrive Personal, use OTHER. + - name: Other + uid: 'outlook!Office.MailboxEnums.OpenLocation.Other:member' + package: outlook! + summary: 'Other cloud storage providers, including OneDrive Personal.' + - name: PhotoLibrary + uid: 'outlook!Office.MailboxEnums.OpenLocation.PhotoLibrary:member' + package: outlook! + summary: The device's photo library. + - name: SharePoint + uid: 'outlook!Office.MailboxEnums.OpenLocation.SharePoint:member' + package: outlook! + summary: >- + SharePoint. Includes both SharePoint Online and SharePoint on-premises (if accessed with a Microsoft Entra ID + account). diff --git a/docs/docs-ref-autogen/outlook/outlook/office.mailboxenums.savelocation.yml b/docs/docs-ref-autogen/outlook/outlook/office.mailboxenums.savelocation.yml new file mode 100644 index 0000000000..eb499cff1d --- /dev/null +++ b/docs/docs-ref-autogen/outlook/outlook/office.mailboxenums.savelocation.yml @@ -0,0 +1,59 @@ +### YamlMime:TSEnum +name: Office.MailboxEnums.SaveLocation +uid: 'outlook!Office.MailboxEnums.SaveLocation:enum' +package: outlook! +fullName: Office.MailboxEnums.SaveLocation +summary: Specifies the location in which an add-in wants to save data. +remarks: >- + **[Applicable Outlook + mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)**: + Compose, Read + + + **Important**: This enum is only supported in Outlook on Android and on iOS starting in Version 4.2443.0. To learn + more about APIs supported in Outlook on mobile devices, see [Outlook JavaScript APIs supported in Outlook on mobile + devices](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis). +isPreview: false +isDeprecated: false +fields: + - name: AccountDocument + uid: 'outlook!Office.MailboxEnums.SaveLocation.AccountDocument:member' + package: outlook! + summary: A location associated with an account within an add-in. + - name: Box + uid: 'outlook!Office.MailboxEnums.SaveLocation.Box:member' + package: outlook! + summary: Box. + - name: Dropbox + uid: 'outlook!Office.MailboxEnums.SaveLocation.Dropbox:member' + package: outlook! + summary: Dropbox. + - name: GoogleDrive + uid: 'outlook!Office.MailboxEnums.SaveLocation.GoogleDrive:member' + package: outlook! + summary: Google Drive. + - name: Local + uid: 'outlook!Office.MailboxEnums.SaveLocation.Local:member' + package: outlook! + summary: Local storage on a device. + - name: OnedriveForBusiness + uid: 'outlook!Office.MailboxEnums.SaveLocation.OnedriveForBusiness:member' + package: outlook! + summary: |- + OneDrive for Business. + + **Important**: For OneDrive Personal, use OTHER. + - name: Other + uid: 'outlook!Office.MailboxEnums.SaveLocation.Other:member' + package: outlook! + summary: 'Other cloud storage providers, including OneDrive Personal.' + - name: PhotoLibrary + uid: 'outlook!Office.MailboxEnums.SaveLocation.PhotoLibrary:member' + package: outlook! + summary: The device's photo library. + - name: SharePoint + uid: 'outlook!Office.MailboxEnums.SaveLocation.SharePoint:member' + package: outlook! + summary: >- + SharePoint. Includes both SharePoint Online and SharePoint on-premises (if accessed with a Microsoft Entra ID + account). diff --git a/docs/docs-ref-autogen/outlook/toc.yml b/docs/docs-ref-autogen/outlook/toc.yml index db71dc804a..5f5c168390 100644 --- a/docs/docs-ref-autogen/outlook/toc.yml +++ b/docs/docs-ref-autogen/outlook/toc.yml @@ -47,6 +47,8 @@ items: uid: 'outlook!Office.MailboxEnums.Month:enum' - name: MoveSpamItemTo uid: 'outlook!Office.MailboxEnums.MoveSpamItemTo:enum' + - name: OpenLocation + uid: 'outlook!Office.MailboxEnums.OpenLocation:enum' - name: OWAView uid: 'outlook!Office.MailboxEnums.OWAView:enum' - name: RecipientType @@ -59,6 +61,8 @@ items: uid: 'outlook!Office.MailboxEnums.ResponseType:enum' - name: RestVersion uid: 'outlook!Office.MailboxEnums.RestVersion:enum' + - name: SaveLocation + uid: 'outlook!Office.MailboxEnums.SaveLocation:enum' - name: SendModeOverride uid: 'outlook!Office.MailboxEnums.SendModeOverride:enum' - name: SourceProperty diff --git a/docs/docs-ref-autogen/outlook_1_1/outlook.yml b/docs/docs-ref-autogen/outlook_1_1/outlook.yml index be2a199c99..cb839b8e6b 100644 --- a/docs/docs-ref-autogen/outlook_1_1/outlook.yml +++ b/docs/docs-ref-autogen/outlook_1_1/outlook.yml @@ -40,6 +40,8 @@ enums: - 'outlook!Office.MailboxEnums.AttachmentType:enum' - 'outlook!Office.MailboxEnums.EntityType:enum' - 'outlook!Office.MailboxEnums.ItemType:enum' + - 'outlook!Office.MailboxEnums.OpenLocation:enum' - 'outlook!Office.MailboxEnums.OWAView:enum' - 'outlook!Office.MailboxEnums.RecipientType:enum' - 'outlook!Office.MailboxEnums.ResponseType:enum' + - 'outlook!Office.MailboxEnums.SaveLocation:enum' 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 f63b4ff768..ea57680320 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 @@ -714,6 +714,124 @@ methods: return: type: void description: '' + - name: getIsIdentityManaged() + uid: 'outlook!Office.Mailbox#getIsIdentityManaged:member(1)' + package: outlook! + fullName: getIsIdentityManaged() + summary: >- + Returns true if the current mailbox is managed by [Microsoft + Intune](https://learn.microsoft.com/mem/intune/fundamentals/what-is-intune). + remarks: >- + **[Minimum permission + level](https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions)**: **read item** + + + **[Applicable Outlook + mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)**: Compose, Read + + + **Important**: This method is only supported in Outlook on Android and on iOS starting in Version 4.2443.0.To + learn more about APIs supported in Outlook on mobile devices, see [Outlook JavaScript APIs supported in Outlook on + mobile devices](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis). + + + **Errors**: + + + - `MAMServiceNotAvailable`: The client is unable to fetch the mobile application management (MAM) policy. + isPreview: false + isDeprecated: false + syntax: + content: 'getIsIdentityManaged(): boolean;' + return: + type: boolean + description: True if the current mailbox is managed by Microsoft Intune. + - name: getIsOpenFromLocationAllowed(openLocation) + uid: 'outlook!Office.Mailbox#getIsOpenFromLocationAllowed:member(1)' + package: outlook! + fullName: getIsOpenFromLocationAllowed(openLocation) + summary: >- + Returns true if an organization's [Intune mobile application management (MAM) + policy](https://learn.microsoft.com/mem/intune/apps/app-management) allows an add-in to access data from the + specified location. + remarks: >- + **[Minimum permission + level](https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions)**: **read item** + + + **[Applicable Outlook + mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)**: Compose, Read + + + **Important**: This method is only supported in Outlook on Android and on iOS starting in Version 4.2443.0. To + learn more about APIs supported in Outlook on mobile devices, see [Outlook JavaScript APIs supported in Outlook on + mobile devices](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis). + + + **Errors**: + + + - `InvalidOpenLocationInput`: The value of the specified location is invalid. + + + - `MAMServiceNotAvailable`: The client is unable to fetch the MAM policy. + isPreview: false + isDeprecated: false + syntax: + content: 'getIsOpenFromLocationAllowed(openLocation: MailboxEnums.OpenLocation): boolean;' + parameters: + - id: openLocation + description: The location from which the add-in is attempting to access data. + type: '' + return: + type: boolean + description: True if an organization's Intune MAM policy allows an add-in to access data from the specified location. + - name: getIsSaveToLocationAllowed(saveLocation) + uid: 'outlook!Office.Mailbox#getIsSaveToLocationAllowed:member(1)' + package: outlook! + fullName: getIsSaveToLocationAllowed(saveLocation) + summary: >- + Returns true if an organization's [Intune mobile application management (MAM) + policy](https://learn.microsoft.com/mem/intune/apps/app-management) allows an add-in to save data to the specified + location. + remarks: >- + **[Minimum permission + level](https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions)**: **read item** + + + **[Applicable Outlook + mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)**: Compose, Read + + + **Important**: This method is only supported in Outlook on Android and on iOS starting in Version 4.2443.0. To + learn more about APIs supported in Outlook on mobile devices, see [Outlook JavaScript APIs supported in Outlook on + mobile devices](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis). + + + **Errors**: + + + - `InvalidSaveLocationInput`: The value of the specified location is invalid. + + + - `MAMServiceNotAvailable`: The client is unable to fetch the MAM policy. + isPreview: false + isDeprecated: false + syntax: + content: 'getIsSaveToLocationAllowed(saveLocation: MailboxEnums.SaveLocation): boolean;' + parameters: + - id: saveLocation + description: The location in which the add-in is attempting to save data. + type: '' + return: + type: boolean + description: True if an organization's Intune MAM policy allows an add-in to save data to the specified location. - name: 'getUserIdentityTokenAsync(callback, userContext)' uid: 'outlook!Office.Mailbox#getUserIdentityTokenAsync:member(1)' package: outlook! 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 new file mode 100644 index 0000000000..ecc8a4a6ab --- /dev/null +++ b/docs/docs-ref-autogen/outlook_1_1/outlook/office.mailboxenums.openlocation.yml @@ -0,0 +1,51 @@ +### YamlMime:TSEnum +name: Office.MailboxEnums.OpenLocation +uid: 'outlook!Office.MailboxEnums.OpenLocation:enum' +package: outlook! +fullName: Office.MailboxEnums.OpenLocation +summary: Specifies the location from which an add-in wants to access data. +remarks: >- + **[Applicable Outlook + mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)**: + Compose, Read + + + **Important**: This enum is only supported in Outlook on Android and on iOS starting in Version 4.2443.0. To learn + more about APIs supported in Outlook on mobile devices, see [Outlook JavaScript APIs supported in Outlook on mobile + devices](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis). +isPreview: false +isDeprecated: false +fields: + - name: AccountDocument + uid: 'outlook!Office.MailboxEnums.OpenLocation.AccountDocument:member' + package: outlook! + summary: A location associated with an account within an add-in. + - name: Camera + uid: 'outlook!Office.MailboxEnums.OpenLocation.Camera:member' + package: outlook! + summary: The device's camera. + - name: Local + uid: 'outlook!Office.MailboxEnums.OpenLocation.Local:member' + package: outlook! + summary: Local storage on a device. + - name: OnedriveForBusiness + uid: 'outlook!Office.MailboxEnums.OpenLocation.OnedriveForBusiness:member' + package: outlook! + summary: |- + OneDrive for Business. + + **Important**: For OneDrive Personal, use OTHER. + - name: Other + uid: 'outlook!Office.MailboxEnums.OpenLocation.Other:member' + package: outlook! + summary: 'Other cloud storage providers, including OneDrive Personal.' + - name: PhotoLibrary + uid: 'outlook!Office.MailboxEnums.OpenLocation.PhotoLibrary:member' + package: outlook! + summary: The device's photo library. + - name: SharePoint + uid: 'outlook!Office.MailboxEnums.OpenLocation.SharePoint:member' + package: outlook! + summary: >- + SharePoint. Includes both SharePoint Online and SharePoint on-premises (if accessed with a Microsoft Entra ID + account). 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 new file mode 100644 index 0000000000..eb499cff1d --- /dev/null +++ b/docs/docs-ref-autogen/outlook_1_1/outlook/office.mailboxenums.savelocation.yml @@ -0,0 +1,59 @@ +### YamlMime:TSEnum +name: Office.MailboxEnums.SaveLocation +uid: 'outlook!Office.MailboxEnums.SaveLocation:enum' +package: outlook! +fullName: Office.MailboxEnums.SaveLocation +summary: Specifies the location in which an add-in wants to save data. +remarks: >- + **[Applicable Outlook + mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)**: + Compose, Read + + + **Important**: This enum is only supported in Outlook on Android and on iOS starting in Version 4.2443.0. To learn + more about APIs supported in Outlook on mobile devices, see [Outlook JavaScript APIs supported in Outlook on mobile + devices](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis). +isPreview: false +isDeprecated: false +fields: + - name: AccountDocument + uid: 'outlook!Office.MailboxEnums.SaveLocation.AccountDocument:member' + package: outlook! + summary: A location associated with an account within an add-in. + - name: Box + uid: 'outlook!Office.MailboxEnums.SaveLocation.Box:member' + package: outlook! + summary: Box. + - name: Dropbox + uid: 'outlook!Office.MailboxEnums.SaveLocation.Dropbox:member' + package: outlook! + summary: Dropbox. + - name: GoogleDrive + uid: 'outlook!Office.MailboxEnums.SaveLocation.GoogleDrive:member' + package: outlook! + summary: Google Drive. + - name: Local + uid: 'outlook!Office.MailboxEnums.SaveLocation.Local:member' + package: outlook! + summary: Local storage on a device. + - name: OnedriveForBusiness + uid: 'outlook!Office.MailboxEnums.SaveLocation.OnedriveForBusiness:member' + package: outlook! + summary: |- + OneDrive for Business. + + **Important**: For OneDrive Personal, use OTHER. + - name: Other + uid: 'outlook!Office.MailboxEnums.SaveLocation.Other:member' + package: outlook! + summary: 'Other cloud storage providers, including OneDrive Personal.' + - name: PhotoLibrary + uid: 'outlook!Office.MailboxEnums.SaveLocation.PhotoLibrary:member' + package: outlook! + summary: The device's photo library. + - name: SharePoint + uid: 'outlook!Office.MailboxEnums.SaveLocation.SharePoint:member' + package: outlook! + summary: >- + SharePoint. Includes both SharePoint Online and SharePoint on-premises (if accessed with a Microsoft Entra ID + account). diff --git a/docs/docs-ref-autogen/outlook_1_1/toc.yml b/docs/docs-ref-autogen/outlook_1_1/toc.yml index 00c8f728ea..fd07ebff88 100644 --- a/docs/docs-ref-autogen/outlook_1_1/toc.yml +++ b/docs/docs-ref-autogen/outlook_1_1/toc.yml @@ -19,12 +19,16 @@ items: uid: 'outlook!Office.MailboxEnums.EntityType:enum' - name: ItemType uid: 'outlook!Office.MailboxEnums.ItemType:enum' + - name: OpenLocation + uid: 'outlook!Office.MailboxEnums.OpenLocation:enum' - name: OWAView uid: 'outlook!Office.MailboxEnums.OWAView:enum' - name: RecipientType uid: 'outlook!Office.MailboxEnums.RecipientType:enum' - name: ResponseType uid: 'outlook!Office.MailboxEnums.ResponseType:enum' + - name: SaveLocation + uid: 'outlook!Office.MailboxEnums.SaveLocation:enum' - name: AppointmentCompose uid: 'outlook!Office.AppointmentCompose:interface' - name: AppointmentRead diff --git a/docs/docs-ref-autogen/outlook_1_10/outlook.yml b/docs/docs-ref-autogen/outlook_1_10/outlook.yml index 37144ee42c..654f9eb587 100644 --- a/docs/docs-ref-autogen/outlook_1_10/outlook.yml +++ b/docs/docs-ref-autogen/outlook_1_10/outlook.yml @@ -80,11 +80,13 @@ enums: - 'outlook!Office.MailboxEnums.ItemType:enum' - 'outlook!Office.MailboxEnums.LocationType:enum' - 'outlook!Office.MailboxEnums.Month:enum' + - 'outlook!Office.MailboxEnums.OpenLocation:enum' - 'outlook!Office.MailboxEnums.OWAView:enum' - 'outlook!Office.MailboxEnums.RecipientType:enum' - 'outlook!Office.MailboxEnums.RecurrenceTimeZone:enum' - 'outlook!Office.MailboxEnums.RecurrenceType:enum' - 'outlook!Office.MailboxEnums.ResponseType:enum' - 'outlook!Office.MailboxEnums.RestVersion:enum' + - 'outlook!Office.MailboxEnums.SaveLocation:enum' - 'outlook!Office.MailboxEnums.SourceProperty:enum' - 'outlook!Office.MailboxEnums.WeekNumber:enum' 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 14ac388a2b..cf9f537a54 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 @@ -2136,6 +2136,124 @@ methods: return: type: void description: '' + - name: getIsIdentityManaged() + uid: 'outlook!Office.Mailbox#getIsIdentityManaged:member(1)' + package: outlook! + fullName: getIsIdentityManaged() + summary: >- + Returns true if the current mailbox is managed by [Microsoft + Intune](https://learn.microsoft.com/mem/intune/fundamentals/what-is-intune). + remarks: >- + **[Minimum permission + level](https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions)**: **read item** + + + **[Applicable Outlook + mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)**: Compose, Read + + + **Important**: This method is only supported in Outlook on Android and on iOS starting in Version 4.2443.0.To + learn more about APIs supported in Outlook on mobile devices, see [Outlook JavaScript APIs supported in Outlook on + mobile devices](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis). + + + **Errors**: + + + - `MAMServiceNotAvailable`: The client is unable to fetch the mobile application management (MAM) policy. + isPreview: false + isDeprecated: false + syntax: + content: 'getIsIdentityManaged(): boolean;' + return: + type: boolean + description: True if the current mailbox is managed by Microsoft Intune. + - name: getIsOpenFromLocationAllowed(openLocation) + uid: 'outlook!Office.Mailbox#getIsOpenFromLocationAllowed:member(1)' + package: outlook! + fullName: getIsOpenFromLocationAllowed(openLocation) + summary: >- + Returns true if an organization's [Intune mobile application management (MAM) + policy](https://learn.microsoft.com/mem/intune/apps/app-management) allows an add-in to access data from the + specified location. + remarks: >- + **[Minimum permission + level](https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions)**: **read item** + + + **[Applicable Outlook + mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)**: Compose, Read + + + **Important**: This method is only supported in Outlook on Android and on iOS starting in Version 4.2443.0. To + learn more about APIs supported in Outlook on mobile devices, see [Outlook JavaScript APIs supported in Outlook on + mobile devices](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis). + + + **Errors**: + + + - `InvalidOpenLocationInput`: The value of the specified location is invalid. + + + - `MAMServiceNotAvailable`: The client is unable to fetch the MAM policy. + isPreview: false + isDeprecated: false + syntax: + content: 'getIsOpenFromLocationAllowed(openLocation: MailboxEnums.OpenLocation): boolean;' + parameters: + - id: openLocation + description: The location from which the add-in is attempting to access data. + type: '' + return: + type: boolean + description: True if an organization's Intune MAM policy allows an add-in to access data from the specified location. + - name: getIsSaveToLocationAllowed(saveLocation) + uid: 'outlook!Office.Mailbox#getIsSaveToLocationAllowed:member(1)' + package: outlook! + fullName: getIsSaveToLocationAllowed(saveLocation) + summary: >- + Returns true if an organization's [Intune mobile application management (MAM) + policy](https://learn.microsoft.com/mem/intune/apps/app-management) allows an add-in to save data to the specified + location. + remarks: >- + **[Minimum permission + level](https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions)**: **read item** + + + **[Applicable Outlook + mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)**: Compose, Read + + + **Important**: This method is only supported in Outlook on Android and on iOS starting in Version 4.2443.0. To + learn more about APIs supported in Outlook on mobile devices, see [Outlook JavaScript APIs supported in Outlook on + mobile devices](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis). + + + **Errors**: + + + - `InvalidSaveLocationInput`: The value of the specified location is invalid. + + + - `MAMServiceNotAvailable`: The client is unable to fetch the MAM policy. + isPreview: false + isDeprecated: false + syntax: + content: 'getIsSaveToLocationAllowed(saveLocation: MailboxEnums.SaveLocation): boolean;' + parameters: + - id: saveLocation + description: The location in which the add-in is attempting to save data. + type: '' + return: + type: boolean + description: True if an organization's Intune MAM policy allows an add-in to save data to the specified location. - name: 'getUserIdentityTokenAsync(callback, userContext)' uid: 'outlook!Office.Mailbox#getUserIdentityTokenAsync:member(1)' package: outlook! 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 new file mode 100644 index 0000000000..ecc8a4a6ab --- /dev/null +++ b/docs/docs-ref-autogen/outlook_1_10/outlook/office.mailboxenums.openlocation.yml @@ -0,0 +1,51 @@ +### YamlMime:TSEnum +name: Office.MailboxEnums.OpenLocation +uid: 'outlook!Office.MailboxEnums.OpenLocation:enum' +package: outlook! +fullName: Office.MailboxEnums.OpenLocation +summary: Specifies the location from which an add-in wants to access data. +remarks: >- + **[Applicable Outlook + mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)**: + Compose, Read + + + **Important**: This enum is only supported in Outlook on Android and on iOS starting in Version 4.2443.0. To learn + more about APIs supported in Outlook on mobile devices, see [Outlook JavaScript APIs supported in Outlook on mobile + devices](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis). +isPreview: false +isDeprecated: false +fields: + - name: AccountDocument + uid: 'outlook!Office.MailboxEnums.OpenLocation.AccountDocument:member' + package: outlook! + summary: A location associated with an account within an add-in. + - name: Camera + uid: 'outlook!Office.MailboxEnums.OpenLocation.Camera:member' + package: outlook! + summary: The device's camera. + - name: Local + uid: 'outlook!Office.MailboxEnums.OpenLocation.Local:member' + package: outlook! + summary: Local storage on a device. + - name: OnedriveForBusiness + uid: 'outlook!Office.MailboxEnums.OpenLocation.OnedriveForBusiness:member' + package: outlook! + summary: |- + OneDrive for Business. + + **Important**: For OneDrive Personal, use OTHER. + - name: Other + uid: 'outlook!Office.MailboxEnums.OpenLocation.Other:member' + package: outlook! + summary: 'Other cloud storage providers, including OneDrive Personal.' + - name: PhotoLibrary + uid: 'outlook!Office.MailboxEnums.OpenLocation.PhotoLibrary:member' + package: outlook! + summary: The device's photo library. + - name: SharePoint + uid: 'outlook!Office.MailboxEnums.OpenLocation.SharePoint:member' + package: outlook! + summary: >- + SharePoint. Includes both SharePoint Online and SharePoint on-premises (if accessed with a Microsoft Entra ID + account). 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 new file mode 100644 index 0000000000..eb499cff1d --- /dev/null +++ b/docs/docs-ref-autogen/outlook_1_10/outlook/office.mailboxenums.savelocation.yml @@ -0,0 +1,59 @@ +### YamlMime:TSEnum +name: Office.MailboxEnums.SaveLocation +uid: 'outlook!Office.MailboxEnums.SaveLocation:enum' +package: outlook! +fullName: Office.MailboxEnums.SaveLocation +summary: Specifies the location in which an add-in wants to save data. +remarks: >- + **[Applicable Outlook + mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)**: + Compose, Read + + + **Important**: This enum is only supported in Outlook on Android and on iOS starting in Version 4.2443.0. To learn + more about APIs supported in Outlook on mobile devices, see [Outlook JavaScript APIs supported in Outlook on mobile + devices](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis). +isPreview: false +isDeprecated: false +fields: + - name: AccountDocument + uid: 'outlook!Office.MailboxEnums.SaveLocation.AccountDocument:member' + package: outlook! + summary: A location associated with an account within an add-in. + - name: Box + uid: 'outlook!Office.MailboxEnums.SaveLocation.Box:member' + package: outlook! + summary: Box. + - name: Dropbox + uid: 'outlook!Office.MailboxEnums.SaveLocation.Dropbox:member' + package: outlook! + summary: Dropbox. + - name: GoogleDrive + uid: 'outlook!Office.MailboxEnums.SaveLocation.GoogleDrive:member' + package: outlook! + summary: Google Drive. + - name: Local + uid: 'outlook!Office.MailboxEnums.SaveLocation.Local:member' + package: outlook! + summary: Local storage on a device. + - name: OnedriveForBusiness + uid: 'outlook!Office.MailboxEnums.SaveLocation.OnedriveForBusiness:member' + package: outlook! + summary: |- + OneDrive for Business. + + **Important**: For OneDrive Personal, use OTHER. + - name: Other + uid: 'outlook!Office.MailboxEnums.SaveLocation.Other:member' + package: outlook! + summary: 'Other cloud storage providers, including OneDrive Personal.' + - name: PhotoLibrary + uid: 'outlook!Office.MailboxEnums.SaveLocation.PhotoLibrary:member' + package: outlook! + summary: The device's photo library. + - name: SharePoint + uid: 'outlook!Office.MailboxEnums.SaveLocation.SharePoint:member' + package: outlook! + summary: >- + SharePoint. Includes both SharePoint Online and SharePoint on-premises (if accessed with a Microsoft Entra ID + account). diff --git a/docs/docs-ref-autogen/outlook_1_10/toc.yml b/docs/docs-ref-autogen/outlook_1_10/toc.yml index 1f3479d4b0..61cf43c67d 100644 --- a/docs/docs-ref-autogen/outlook_1_10/toc.yml +++ b/docs/docs-ref-autogen/outlook_1_10/toc.yml @@ -43,6 +43,8 @@ items: uid: 'outlook!Office.MailboxEnums.LocationType:enum' - name: Month uid: 'outlook!Office.MailboxEnums.Month:enum' + - name: OpenLocation + uid: 'outlook!Office.MailboxEnums.OpenLocation:enum' - name: OWAView uid: 'outlook!Office.MailboxEnums.OWAView:enum' - name: RecipientType @@ -55,6 +57,8 @@ items: uid: 'outlook!Office.MailboxEnums.ResponseType:enum' - name: RestVersion uid: 'outlook!Office.MailboxEnums.RestVersion:enum' + - name: SaveLocation + uid: 'outlook!Office.MailboxEnums.SaveLocation:enum' - name: SourceProperty uid: 'outlook!Office.MailboxEnums.SourceProperty:enum' - name: WeekNumber diff --git a/docs/docs-ref-autogen/outlook_1_11/outlook.yml b/docs/docs-ref-autogen/outlook_1_11/outlook.yml index 1cf491e75f..8ce95a435c 100644 --- a/docs/docs-ref-autogen/outlook_1_11/outlook.yml +++ b/docs/docs-ref-autogen/outlook_1_11/outlook.yml @@ -81,11 +81,13 @@ enums: - 'outlook!Office.MailboxEnums.ItemType:enum' - 'outlook!Office.MailboxEnums.LocationType:enum' - 'outlook!Office.MailboxEnums.Month:enum' + - 'outlook!Office.MailboxEnums.OpenLocation:enum' - 'outlook!Office.MailboxEnums.OWAView:enum' - 'outlook!Office.MailboxEnums.RecipientType:enum' - 'outlook!Office.MailboxEnums.RecurrenceTimeZone:enum' - 'outlook!Office.MailboxEnums.RecurrenceType:enum' - 'outlook!Office.MailboxEnums.ResponseType:enum' - 'outlook!Office.MailboxEnums.RestVersion:enum' + - 'outlook!Office.MailboxEnums.SaveLocation:enum' - 'outlook!Office.MailboxEnums.SourceProperty:enum' - 'outlook!Office.MailboxEnums.WeekNumber:enum' 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 440945460d..814f516d5b 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 @@ -2136,6 +2136,124 @@ methods: return: type: void description: '' + - name: getIsIdentityManaged() + uid: 'outlook!Office.Mailbox#getIsIdentityManaged:member(1)' + package: outlook! + fullName: getIsIdentityManaged() + summary: >- + Returns true if the current mailbox is managed by [Microsoft + Intune](https://learn.microsoft.com/mem/intune/fundamentals/what-is-intune). + remarks: >- + **[Minimum permission + level](https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions)**: **read item** + + + **[Applicable Outlook + mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)**: Compose, Read + + + **Important**: This method is only supported in Outlook on Android and on iOS starting in Version 4.2443.0.To + learn more about APIs supported in Outlook on mobile devices, see [Outlook JavaScript APIs supported in Outlook on + mobile devices](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis). + + + **Errors**: + + + - `MAMServiceNotAvailable`: The client is unable to fetch the mobile application management (MAM) policy. + isPreview: false + isDeprecated: false + syntax: + content: 'getIsIdentityManaged(): boolean;' + return: + type: boolean + description: True if the current mailbox is managed by Microsoft Intune. + - name: getIsOpenFromLocationAllowed(openLocation) + uid: 'outlook!Office.Mailbox#getIsOpenFromLocationAllowed:member(1)' + package: outlook! + fullName: getIsOpenFromLocationAllowed(openLocation) + summary: >- + Returns true if an organization's [Intune mobile application management (MAM) + policy](https://learn.microsoft.com/mem/intune/apps/app-management) allows an add-in to access data from the + specified location. + remarks: >- + **[Minimum permission + level](https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions)**: **read item** + + + **[Applicable Outlook + mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)**: Compose, Read + + + **Important**: This method is only supported in Outlook on Android and on iOS starting in Version 4.2443.0. To + learn more about APIs supported in Outlook on mobile devices, see [Outlook JavaScript APIs supported in Outlook on + mobile devices](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis). + + + **Errors**: + + + - `InvalidOpenLocationInput`: The value of the specified location is invalid. + + + - `MAMServiceNotAvailable`: The client is unable to fetch the MAM policy. + isPreview: false + isDeprecated: false + syntax: + content: 'getIsOpenFromLocationAllowed(openLocation: MailboxEnums.OpenLocation): boolean;' + parameters: + - id: openLocation + description: The location from which the add-in is attempting to access data. + type: '' + return: + type: boolean + description: True if an organization's Intune MAM policy allows an add-in to access data from the specified location. + - name: getIsSaveToLocationAllowed(saveLocation) + uid: 'outlook!Office.Mailbox#getIsSaveToLocationAllowed:member(1)' + package: outlook! + fullName: getIsSaveToLocationAllowed(saveLocation) + summary: >- + Returns true if an organization's [Intune mobile application management (MAM) + policy](https://learn.microsoft.com/mem/intune/apps/app-management) allows an add-in to save data to the specified + location. + remarks: >- + **[Minimum permission + level](https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions)**: **read item** + + + **[Applicable Outlook + mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)**: Compose, Read + + + **Important**: This method is only supported in Outlook on Android and on iOS starting in Version 4.2443.0. To + learn more about APIs supported in Outlook on mobile devices, see [Outlook JavaScript APIs supported in Outlook on + mobile devices](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis). + + + **Errors**: + + + - `InvalidSaveLocationInput`: The value of the specified location is invalid. + + + - `MAMServiceNotAvailable`: The client is unable to fetch the MAM policy. + isPreview: false + isDeprecated: false + syntax: + content: 'getIsSaveToLocationAllowed(saveLocation: MailboxEnums.SaveLocation): boolean;' + parameters: + - id: saveLocation + description: The location in which the add-in is attempting to save data. + type: '' + return: + type: boolean + description: True if an organization's Intune MAM policy allows an add-in to save data to the specified location. - name: 'getUserIdentityTokenAsync(callback, userContext)' uid: 'outlook!Office.Mailbox#getUserIdentityTokenAsync:member(1)' package: outlook! 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 new file mode 100644 index 0000000000..ecc8a4a6ab --- /dev/null +++ b/docs/docs-ref-autogen/outlook_1_11/outlook/office.mailboxenums.openlocation.yml @@ -0,0 +1,51 @@ +### YamlMime:TSEnum +name: Office.MailboxEnums.OpenLocation +uid: 'outlook!Office.MailboxEnums.OpenLocation:enum' +package: outlook! +fullName: Office.MailboxEnums.OpenLocation +summary: Specifies the location from which an add-in wants to access data. +remarks: >- + **[Applicable Outlook + mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)**: + Compose, Read + + + **Important**: This enum is only supported in Outlook on Android and on iOS starting in Version 4.2443.0. To learn + more about APIs supported in Outlook on mobile devices, see [Outlook JavaScript APIs supported in Outlook on mobile + devices](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis). +isPreview: false +isDeprecated: false +fields: + - name: AccountDocument + uid: 'outlook!Office.MailboxEnums.OpenLocation.AccountDocument:member' + package: outlook! + summary: A location associated with an account within an add-in. + - name: Camera + uid: 'outlook!Office.MailboxEnums.OpenLocation.Camera:member' + package: outlook! + summary: The device's camera. + - name: Local + uid: 'outlook!Office.MailboxEnums.OpenLocation.Local:member' + package: outlook! + summary: Local storage on a device. + - name: OnedriveForBusiness + uid: 'outlook!Office.MailboxEnums.OpenLocation.OnedriveForBusiness:member' + package: outlook! + summary: |- + OneDrive for Business. + + **Important**: For OneDrive Personal, use OTHER. + - name: Other + uid: 'outlook!Office.MailboxEnums.OpenLocation.Other:member' + package: outlook! + summary: 'Other cloud storage providers, including OneDrive Personal.' + - name: PhotoLibrary + uid: 'outlook!Office.MailboxEnums.OpenLocation.PhotoLibrary:member' + package: outlook! + summary: The device's photo library. + - name: SharePoint + uid: 'outlook!Office.MailboxEnums.OpenLocation.SharePoint:member' + package: outlook! + summary: >- + SharePoint. Includes both SharePoint Online and SharePoint on-premises (if accessed with a Microsoft Entra ID + account). 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 new file mode 100644 index 0000000000..eb499cff1d --- /dev/null +++ b/docs/docs-ref-autogen/outlook_1_11/outlook/office.mailboxenums.savelocation.yml @@ -0,0 +1,59 @@ +### YamlMime:TSEnum +name: Office.MailboxEnums.SaveLocation +uid: 'outlook!Office.MailboxEnums.SaveLocation:enum' +package: outlook! +fullName: Office.MailboxEnums.SaveLocation +summary: Specifies the location in which an add-in wants to save data. +remarks: >- + **[Applicable Outlook + mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)**: + Compose, Read + + + **Important**: This enum is only supported in Outlook on Android and on iOS starting in Version 4.2443.0. To learn + more about APIs supported in Outlook on mobile devices, see [Outlook JavaScript APIs supported in Outlook on mobile + devices](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis). +isPreview: false +isDeprecated: false +fields: + - name: AccountDocument + uid: 'outlook!Office.MailboxEnums.SaveLocation.AccountDocument:member' + package: outlook! + summary: A location associated with an account within an add-in. + - name: Box + uid: 'outlook!Office.MailboxEnums.SaveLocation.Box:member' + package: outlook! + summary: Box. + - name: Dropbox + uid: 'outlook!Office.MailboxEnums.SaveLocation.Dropbox:member' + package: outlook! + summary: Dropbox. + - name: GoogleDrive + uid: 'outlook!Office.MailboxEnums.SaveLocation.GoogleDrive:member' + package: outlook! + summary: Google Drive. + - name: Local + uid: 'outlook!Office.MailboxEnums.SaveLocation.Local:member' + package: outlook! + summary: Local storage on a device. + - name: OnedriveForBusiness + uid: 'outlook!Office.MailboxEnums.SaveLocation.OnedriveForBusiness:member' + package: outlook! + summary: |- + OneDrive for Business. + + **Important**: For OneDrive Personal, use OTHER. + - name: Other + uid: 'outlook!Office.MailboxEnums.SaveLocation.Other:member' + package: outlook! + summary: 'Other cloud storage providers, including OneDrive Personal.' + - name: PhotoLibrary + uid: 'outlook!Office.MailboxEnums.SaveLocation.PhotoLibrary:member' + package: outlook! + summary: The device's photo library. + - name: SharePoint + uid: 'outlook!Office.MailboxEnums.SaveLocation.SharePoint:member' + package: outlook! + summary: >- + SharePoint. Includes both SharePoint Online and SharePoint on-premises (if accessed with a Microsoft Entra ID + account). diff --git a/docs/docs-ref-autogen/outlook_1_11/toc.yml b/docs/docs-ref-autogen/outlook_1_11/toc.yml index 4d7b041de3..abf484433d 100644 --- a/docs/docs-ref-autogen/outlook_1_11/toc.yml +++ b/docs/docs-ref-autogen/outlook_1_11/toc.yml @@ -43,6 +43,8 @@ items: uid: 'outlook!Office.MailboxEnums.LocationType:enum' - name: Month uid: 'outlook!Office.MailboxEnums.Month:enum' + - name: OpenLocation + uid: 'outlook!Office.MailboxEnums.OpenLocation:enum' - name: OWAView uid: 'outlook!Office.MailboxEnums.OWAView:enum' - name: RecipientType @@ -55,6 +57,8 @@ items: uid: 'outlook!Office.MailboxEnums.ResponseType:enum' - name: RestVersion uid: 'outlook!Office.MailboxEnums.RestVersion:enum' + - name: SaveLocation + uid: 'outlook!Office.MailboxEnums.SaveLocation:enum' - name: SourceProperty uid: 'outlook!Office.MailboxEnums.SourceProperty:enum' - name: WeekNumber diff --git a/docs/docs-ref-autogen/outlook_1_12/outlook.yml b/docs/docs-ref-autogen/outlook_1_12/outlook.yml index 96e0b32c5d..dcf7e0a623 100644 --- a/docs/docs-ref-autogen/outlook_1_12/outlook.yml +++ b/docs/docs-ref-autogen/outlook_1_12/outlook.yml @@ -82,11 +82,13 @@ enums: - 'outlook!Office.MailboxEnums.ItemType:enum' - 'outlook!Office.MailboxEnums.LocationType:enum' - 'outlook!Office.MailboxEnums.Month:enum' + - 'outlook!Office.MailboxEnums.OpenLocation:enum' - 'outlook!Office.MailboxEnums.OWAView:enum' - 'outlook!Office.MailboxEnums.RecipientType:enum' - 'outlook!Office.MailboxEnums.RecurrenceTimeZone:enum' - 'outlook!Office.MailboxEnums.RecurrenceType:enum' - 'outlook!Office.MailboxEnums.ResponseType:enum' - 'outlook!Office.MailboxEnums.RestVersion:enum' + - 'outlook!Office.MailboxEnums.SaveLocation:enum' - 'outlook!Office.MailboxEnums.SourceProperty:enum' - 'outlook!Office.MailboxEnums.WeekNumber:enum' 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 10bca284e3..c3010d8e6f 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 @@ -2136,6 +2136,124 @@ methods: return: type: void description: '' + - name: getIsIdentityManaged() + uid: 'outlook!Office.Mailbox#getIsIdentityManaged:member(1)' + package: outlook! + fullName: getIsIdentityManaged() + summary: >- + Returns true if the current mailbox is managed by [Microsoft + Intune](https://learn.microsoft.com/mem/intune/fundamentals/what-is-intune). + remarks: >- + **[Minimum permission + level](https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions)**: **read item** + + + **[Applicable Outlook + mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)**: Compose, Read + + + **Important**: This method is only supported in Outlook on Android and on iOS starting in Version 4.2443.0.To + learn more about APIs supported in Outlook on mobile devices, see [Outlook JavaScript APIs supported in Outlook on + mobile devices](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis). + + + **Errors**: + + + - `MAMServiceNotAvailable`: The client is unable to fetch the mobile application management (MAM) policy. + isPreview: false + isDeprecated: false + syntax: + content: 'getIsIdentityManaged(): boolean;' + return: + type: boolean + description: True if the current mailbox is managed by Microsoft Intune. + - name: getIsOpenFromLocationAllowed(openLocation) + uid: 'outlook!Office.Mailbox#getIsOpenFromLocationAllowed:member(1)' + package: outlook! + fullName: getIsOpenFromLocationAllowed(openLocation) + summary: >- + Returns true if an organization's [Intune mobile application management (MAM) + policy](https://learn.microsoft.com/mem/intune/apps/app-management) allows an add-in to access data from the + specified location. + remarks: >- + **[Minimum permission + level](https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions)**: **read item** + + + **[Applicable Outlook + mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)**: Compose, Read + + + **Important**: This method is only supported in Outlook on Android and on iOS starting in Version 4.2443.0. To + learn more about APIs supported in Outlook on mobile devices, see [Outlook JavaScript APIs supported in Outlook on + mobile devices](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis). + + + **Errors**: + + + - `InvalidOpenLocationInput`: The value of the specified location is invalid. + + + - `MAMServiceNotAvailable`: The client is unable to fetch the MAM policy. + isPreview: false + isDeprecated: false + syntax: + content: 'getIsOpenFromLocationAllowed(openLocation: MailboxEnums.OpenLocation): boolean;' + parameters: + - id: openLocation + description: The location from which the add-in is attempting to access data. + type: '' + return: + type: boolean + description: True if an organization's Intune MAM policy allows an add-in to access data from the specified location. + - name: getIsSaveToLocationAllowed(saveLocation) + uid: 'outlook!Office.Mailbox#getIsSaveToLocationAllowed:member(1)' + package: outlook! + fullName: getIsSaveToLocationAllowed(saveLocation) + summary: >- + Returns true if an organization's [Intune mobile application management (MAM) + policy](https://learn.microsoft.com/mem/intune/apps/app-management) allows an add-in to save data to the specified + location. + remarks: >- + **[Minimum permission + level](https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions)**: **read item** + + + **[Applicable Outlook + mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)**: Compose, Read + + + **Important**: This method is only supported in Outlook on Android and on iOS starting in Version 4.2443.0. To + learn more about APIs supported in Outlook on mobile devices, see [Outlook JavaScript APIs supported in Outlook on + mobile devices](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis). + + + **Errors**: + + + - `InvalidSaveLocationInput`: The value of the specified location is invalid. + + + - `MAMServiceNotAvailable`: The client is unable to fetch the MAM policy. + isPreview: false + isDeprecated: false + syntax: + content: 'getIsSaveToLocationAllowed(saveLocation: MailboxEnums.SaveLocation): boolean;' + parameters: + - id: saveLocation + description: The location in which the add-in is attempting to save data. + type: '' + return: + type: boolean + description: True if an organization's Intune MAM policy allows an add-in to save data to the specified location. - name: 'getUserIdentityTokenAsync(callback, userContext)' uid: 'outlook!Office.Mailbox#getUserIdentityTokenAsync:member(1)' package: outlook! 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 new file mode 100644 index 0000000000..ecc8a4a6ab --- /dev/null +++ b/docs/docs-ref-autogen/outlook_1_12/outlook/office.mailboxenums.openlocation.yml @@ -0,0 +1,51 @@ +### YamlMime:TSEnum +name: Office.MailboxEnums.OpenLocation +uid: 'outlook!Office.MailboxEnums.OpenLocation:enum' +package: outlook! +fullName: Office.MailboxEnums.OpenLocation +summary: Specifies the location from which an add-in wants to access data. +remarks: >- + **[Applicable Outlook + mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)**: + Compose, Read + + + **Important**: This enum is only supported in Outlook on Android and on iOS starting in Version 4.2443.0. To learn + more about APIs supported in Outlook on mobile devices, see [Outlook JavaScript APIs supported in Outlook on mobile + devices](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis). +isPreview: false +isDeprecated: false +fields: + - name: AccountDocument + uid: 'outlook!Office.MailboxEnums.OpenLocation.AccountDocument:member' + package: outlook! + summary: A location associated with an account within an add-in. + - name: Camera + uid: 'outlook!Office.MailboxEnums.OpenLocation.Camera:member' + package: outlook! + summary: The device's camera. + - name: Local + uid: 'outlook!Office.MailboxEnums.OpenLocation.Local:member' + package: outlook! + summary: Local storage on a device. + - name: OnedriveForBusiness + uid: 'outlook!Office.MailboxEnums.OpenLocation.OnedriveForBusiness:member' + package: outlook! + summary: |- + OneDrive for Business. + + **Important**: For OneDrive Personal, use OTHER. + - name: Other + uid: 'outlook!Office.MailboxEnums.OpenLocation.Other:member' + package: outlook! + summary: 'Other cloud storage providers, including OneDrive Personal.' + - name: PhotoLibrary + uid: 'outlook!Office.MailboxEnums.OpenLocation.PhotoLibrary:member' + package: outlook! + summary: The device's photo library. + - name: SharePoint + uid: 'outlook!Office.MailboxEnums.OpenLocation.SharePoint:member' + package: outlook! + summary: >- + SharePoint. Includes both SharePoint Online and SharePoint on-premises (if accessed with a Microsoft Entra ID + account). 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 new file mode 100644 index 0000000000..eb499cff1d --- /dev/null +++ b/docs/docs-ref-autogen/outlook_1_12/outlook/office.mailboxenums.savelocation.yml @@ -0,0 +1,59 @@ +### YamlMime:TSEnum +name: Office.MailboxEnums.SaveLocation +uid: 'outlook!Office.MailboxEnums.SaveLocation:enum' +package: outlook! +fullName: Office.MailboxEnums.SaveLocation +summary: Specifies the location in which an add-in wants to save data. +remarks: >- + **[Applicable Outlook + mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)**: + Compose, Read + + + **Important**: This enum is only supported in Outlook on Android and on iOS starting in Version 4.2443.0. To learn + more about APIs supported in Outlook on mobile devices, see [Outlook JavaScript APIs supported in Outlook on mobile + devices](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis). +isPreview: false +isDeprecated: false +fields: + - name: AccountDocument + uid: 'outlook!Office.MailboxEnums.SaveLocation.AccountDocument:member' + package: outlook! + summary: A location associated with an account within an add-in. + - name: Box + uid: 'outlook!Office.MailboxEnums.SaveLocation.Box:member' + package: outlook! + summary: Box. + - name: Dropbox + uid: 'outlook!Office.MailboxEnums.SaveLocation.Dropbox:member' + package: outlook! + summary: Dropbox. + - name: GoogleDrive + uid: 'outlook!Office.MailboxEnums.SaveLocation.GoogleDrive:member' + package: outlook! + summary: Google Drive. + - name: Local + uid: 'outlook!Office.MailboxEnums.SaveLocation.Local:member' + package: outlook! + summary: Local storage on a device. + - name: OnedriveForBusiness + uid: 'outlook!Office.MailboxEnums.SaveLocation.OnedriveForBusiness:member' + package: outlook! + summary: |- + OneDrive for Business. + + **Important**: For OneDrive Personal, use OTHER. + - name: Other + uid: 'outlook!Office.MailboxEnums.SaveLocation.Other:member' + package: outlook! + summary: 'Other cloud storage providers, including OneDrive Personal.' + - name: PhotoLibrary + uid: 'outlook!Office.MailboxEnums.SaveLocation.PhotoLibrary:member' + package: outlook! + summary: The device's photo library. + - name: SharePoint + uid: 'outlook!Office.MailboxEnums.SaveLocation.SharePoint:member' + package: outlook! + summary: >- + SharePoint. Includes both SharePoint Online and SharePoint on-premises (if accessed with a Microsoft Entra ID + account). diff --git a/docs/docs-ref-autogen/outlook_1_12/toc.yml b/docs/docs-ref-autogen/outlook_1_12/toc.yml index 6bbd7aac12..32b74d7593 100644 --- a/docs/docs-ref-autogen/outlook_1_12/toc.yml +++ b/docs/docs-ref-autogen/outlook_1_12/toc.yml @@ -43,6 +43,8 @@ items: uid: 'outlook!Office.MailboxEnums.LocationType:enum' - name: Month uid: 'outlook!Office.MailboxEnums.Month:enum' + - name: OpenLocation + uid: 'outlook!Office.MailboxEnums.OpenLocation:enum' - name: OWAView uid: 'outlook!Office.MailboxEnums.OWAView:enum' - name: RecipientType @@ -55,6 +57,8 @@ items: uid: 'outlook!Office.MailboxEnums.ResponseType:enum' - name: RestVersion uid: 'outlook!Office.MailboxEnums.RestVersion:enum' + - name: SaveLocation + uid: 'outlook!Office.MailboxEnums.SaveLocation:enum' - name: SourceProperty uid: 'outlook!Office.MailboxEnums.SourceProperty:enum' - name: WeekNumber diff --git a/docs/docs-ref-autogen/outlook_1_13/outlook.yml b/docs/docs-ref-autogen/outlook_1_13/outlook.yml index 1db3990036..0a09f4067c 100644 --- a/docs/docs-ref-autogen/outlook_1_13/outlook.yml +++ b/docs/docs-ref-autogen/outlook_1_13/outlook.yml @@ -88,11 +88,13 @@ enums: - 'outlook!Office.MailboxEnums.ItemType:enum' - 'outlook!Office.MailboxEnums.LocationType:enum' - 'outlook!Office.MailboxEnums.Month:enum' + - 'outlook!Office.MailboxEnums.OpenLocation:enum' - 'outlook!Office.MailboxEnums.OWAView:enum' - 'outlook!Office.MailboxEnums.RecipientType:enum' - 'outlook!Office.MailboxEnums.RecurrenceTimeZone:enum' - 'outlook!Office.MailboxEnums.RecurrenceType:enum' - 'outlook!Office.MailboxEnums.ResponseType:enum' - 'outlook!Office.MailboxEnums.RestVersion:enum' + - 'outlook!Office.MailboxEnums.SaveLocation:enum' - 'outlook!Office.MailboxEnums.SourceProperty:enum' - 'outlook!Office.MailboxEnums.WeekNumber:enum' 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 d67a304222..7b073a875a 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 @@ -2136,6 +2136,124 @@ methods: return: type: void description: '' + - name: getIsIdentityManaged() + uid: 'outlook!Office.Mailbox#getIsIdentityManaged:member(1)' + package: outlook! + fullName: getIsIdentityManaged() + summary: >- + Returns true if the current mailbox is managed by [Microsoft + Intune](https://learn.microsoft.com/mem/intune/fundamentals/what-is-intune). + remarks: >- + **[Minimum permission + level](https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions)**: **read item** + + + **[Applicable Outlook + mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)**: Compose, Read + + + **Important**: This method is only supported in Outlook on Android and on iOS starting in Version 4.2443.0.To + learn more about APIs supported in Outlook on mobile devices, see [Outlook JavaScript APIs supported in Outlook on + mobile devices](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis). + + + **Errors**: + + + - `MAMServiceNotAvailable`: The client is unable to fetch the mobile application management (MAM) policy. + isPreview: false + isDeprecated: false + syntax: + content: 'getIsIdentityManaged(): boolean;' + return: + type: boolean + description: True if the current mailbox is managed by Microsoft Intune. + - name: getIsOpenFromLocationAllowed(openLocation) + uid: 'outlook!Office.Mailbox#getIsOpenFromLocationAllowed:member(1)' + package: outlook! + fullName: getIsOpenFromLocationAllowed(openLocation) + summary: >- + Returns true if an organization's [Intune mobile application management (MAM) + policy](https://learn.microsoft.com/mem/intune/apps/app-management) allows an add-in to access data from the + specified location. + remarks: >- + **[Minimum permission + level](https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions)**: **read item** + + + **[Applicable Outlook + mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)**: Compose, Read + + + **Important**: This method is only supported in Outlook on Android and on iOS starting in Version 4.2443.0. To + learn more about APIs supported in Outlook on mobile devices, see [Outlook JavaScript APIs supported in Outlook on + mobile devices](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis). + + + **Errors**: + + + - `InvalidOpenLocationInput`: The value of the specified location is invalid. + + + - `MAMServiceNotAvailable`: The client is unable to fetch the MAM policy. + isPreview: false + isDeprecated: false + syntax: + content: 'getIsOpenFromLocationAllowed(openLocation: MailboxEnums.OpenLocation): boolean;' + parameters: + - id: openLocation + description: The location from which the add-in is attempting to access data. + type: '' + return: + type: boolean + description: True if an organization's Intune MAM policy allows an add-in to access data from the specified location. + - name: getIsSaveToLocationAllowed(saveLocation) + uid: 'outlook!Office.Mailbox#getIsSaveToLocationAllowed:member(1)' + package: outlook! + fullName: getIsSaveToLocationAllowed(saveLocation) + summary: >- + Returns true if an organization's [Intune mobile application management (MAM) + policy](https://learn.microsoft.com/mem/intune/apps/app-management) allows an add-in to save data to the specified + location. + remarks: >- + **[Minimum permission + level](https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions)**: **read item** + + + **[Applicable Outlook + mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)**: Compose, Read + + + **Important**: This method is only supported in Outlook on Android and on iOS starting in Version 4.2443.0. To + learn more about APIs supported in Outlook on mobile devices, see [Outlook JavaScript APIs supported in Outlook on + mobile devices](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis). + + + **Errors**: + + + - `InvalidSaveLocationInput`: The value of the specified location is invalid. + + + - `MAMServiceNotAvailable`: The client is unable to fetch the MAM policy. + isPreview: false + isDeprecated: false + syntax: + content: 'getIsSaveToLocationAllowed(saveLocation: MailboxEnums.SaveLocation): boolean;' + parameters: + - id: saveLocation + description: The location in which the add-in is attempting to save data. + type: '' + return: + type: boolean + description: True if an organization's Intune MAM policy allows an add-in to save data to the specified location. - name: 'getSelectedItemsAsync(options, callback)' uid: 'outlook!Office.Mailbox#getSelectedItemsAsync:member(1)' package: outlook! 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 new file mode 100644 index 0000000000..ecc8a4a6ab --- /dev/null +++ b/docs/docs-ref-autogen/outlook_1_13/outlook/office.mailboxenums.openlocation.yml @@ -0,0 +1,51 @@ +### YamlMime:TSEnum +name: Office.MailboxEnums.OpenLocation +uid: 'outlook!Office.MailboxEnums.OpenLocation:enum' +package: outlook! +fullName: Office.MailboxEnums.OpenLocation +summary: Specifies the location from which an add-in wants to access data. +remarks: >- + **[Applicable Outlook + mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)**: + Compose, Read + + + **Important**: This enum is only supported in Outlook on Android and on iOS starting in Version 4.2443.0. To learn + more about APIs supported in Outlook on mobile devices, see [Outlook JavaScript APIs supported in Outlook on mobile + devices](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis). +isPreview: false +isDeprecated: false +fields: + - name: AccountDocument + uid: 'outlook!Office.MailboxEnums.OpenLocation.AccountDocument:member' + package: outlook! + summary: A location associated with an account within an add-in. + - name: Camera + uid: 'outlook!Office.MailboxEnums.OpenLocation.Camera:member' + package: outlook! + summary: The device's camera. + - name: Local + uid: 'outlook!Office.MailboxEnums.OpenLocation.Local:member' + package: outlook! + summary: Local storage on a device. + - name: OnedriveForBusiness + uid: 'outlook!Office.MailboxEnums.OpenLocation.OnedriveForBusiness:member' + package: outlook! + summary: |- + OneDrive for Business. + + **Important**: For OneDrive Personal, use OTHER. + - name: Other + uid: 'outlook!Office.MailboxEnums.OpenLocation.Other:member' + package: outlook! + summary: 'Other cloud storage providers, including OneDrive Personal.' + - name: PhotoLibrary + uid: 'outlook!Office.MailboxEnums.OpenLocation.PhotoLibrary:member' + package: outlook! + summary: The device's photo library. + - name: SharePoint + uid: 'outlook!Office.MailboxEnums.OpenLocation.SharePoint:member' + package: outlook! + summary: >- + SharePoint. Includes both SharePoint Online and SharePoint on-premises (if accessed with a Microsoft Entra ID + account). 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 new file mode 100644 index 0000000000..eb499cff1d --- /dev/null +++ b/docs/docs-ref-autogen/outlook_1_13/outlook/office.mailboxenums.savelocation.yml @@ -0,0 +1,59 @@ +### YamlMime:TSEnum +name: Office.MailboxEnums.SaveLocation +uid: 'outlook!Office.MailboxEnums.SaveLocation:enum' +package: outlook! +fullName: Office.MailboxEnums.SaveLocation +summary: Specifies the location in which an add-in wants to save data. +remarks: >- + **[Applicable Outlook + mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)**: + Compose, Read + + + **Important**: This enum is only supported in Outlook on Android and on iOS starting in Version 4.2443.0. To learn + more about APIs supported in Outlook on mobile devices, see [Outlook JavaScript APIs supported in Outlook on mobile + devices](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis). +isPreview: false +isDeprecated: false +fields: + - name: AccountDocument + uid: 'outlook!Office.MailboxEnums.SaveLocation.AccountDocument:member' + package: outlook! + summary: A location associated with an account within an add-in. + - name: Box + uid: 'outlook!Office.MailboxEnums.SaveLocation.Box:member' + package: outlook! + summary: Box. + - name: Dropbox + uid: 'outlook!Office.MailboxEnums.SaveLocation.Dropbox:member' + package: outlook! + summary: Dropbox. + - name: GoogleDrive + uid: 'outlook!Office.MailboxEnums.SaveLocation.GoogleDrive:member' + package: outlook! + summary: Google Drive. + - name: Local + uid: 'outlook!Office.MailboxEnums.SaveLocation.Local:member' + package: outlook! + summary: Local storage on a device. + - name: OnedriveForBusiness + uid: 'outlook!Office.MailboxEnums.SaveLocation.OnedriveForBusiness:member' + package: outlook! + summary: |- + OneDrive for Business. + + **Important**: For OneDrive Personal, use OTHER. + - name: Other + uid: 'outlook!Office.MailboxEnums.SaveLocation.Other:member' + package: outlook! + summary: 'Other cloud storage providers, including OneDrive Personal.' + - name: PhotoLibrary + uid: 'outlook!Office.MailboxEnums.SaveLocation.PhotoLibrary:member' + package: outlook! + summary: The device's photo library. + - name: SharePoint + uid: 'outlook!Office.MailboxEnums.SaveLocation.SharePoint:member' + package: outlook! + summary: >- + SharePoint. Includes both SharePoint Online and SharePoint on-premises (if accessed with a Microsoft Entra ID + account). diff --git a/docs/docs-ref-autogen/outlook_1_13/toc.yml b/docs/docs-ref-autogen/outlook_1_13/toc.yml index bda88ae369..4982fb4d82 100644 --- a/docs/docs-ref-autogen/outlook_1_13/toc.yml +++ b/docs/docs-ref-autogen/outlook_1_13/toc.yml @@ -43,6 +43,8 @@ items: uid: 'outlook!Office.MailboxEnums.LocationType:enum' - name: Month uid: 'outlook!Office.MailboxEnums.Month:enum' + - name: OpenLocation + uid: 'outlook!Office.MailboxEnums.OpenLocation:enum' - name: OWAView uid: 'outlook!Office.MailboxEnums.OWAView:enum' - name: RecipientType @@ -55,6 +57,8 @@ items: uid: 'outlook!Office.MailboxEnums.ResponseType:enum' - name: RestVersion uid: 'outlook!Office.MailboxEnums.RestVersion:enum' + - name: SaveLocation + uid: 'outlook!Office.MailboxEnums.SaveLocation:enum' - name: SourceProperty uid: 'outlook!Office.MailboxEnums.SourceProperty:enum' - name: WeekNumber diff --git a/docs/docs-ref-autogen/outlook_1_14/outlook.yml b/docs/docs-ref-autogen/outlook_1_14/outlook.yml index da122e2d23..e45e6f6de7 100644 --- a/docs/docs-ref-autogen/outlook_1_14/outlook.yml +++ b/docs/docs-ref-autogen/outlook_1_14/outlook.yml @@ -94,12 +94,14 @@ enums: - 'outlook!Office.MailboxEnums.LocationType:enum' - 'outlook!Office.MailboxEnums.Month:enum' - 'outlook!Office.MailboxEnums.MoveSpamItemTo:enum' + - 'outlook!Office.MailboxEnums.OpenLocation:enum' - 'outlook!Office.MailboxEnums.OWAView:enum' - 'outlook!Office.MailboxEnums.RecipientType:enum' - 'outlook!Office.MailboxEnums.RecurrenceTimeZone:enum' - 'outlook!Office.MailboxEnums.RecurrenceType:enum' - 'outlook!Office.MailboxEnums.ResponseType:enum' - 'outlook!Office.MailboxEnums.RestVersion:enum' + - 'outlook!Office.MailboxEnums.SaveLocation:enum' - 'outlook!Office.MailboxEnums.SendModeOverride:enum' - 'outlook!Office.MailboxEnums.SourceProperty:enum' - 'outlook!Office.MailboxEnums.WeekNumber:enum' 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 7de99be0d0..b0a5ab6809 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 @@ -2136,6 +2136,124 @@ methods: return: type: void description: '' + - name: getIsIdentityManaged() + uid: 'outlook!Office.Mailbox#getIsIdentityManaged:member(1)' + package: outlook! + fullName: getIsIdentityManaged() + summary: >- + Returns true if the current mailbox is managed by [Microsoft + Intune](https://learn.microsoft.com/mem/intune/fundamentals/what-is-intune). + remarks: >- + **[Minimum permission + level](https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions)**: **read item** + + + **[Applicable Outlook + mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)**: Compose, Read + + + **Important**: This method is only supported in Outlook on Android and on iOS starting in Version 4.2443.0.To + learn more about APIs supported in Outlook on mobile devices, see [Outlook JavaScript APIs supported in Outlook on + mobile devices](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis). + + + **Errors**: + + + - `MAMServiceNotAvailable`: The client is unable to fetch the mobile application management (MAM) policy. + isPreview: false + isDeprecated: false + syntax: + content: 'getIsIdentityManaged(): boolean;' + return: + type: boolean + description: True if the current mailbox is managed by Microsoft Intune. + - name: getIsOpenFromLocationAllowed(openLocation) + uid: 'outlook!Office.Mailbox#getIsOpenFromLocationAllowed:member(1)' + package: outlook! + fullName: getIsOpenFromLocationAllowed(openLocation) + summary: >- + Returns true if an organization's [Intune mobile application management (MAM) + policy](https://learn.microsoft.com/mem/intune/apps/app-management) allows an add-in to access data from the + specified location. + remarks: >- + **[Minimum permission + level](https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions)**: **read item** + + + **[Applicable Outlook + mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)**: Compose, Read + + + **Important**: This method is only supported in Outlook on Android and on iOS starting in Version 4.2443.0. To + learn more about APIs supported in Outlook on mobile devices, see [Outlook JavaScript APIs supported in Outlook on + mobile devices](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis). + + + **Errors**: + + + - `InvalidOpenLocationInput`: The value of the specified location is invalid. + + + - `MAMServiceNotAvailable`: The client is unable to fetch the MAM policy. + isPreview: false + isDeprecated: false + syntax: + content: 'getIsOpenFromLocationAllowed(openLocation: MailboxEnums.OpenLocation): boolean;' + parameters: + - id: openLocation + description: The location from which the add-in is attempting to access data. + type: '' + return: + type: boolean + description: True if an organization's Intune MAM policy allows an add-in to access data from the specified location. + - name: getIsSaveToLocationAllowed(saveLocation) + uid: 'outlook!Office.Mailbox#getIsSaveToLocationAllowed:member(1)' + package: outlook! + fullName: getIsSaveToLocationAllowed(saveLocation) + summary: >- + Returns true if an organization's [Intune mobile application management (MAM) + policy](https://learn.microsoft.com/mem/intune/apps/app-management) allows an add-in to save data to the specified + location. + remarks: >- + **[Minimum permission + level](https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions)**: **read item** + + + **[Applicable Outlook + mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)**: Compose, Read + + + **Important**: This method is only supported in Outlook on Android and on iOS starting in Version 4.2443.0. To + learn more about APIs supported in Outlook on mobile devices, see [Outlook JavaScript APIs supported in Outlook on + mobile devices](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis). + + + **Errors**: + + + - `InvalidSaveLocationInput`: The value of the specified location is invalid. + + + - `MAMServiceNotAvailable`: The client is unable to fetch the MAM policy. + isPreview: false + isDeprecated: false + syntax: + content: 'getIsSaveToLocationAllowed(saveLocation: MailboxEnums.SaveLocation): boolean;' + parameters: + - id: saveLocation + description: The location in which the add-in is attempting to save data. + type: '' + return: + type: boolean + description: True if an organization's Intune MAM policy allows an add-in to save data to the specified location. - name: 'getSelectedItemsAsync(options, callback)' uid: 'outlook!Office.Mailbox#getSelectedItemsAsync:member(1)' package: outlook! 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 new file mode 100644 index 0000000000..ecc8a4a6ab --- /dev/null +++ b/docs/docs-ref-autogen/outlook_1_14/outlook/office.mailboxenums.openlocation.yml @@ -0,0 +1,51 @@ +### YamlMime:TSEnum +name: Office.MailboxEnums.OpenLocation +uid: 'outlook!Office.MailboxEnums.OpenLocation:enum' +package: outlook! +fullName: Office.MailboxEnums.OpenLocation +summary: Specifies the location from which an add-in wants to access data. +remarks: >- + **[Applicable Outlook + mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)**: + Compose, Read + + + **Important**: This enum is only supported in Outlook on Android and on iOS starting in Version 4.2443.0. To learn + more about APIs supported in Outlook on mobile devices, see [Outlook JavaScript APIs supported in Outlook on mobile + devices](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis). +isPreview: false +isDeprecated: false +fields: + - name: AccountDocument + uid: 'outlook!Office.MailboxEnums.OpenLocation.AccountDocument:member' + package: outlook! + summary: A location associated with an account within an add-in. + - name: Camera + uid: 'outlook!Office.MailboxEnums.OpenLocation.Camera:member' + package: outlook! + summary: The device's camera. + - name: Local + uid: 'outlook!Office.MailboxEnums.OpenLocation.Local:member' + package: outlook! + summary: Local storage on a device. + - name: OnedriveForBusiness + uid: 'outlook!Office.MailboxEnums.OpenLocation.OnedriveForBusiness:member' + package: outlook! + summary: |- + OneDrive for Business. + + **Important**: For OneDrive Personal, use OTHER. + - name: Other + uid: 'outlook!Office.MailboxEnums.OpenLocation.Other:member' + package: outlook! + summary: 'Other cloud storage providers, including OneDrive Personal.' + - name: PhotoLibrary + uid: 'outlook!Office.MailboxEnums.OpenLocation.PhotoLibrary:member' + package: outlook! + summary: The device's photo library. + - name: SharePoint + uid: 'outlook!Office.MailboxEnums.OpenLocation.SharePoint:member' + package: outlook! + summary: >- + SharePoint. Includes both SharePoint Online and SharePoint on-premises (if accessed with a Microsoft Entra ID + account). 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 new file mode 100644 index 0000000000..eb499cff1d --- /dev/null +++ b/docs/docs-ref-autogen/outlook_1_14/outlook/office.mailboxenums.savelocation.yml @@ -0,0 +1,59 @@ +### YamlMime:TSEnum +name: Office.MailboxEnums.SaveLocation +uid: 'outlook!Office.MailboxEnums.SaveLocation:enum' +package: outlook! +fullName: Office.MailboxEnums.SaveLocation +summary: Specifies the location in which an add-in wants to save data. +remarks: >- + **[Applicable Outlook + mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)**: + Compose, Read + + + **Important**: This enum is only supported in Outlook on Android and on iOS starting in Version 4.2443.0. To learn + more about APIs supported in Outlook on mobile devices, see [Outlook JavaScript APIs supported in Outlook on mobile + devices](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis). +isPreview: false +isDeprecated: false +fields: + - name: AccountDocument + uid: 'outlook!Office.MailboxEnums.SaveLocation.AccountDocument:member' + package: outlook! + summary: A location associated with an account within an add-in. + - name: Box + uid: 'outlook!Office.MailboxEnums.SaveLocation.Box:member' + package: outlook! + summary: Box. + - name: Dropbox + uid: 'outlook!Office.MailboxEnums.SaveLocation.Dropbox:member' + package: outlook! + summary: Dropbox. + - name: GoogleDrive + uid: 'outlook!Office.MailboxEnums.SaveLocation.GoogleDrive:member' + package: outlook! + summary: Google Drive. + - name: Local + uid: 'outlook!Office.MailboxEnums.SaveLocation.Local:member' + package: outlook! + summary: Local storage on a device. + - name: OnedriveForBusiness + uid: 'outlook!Office.MailboxEnums.SaveLocation.OnedriveForBusiness:member' + package: outlook! + summary: |- + OneDrive for Business. + + **Important**: For OneDrive Personal, use OTHER. + - name: Other + uid: 'outlook!Office.MailboxEnums.SaveLocation.Other:member' + package: outlook! + summary: 'Other cloud storage providers, including OneDrive Personal.' + - name: PhotoLibrary + uid: 'outlook!Office.MailboxEnums.SaveLocation.PhotoLibrary:member' + package: outlook! + summary: The device's photo library. + - name: SharePoint + uid: 'outlook!Office.MailboxEnums.SaveLocation.SharePoint:member' + package: outlook! + summary: >- + SharePoint. Includes both SharePoint Online and SharePoint on-premises (if accessed with a Microsoft Entra ID + account). diff --git a/docs/docs-ref-autogen/outlook_1_14/toc.yml b/docs/docs-ref-autogen/outlook_1_14/toc.yml index 04cdbbf7b2..bd63867637 100644 --- a/docs/docs-ref-autogen/outlook_1_14/toc.yml +++ b/docs/docs-ref-autogen/outlook_1_14/toc.yml @@ -47,6 +47,8 @@ items: uid: 'outlook!Office.MailboxEnums.Month:enum' - name: MoveSpamItemTo uid: 'outlook!Office.MailboxEnums.MoveSpamItemTo:enum' + - name: OpenLocation + uid: 'outlook!Office.MailboxEnums.OpenLocation:enum' - name: OWAView uid: 'outlook!Office.MailboxEnums.OWAView:enum' - name: RecipientType @@ -59,6 +61,8 @@ items: uid: 'outlook!Office.MailboxEnums.ResponseType:enum' - name: RestVersion uid: 'outlook!Office.MailboxEnums.RestVersion:enum' + - name: SaveLocation + uid: 'outlook!Office.MailboxEnums.SaveLocation:enum' - name: SendModeOverride uid: 'outlook!Office.MailboxEnums.SendModeOverride:enum' - name: SourceProperty diff --git a/docs/docs-ref-autogen/outlook_1_2/outlook.yml b/docs/docs-ref-autogen/outlook_1_2/outlook.yml index 78ded8b6ff..2310946a6f 100644 --- a/docs/docs-ref-autogen/outlook_1_2/outlook.yml +++ b/docs/docs-ref-autogen/outlook_1_2/outlook.yml @@ -40,7 +40,9 @@ enums: - 'outlook!Office.MailboxEnums.AttachmentType:enum' - 'outlook!Office.MailboxEnums.EntityType:enum' - 'outlook!Office.MailboxEnums.ItemType:enum' + - 'outlook!Office.MailboxEnums.OpenLocation:enum' - 'outlook!Office.MailboxEnums.OWAView:enum' - 'outlook!Office.MailboxEnums.RecipientType:enum' - 'outlook!Office.MailboxEnums.ResponseType:enum' + - 'outlook!Office.MailboxEnums.SaveLocation:enum' - 'outlook!Office.MailboxEnums.SourceProperty:enum' 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 f63b4ff768..ea57680320 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 @@ -714,6 +714,124 @@ methods: return: type: void description: '' + - name: getIsIdentityManaged() + uid: 'outlook!Office.Mailbox#getIsIdentityManaged:member(1)' + package: outlook! + fullName: getIsIdentityManaged() + summary: >- + Returns true if the current mailbox is managed by [Microsoft + Intune](https://learn.microsoft.com/mem/intune/fundamentals/what-is-intune). + remarks: >- + **[Minimum permission + level](https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions)**: **read item** + + + **[Applicable Outlook + mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)**: Compose, Read + + + **Important**: This method is only supported in Outlook on Android and on iOS starting in Version 4.2443.0.To + learn more about APIs supported in Outlook on mobile devices, see [Outlook JavaScript APIs supported in Outlook on + mobile devices](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis). + + + **Errors**: + + + - `MAMServiceNotAvailable`: The client is unable to fetch the mobile application management (MAM) policy. + isPreview: false + isDeprecated: false + syntax: + content: 'getIsIdentityManaged(): boolean;' + return: + type: boolean + description: True if the current mailbox is managed by Microsoft Intune. + - name: getIsOpenFromLocationAllowed(openLocation) + uid: 'outlook!Office.Mailbox#getIsOpenFromLocationAllowed:member(1)' + package: outlook! + fullName: getIsOpenFromLocationAllowed(openLocation) + summary: >- + Returns true if an organization's [Intune mobile application management (MAM) + policy](https://learn.microsoft.com/mem/intune/apps/app-management) allows an add-in to access data from the + specified location. + remarks: >- + **[Minimum permission + level](https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions)**: **read item** + + + **[Applicable Outlook + mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)**: Compose, Read + + + **Important**: This method is only supported in Outlook on Android and on iOS starting in Version 4.2443.0. To + learn more about APIs supported in Outlook on mobile devices, see [Outlook JavaScript APIs supported in Outlook on + mobile devices](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis). + + + **Errors**: + + + - `InvalidOpenLocationInput`: The value of the specified location is invalid. + + + - `MAMServiceNotAvailable`: The client is unable to fetch the MAM policy. + isPreview: false + isDeprecated: false + syntax: + content: 'getIsOpenFromLocationAllowed(openLocation: MailboxEnums.OpenLocation): boolean;' + parameters: + - id: openLocation + description: The location from which the add-in is attempting to access data. + type: '' + return: + type: boolean + description: True if an organization's Intune MAM policy allows an add-in to access data from the specified location. + - name: getIsSaveToLocationAllowed(saveLocation) + uid: 'outlook!Office.Mailbox#getIsSaveToLocationAllowed:member(1)' + package: outlook! + fullName: getIsSaveToLocationAllowed(saveLocation) + summary: >- + Returns true if an organization's [Intune mobile application management (MAM) + policy](https://learn.microsoft.com/mem/intune/apps/app-management) allows an add-in to save data to the specified + location. + remarks: >- + **[Minimum permission + level](https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions)**: **read item** + + + **[Applicable Outlook + mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)**: Compose, Read + + + **Important**: This method is only supported in Outlook on Android and on iOS starting in Version 4.2443.0. To + learn more about APIs supported in Outlook on mobile devices, see [Outlook JavaScript APIs supported in Outlook on + mobile devices](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis). + + + **Errors**: + + + - `InvalidSaveLocationInput`: The value of the specified location is invalid. + + + - `MAMServiceNotAvailable`: The client is unable to fetch the MAM policy. + isPreview: false + isDeprecated: false + syntax: + content: 'getIsSaveToLocationAllowed(saveLocation: MailboxEnums.SaveLocation): boolean;' + parameters: + - id: saveLocation + description: The location in which the add-in is attempting to save data. + type: '' + return: + type: boolean + description: True if an organization's Intune MAM policy allows an add-in to save data to the specified location. - name: 'getUserIdentityTokenAsync(callback, userContext)' uid: 'outlook!Office.Mailbox#getUserIdentityTokenAsync:member(1)' package: outlook! 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 new file mode 100644 index 0000000000..ecc8a4a6ab --- /dev/null +++ b/docs/docs-ref-autogen/outlook_1_2/outlook/office.mailboxenums.openlocation.yml @@ -0,0 +1,51 @@ +### YamlMime:TSEnum +name: Office.MailboxEnums.OpenLocation +uid: 'outlook!Office.MailboxEnums.OpenLocation:enum' +package: outlook! +fullName: Office.MailboxEnums.OpenLocation +summary: Specifies the location from which an add-in wants to access data. +remarks: >- + **[Applicable Outlook + mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)**: + Compose, Read + + + **Important**: This enum is only supported in Outlook on Android and on iOS starting in Version 4.2443.0. To learn + more about APIs supported in Outlook on mobile devices, see [Outlook JavaScript APIs supported in Outlook on mobile + devices](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis). +isPreview: false +isDeprecated: false +fields: + - name: AccountDocument + uid: 'outlook!Office.MailboxEnums.OpenLocation.AccountDocument:member' + package: outlook! + summary: A location associated with an account within an add-in. + - name: Camera + uid: 'outlook!Office.MailboxEnums.OpenLocation.Camera:member' + package: outlook! + summary: The device's camera. + - name: Local + uid: 'outlook!Office.MailboxEnums.OpenLocation.Local:member' + package: outlook! + summary: Local storage on a device. + - name: OnedriveForBusiness + uid: 'outlook!Office.MailboxEnums.OpenLocation.OnedriveForBusiness:member' + package: outlook! + summary: |- + OneDrive for Business. + + **Important**: For OneDrive Personal, use OTHER. + - name: Other + uid: 'outlook!Office.MailboxEnums.OpenLocation.Other:member' + package: outlook! + summary: 'Other cloud storage providers, including OneDrive Personal.' + - name: PhotoLibrary + uid: 'outlook!Office.MailboxEnums.OpenLocation.PhotoLibrary:member' + package: outlook! + summary: The device's photo library. + - name: SharePoint + uid: 'outlook!Office.MailboxEnums.OpenLocation.SharePoint:member' + package: outlook! + summary: >- + SharePoint. Includes both SharePoint Online and SharePoint on-premises (if accessed with a Microsoft Entra ID + account). 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 new file mode 100644 index 0000000000..eb499cff1d --- /dev/null +++ b/docs/docs-ref-autogen/outlook_1_2/outlook/office.mailboxenums.savelocation.yml @@ -0,0 +1,59 @@ +### YamlMime:TSEnum +name: Office.MailboxEnums.SaveLocation +uid: 'outlook!Office.MailboxEnums.SaveLocation:enum' +package: outlook! +fullName: Office.MailboxEnums.SaveLocation +summary: Specifies the location in which an add-in wants to save data. +remarks: >- + **[Applicable Outlook + mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)**: + Compose, Read + + + **Important**: This enum is only supported in Outlook on Android and on iOS starting in Version 4.2443.0. To learn + more about APIs supported in Outlook on mobile devices, see [Outlook JavaScript APIs supported in Outlook on mobile + devices](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis). +isPreview: false +isDeprecated: false +fields: + - name: AccountDocument + uid: 'outlook!Office.MailboxEnums.SaveLocation.AccountDocument:member' + package: outlook! + summary: A location associated with an account within an add-in. + - name: Box + uid: 'outlook!Office.MailboxEnums.SaveLocation.Box:member' + package: outlook! + summary: Box. + - name: Dropbox + uid: 'outlook!Office.MailboxEnums.SaveLocation.Dropbox:member' + package: outlook! + summary: Dropbox. + - name: GoogleDrive + uid: 'outlook!Office.MailboxEnums.SaveLocation.GoogleDrive:member' + package: outlook! + summary: Google Drive. + - name: Local + uid: 'outlook!Office.MailboxEnums.SaveLocation.Local:member' + package: outlook! + summary: Local storage on a device. + - name: OnedriveForBusiness + uid: 'outlook!Office.MailboxEnums.SaveLocation.OnedriveForBusiness:member' + package: outlook! + summary: |- + OneDrive for Business. + + **Important**: For OneDrive Personal, use OTHER. + - name: Other + uid: 'outlook!Office.MailboxEnums.SaveLocation.Other:member' + package: outlook! + summary: 'Other cloud storage providers, including OneDrive Personal.' + - name: PhotoLibrary + uid: 'outlook!Office.MailboxEnums.SaveLocation.PhotoLibrary:member' + package: outlook! + summary: The device's photo library. + - name: SharePoint + uid: 'outlook!Office.MailboxEnums.SaveLocation.SharePoint:member' + package: outlook! + summary: >- + SharePoint. Includes both SharePoint Online and SharePoint on-premises (if accessed with a Microsoft Entra ID + account). diff --git a/docs/docs-ref-autogen/outlook_1_2/toc.yml b/docs/docs-ref-autogen/outlook_1_2/toc.yml index 998e685d45..6f76c11f61 100644 --- a/docs/docs-ref-autogen/outlook_1_2/toc.yml +++ b/docs/docs-ref-autogen/outlook_1_2/toc.yml @@ -19,12 +19,16 @@ items: uid: 'outlook!Office.MailboxEnums.EntityType:enum' - name: ItemType uid: 'outlook!Office.MailboxEnums.ItemType:enum' + - name: OpenLocation + uid: 'outlook!Office.MailboxEnums.OpenLocation:enum' - name: OWAView uid: 'outlook!Office.MailboxEnums.OWAView:enum' - name: RecipientType uid: 'outlook!Office.MailboxEnums.RecipientType:enum' - name: ResponseType uid: 'outlook!Office.MailboxEnums.ResponseType:enum' + - name: SaveLocation + uid: 'outlook!Office.MailboxEnums.SaveLocation:enum' - name: SourceProperty uid: 'outlook!Office.MailboxEnums.SourceProperty:enum' - name: AppointmentCompose diff --git a/docs/docs-ref-autogen/outlook_1_3/outlook.yml b/docs/docs-ref-autogen/outlook_1_3/outlook.yml index 56ace27c80..a83aee7dc7 100644 --- a/docs/docs-ref-autogen/outlook_1_3/outlook.yml +++ b/docs/docs-ref-autogen/outlook_1_3/outlook.yml @@ -43,8 +43,10 @@ enums: - 'outlook!Office.MailboxEnums.EntityType:enum' - 'outlook!Office.MailboxEnums.ItemNotificationMessageType:enum' - 'outlook!Office.MailboxEnums.ItemType:enum' + - 'outlook!Office.MailboxEnums.OpenLocation:enum' - 'outlook!Office.MailboxEnums.OWAView:enum' - 'outlook!Office.MailboxEnums.RecipientType:enum' - 'outlook!Office.MailboxEnums.ResponseType:enum' - 'outlook!Office.MailboxEnums.RestVersion:enum' + - 'outlook!Office.MailboxEnums.SaveLocation:enum' - 'outlook!Office.MailboxEnums.SourceProperty:enum' 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 6f43e1ab76..32d4ac93d8 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 @@ -887,6 +887,124 @@ methods: return: type: void description: '' + - name: getIsIdentityManaged() + uid: 'outlook!Office.Mailbox#getIsIdentityManaged:member(1)' + package: outlook! + fullName: getIsIdentityManaged() + summary: >- + Returns true if the current mailbox is managed by [Microsoft + Intune](https://learn.microsoft.com/mem/intune/fundamentals/what-is-intune). + remarks: >- + **[Minimum permission + level](https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions)**: **read item** + + + **[Applicable Outlook + mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)**: Compose, Read + + + **Important**: This method is only supported in Outlook on Android and on iOS starting in Version 4.2443.0.To + learn more about APIs supported in Outlook on mobile devices, see [Outlook JavaScript APIs supported in Outlook on + mobile devices](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis). + + + **Errors**: + + + - `MAMServiceNotAvailable`: The client is unable to fetch the mobile application management (MAM) policy. + isPreview: false + isDeprecated: false + syntax: + content: 'getIsIdentityManaged(): boolean;' + return: + type: boolean + description: True if the current mailbox is managed by Microsoft Intune. + - name: getIsOpenFromLocationAllowed(openLocation) + uid: 'outlook!Office.Mailbox#getIsOpenFromLocationAllowed:member(1)' + package: outlook! + fullName: getIsOpenFromLocationAllowed(openLocation) + summary: >- + Returns true if an organization's [Intune mobile application management (MAM) + policy](https://learn.microsoft.com/mem/intune/apps/app-management) allows an add-in to access data from the + specified location. + remarks: >- + **[Minimum permission + level](https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions)**: **read item** + + + **[Applicable Outlook + mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)**: Compose, Read + + + **Important**: This method is only supported in Outlook on Android and on iOS starting in Version 4.2443.0. To + learn more about APIs supported in Outlook on mobile devices, see [Outlook JavaScript APIs supported in Outlook on + mobile devices](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis). + + + **Errors**: + + + - `InvalidOpenLocationInput`: The value of the specified location is invalid. + + + - `MAMServiceNotAvailable`: The client is unable to fetch the MAM policy. + isPreview: false + isDeprecated: false + syntax: + content: 'getIsOpenFromLocationAllowed(openLocation: MailboxEnums.OpenLocation): boolean;' + parameters: + - id: openLocation + description: The location from which the add-in is attempting to access data. + type: '' + return: + type: boolean + description: True if an organization's Intune MAM policy allows an add-in to access data from the specified location. + - name: getIsSaveToLocationAllowed(saveLocation) + uid: 'outlook!Office.Mailbox#getIsSaveToLocationAllowed:member(1)' + package: outlook! + fullName: getIsSaveToLocationAllowed(saveLocation) + summary: >- + Returns true if an organization's [Intune mobile application management (MAM) + policy](https://learn.microsoft.com/mem/intune/apps/app-management) allows an add-in to save data to the specified + location. + remarks: >- + **[Minimum permission + level](https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions)**: **read item** + + + **[Applicable Outlook + mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)**: Compose, Read + + + **Important**: This method is only supported in Outlook on Android and on iOS starting in Version 4.2443.0. To + learn more about APIs supported in Outlook on mobile devices, see [Outlook JavaScript APIs supported in Outlook on + mobile devices](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis). + + + **Errors**: + + + - `InvalidSaveLocationInput`: The value of the specified location is invalid. + + + - `MAMServiceNotAvailable`: The client is unable to fetch the MAM policy. + isPreview: false + isDeprecated: false + syntax: + content: 'getIsSaveToLocationAllowed(saveLocation: MailboxEnums.SaveLocation): boolean;' + parameters: + - id: saveLocation + description: The location in which the add-in is attempting to save data. + type: '' + return: + type: boolean + description: True if an organization's Intune MAM policy allows an add-in to save data to the specified location. - name: 'getUserIdentityTokenAsync(callback, userContext)' uid: 'outlook!Office.Mailbox#getUserIdentityTokenAsync:member(1)' package: outlook! 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 new file mode 100644 index 0000000000..ecc8a4a6ab --- /dev/null +++ b/docs/docs-ref-autogen/outlook_1_3/outlook/office.mailboxenums.openlocation.yml @@ -0,0 +1,51 @@ +### YamlMime:TSEnum +name: Office.MailboxEnums.OpenLocation +uid: 'outlook!Office.MailboxEnums.OpenLocation:enum' +package: outlook! +fullName: Office.MailboxEnums.OpenLocation +summary: Specifies the location from which an add-in wants to access data. +remarks: >- + **[Applicable Outlook + mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)**: + Compose, Read + + + **Important**: This enum is only supported in Outlook on Android and on iOS starting in Version 4.2443.0. To learn + more about APIs supported in Outlook on mobile devices, see [Outlook JavaScript APIs supported in Outlook on mobile + devices](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis). +isPreview: false +isDeprecated: false +fields: + - name: AccountDocument + uid: 'outlook!Office.MailboxEnums.OpenLocation.AccountDocument:member' + package: outlook! + summary: A location associated with an account within an add-in. + - name: Camera + uid: 'outlook!Office.MailboxEnums.OpenLocation.Camera:member' + package: outlook! + summary: The device's camera. + - name: Local + uid: 'outlook!Office.MailboxEnums.OpenLocation.Local:member' + package: outlook! + summary: Local storage on a device. + - name: OnedriveForBusiness + uid: 'outlook!Office.MailboxEnums.OpenLocation.OnedriveForBusiness:member' + package: outlook! + summary: |- + OneDrive for Business. + + **Important**: For OneDrive Personal, use OTHER. + - name: Other + uid: 'outlook!Office.MailboxEnums.OpenLocation.Other:member' + package: outlook! + summary: 'Other cloud storage providers, including OneDrive Personal.' + - name: PhotoLibrary + uid: 'outlook!Office.MailboxEnums.OpenLocation.PhotoLibrary:member' + package: outlook! + summary: The device's photo library. + - name: SharePoint + uid: 'outlook!Office.MailboxEnums.OpenLocation.SharePoint:member' + package: outlook! + summary: >- + SharePoint. Includes both SharePoint Online and SharePoint on-premises (if accessed with a Microsoft Entra ID + account). 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 new file mode 100644 index 0000000000..eb499cff1d --- /dev/null +++ b/docs/docs-ref-autogen/outlook_1_3/outlook/office.mailboxenums.savelocation.yml @@ -0,0 +1,59 @@ +### YamlMime:TSEnum +name: Office.MailboxEnums.SaveLocation +uid: 'outlook!Office.MailboxEnums.SaveLocation:enum' +package: outlook! +fullName: Office.MailboxEnums.SaveLocation +summary: Specifies the location in which an add-in wants to save data. +remarks: >- + **[Applicable Outlook + mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)**: + Compose, Read + + + **Important**: This enum is only supported in Outlook on Android and on iOS starting in Version 4.2443.0. To learn + more about APIs supported in Outlook on mobile devices, see [Outlook JavaScript APIs supported in Outlook on mobile + devices](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis). +isPreview: false +isDeprecated: false +fields: + - name: AccountDocument + uid: 'outlook!Office.MailboxEnums.SaveLocation.AccountDocument:member' + package: outlook! + summary: A location associated with an account within an add-in. + - name: Box + uid: 'outlook!Office.MailboxEnums.SaveLocation.Box:member' + package: outlook! + summary: Box. + - name: Dropbox + uid: 'outlook!Office.MailboxEnums.SaveLocation.Dropbox:member' + package: outlook! + summary: Dropbox. + - name: GoogleDrive + uid: 'outlook!Office.MailboxEnums.SaveLocation.GoogleDrive:member' + package: outlook! + summary: Google Drive. + - name: Local + uid: 'outlook!Office.MailboxEnums.SaveLocation.Local:member' + package: outlook! + summary: Local storage on a device. + - name: OnedriveForBusiness + uid: 'outlook!Office.MailboxEnums.SaveLocation.OnedriveForBusiness:member' + package: outlook! + summary: |- + OneDrive for Business. + + **Important**: For OneDrive Personal, use OTHER. + - name: Other + uid: 'outlook!Office.MailboxEnums.SaveLocation.Other:member' + package: outlook! + summary: 'Other cloud storage providers, including OneDrive Personal.' + - name: PhotoLibrary + uid: 'outlook!Office.MailboxEnums.SaveLocation.PhotoLibrary:member' + package: outlook! + summary: The device's photo library. + - name: SharePoint + uid: 'outlook!Office.MailboxEnums.SaveLocation.SharePoint:member' + package: outlook! + summary: >- + SharePoint. Includes both SharePoint Online and SharePoint on-premises (if accessed with a Microsoft Entra ID + account). diff --git a/docs/docs-ref-autogen/outlook_1_3/toc.yml b/docs/docs-ref-autogen/outlook_1_3/toc.yml index 1b6a366c20..b004a4bfcd 100644 --- a/docs/docs-ref-autogen/outlook_1_3/toc.yml +++ b/docs/docs-ref-autogen/outlook_1_3/toc.yml @@ -21,6 +21,8 @@ items: uid: 'outlook!Office.MailboxEnums.ItemNotificationMessageType:enum' - name: ItemType uid: 'outlook!Office.MailboxEnums.ItemType:enum' + - name: OpenLocation + uid: 'outlook!Office.MailboxEnums.OpenLocation:enum' - name: OWAView uid: 'outlook!Office.MailboxEnums.OWAView:enum' - name: RecipientType @@ -29,6 +31,8 @@ items: uid: 'outlook!Office.MailboxEnums.ResponseType:enum' - name: RestVersion uid: 'outlook!Office.MailboxEnums.RestVersion:enum' + - name: SaveLocation + uid: 'outlook!Office.MailboxEnums.SaveLocation:enum' - name: SourceProperty uid: 'outlook!Office.MailboxEnums.SourceProperty:enum' - name: AppointmentCompose diff --git a/docs/docs-ref-autogen/outlook_1_4/outlook.yml b/docs/docs-ref-autogen/outlook_1_4/outlook.yml index 56ace27c80..a83aee7dc7 100644 --- a/docs/docs-ref-autogen/outlook_1_4/outlook.yml +++ b/docs/docs-ref-autogen/outlook_1_4/outlook.yml @@ -43,8 +43,10 @@ enums: - 'outlook!Office.MailboxEnums.EntityType:enum' - 'outlook!Office.MailboxEnums.ItemNotificationMessageType:enum' - 'outlook!Office.MailboxEnums.ItemType:enum' + - 'outlook!Office.MailboxEnums.OpenLocation:enum' - 'outlook!Office.MailboxEnums.OWAView:enum' - 'outlook!Office.MailboxEnums.RecipientType:enum' - 'outlook!Office.MailboxEnums.ResponseType:enum' - 'outlook!Office.MailboxEnums.RestVersion:enum' + - 'outlook!Office.MailboxEnums.SaveLocation:enum' - 'outlook!Office.MailboxEnums.SourceProperty:enum' 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 6f43e1ab76..32d4ac93d8 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 @@ -887,6 +887,124 @@ methods: return: type: void description: '' + - name: getIsIdentityManaged() + uid: 'outlook!Office.Mailbox#getIsIdentityManaged:member(1)' + package: outlook! + fullName: getIsIdentityManaged() + summary: >- + Returns true if the current mailbox is managed by [Microsoft + Intune](https://learn.microsoft.com/mem/intune/fundamentals/what-is-intune). + remarks: >- + **[Minimum permission + level](https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions)**: **read item** + + + **[Applicable Outlook + mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)**: Compose, Read + + + **Important**: This method is only supported in Outlook on Android and on iOS starting in Version 4.2443.0.To + learn more about APIs supported in Outlook on mobile devices, see [Outlook JavaScript APIs supported in Outlook on + mobile devices](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis). + + + **Errors**: + + + - `MAMServiceNotAvailable`: The client is unable to fetch the mobile application management (MAM) policy. + isPreview: false + isDeprecated: false + syntax: + content: 'getIsIdentityManaged(): boolean;' + return: + type: boolean + description: True if the current mailbox is managed by Microsoft Intune. + - name: getIsOpenFromLocationAllowed(openLocation) + uid: 'outlook!Office.Mailbox#getIsOpenFromLocationAllowed:member(1)' + package: outlook! + fullName: getIsOpenFromLocationAllowed(openLocation) + summary: >- + Returns true if an organization's [Intune mobile application management (MAM) + policy](https://learn.microsoft.com/mem/intune/apps/app-management) allows an add-in to access data from the + specified location. + remarks: >- + **[Minimum permission + level](https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions)**: **read item** + + + **[Applicable Outlook + mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)**: Compose, Read + + + **Important**: This method is only supported in Outlook on Android and on iOS starting in Version 4.2443.0. To + learn more about APIs supported in Outlook on mobile devices, see [Outlook JavaScript APIs supported in Outlook on + mobile devices](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis). + + + **Errors**: + + + - `InvalidOpenLocationInput`: The value of the specified location is invalid. + + + - `MAMServiceNotAvailable`: The client is unable to fetch the MAM policy. + isPreview: false + isDeprecated: false + syntax: + content: 'getIsOpenFromLocationAllowed(openLocation: MailboxEnums.OpenLocation): boolean;' + parameters: + - id: openLocation + description: The location from which the add-in is attempting to access data. + type: '' + return: + type: boolean + description: True if an organization's Intune MAM policy allows an add-in to access data from the specified location. + - name: getIsSaveToLocationAllowed(saveLocation) + uid: 'outlook!Office.Mailbox#getIsSaveToLocationAllowed:member(1)' + package: outlook! + fullName: getIsSaveToLocationAllowed(saveLocation) + summary: >- + Returns true if an organization's [Intune mobile application management (MAM) + policy](https://learn.microsoft.com/mem/intune/apps/app-management) allows an add-in to save data to the specified + location. + remarks: >- + **[Minimum permission + level](https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions)**: **read item** + + + **[Applicable Outlook + mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)**: Compose, Read + + + **Important**: This method is only supported in Outlook on Android and on iOS starting in Version 4.2443.0. To + learn more about APIs supported in Outlook on mobile devices, see [Outlook JavaScript APIs supported in Outlook on + mobile devices](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis). + + + **Errors**: + + + - `InvalidSaveLocationInput`: The value of the specified location is invalid. + + + - `MAMServiceNotAvailable`: The client is unable to fetch the MAM policy. + isPreview: false + isDeprecated: false + syntax: + content: 'getIsSaveToLocationAllowed(saveLocation: MailboxEnums.SaveLocation): boolean;' + parameters: + - id: saveLocation + description: The location in which the add-in is attempting to save data. + type: '' + return: + type: boolean + description: True if an organization's Intune MAM policy allows an add-in to save data to the specified location. - name: 'getUserIdentityTokenAsync(callback, userContext)' uid: 'outlook!Office.Mailbox#getUserIdentityTokenAsync:member(1)' package: outlook! 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 new file mode 100644 index 0000000000..ecc8a4a6ab --- /dev/null +++ b/docs/docs-ref-autogen/outlook_1_4/outlook/office.mailboxenums.openlocation.yml @@ -0,0 +1,51 @@ +### YamlMime:TSEnum +name: Office.MailboxEnums.OpenLocation +uid: 'outlook!Office.MailboxEnums.OpenLocation:enum' +package: outlook! +fullName: Office.MailboxEnums.OpenLocation +summary: Specifies the location from which an add-in wants to access data. +remarks: >- + **[Applicable Outlook + mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)**: + Compose, Read + + + **Important**: This enum is only supported in Outlook on Android and on iOS starting in Version 4.2443.0. To learn + more about APIs supported in Outlook on mobile devices, see [Outlook JavaScript APIs supported in Outlook on mobile + devices](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis). +isPreview: false +isDeprecated: false +fields: + - name: AccountDocument + uid: 'outlook!Office.MailboxEnums.OpenLocation.AccountDocument:member' + package: outlook! + summary: A location associated with an account within an add-in. + - name: Camera + uid: 'outlook!Office.MailboxEnums.OpenLocation.Camera:member' + package: outlook! + summary: The device's camera. + - name: Local + uid: 'outlook!Office.MailboxEnums.OpenLocation.Local:member' + package: outlook! + summary: Local storage on a device. + - name: OnedriveForBusiness + uid: 'outlook!Office.MailboxEnums.OpenLocation.OnedriveForBusiness:member' + package: outlook! + summary: |- + OneDrive for Business. + + **Important**: For OneDrive Personal, use OTHER. + - name: Other + uid: 'outlook!Office.MailboxEnums.OpenLocation.Other:member' + package: outlook! + summary: 'Other cloud storage providers, including OneDrive Personal.' + - name: PhotoLibrary + uid: 'outlook!Office.MailboxEnums.OpenLocation.PhotoLibrary:member' + package: outlook! + summary: The device's photo library. + - name: SharePoint + uid: 'outlook!Office.MailboxEnums.OpenLocation.SharePoint:member' + package: outlook! + summary: >- + SharePoint. Includes both SharePoint Online and SharePoint on-premises (if accessed with a Microsoft Entra ID + account). 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 new file mode 100644 index 0000000000..eb499cff1d --- /dev/null +++ b/docs/docs-ref-autogen/outlook_1_4/outlook/office.mailboxenums.savelocation.yml @@ -0,0 +1,59 @@ +### YamlMime:TSEnum +name: Office.MailboxEnums.SaveLocation +uid: 'outlook!Office.MailboxEnums.SaveLocation:enum' +package: outlook! +fullName: Office.MailboxEnums.SaveLocation +summary: Specifies the location in which an add-in wants to save data. +remarks: >- + **[Applicable Outlook + mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)**: + Compose, Read + + + **Important**: This enum is only supported in Outlook on Android and on iOS starting in Version 4.2443.0. To learn + more about APIs supported in Outlook on mobile devices, see [Outlook JavaScript APIs supported in Outlook on mobile + devices](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis). +isPreview: false +isDeprecated: false +fields: + - name: AccountDocument + uid: 'outlook!Office.MailboxEnums.SaveLocation.AccountDocument:member' + package: outlook! + summary: A location associated with an account within an add-in. + - name: Box + uid: 'outlook!Office.MailboxEnums.SaveLocation.Box:member' + package: outlook! + summary: Box. + - name: Dropbox + uid: 'outlook!Office.MailboxEnums.SaveLocation.Dropbox:member' + package: outlook! + summary: Dropbox. + - name: GoogleDrive + uid: 'outlook!Office.MailboxEnums.SaveLocation.GoogleDrive:member' + package: outlook! + summary: Google Drive. + - name: Local + uid: 'outlook!Office.MailboxEnums.SaveLocation.Local:member' + package: outlook! + summary: Local storage on a device. + - name: OnedriveForBusiness + uid: 'outlook!Office.MailboxEnums.SaveLocation.OnedriveForBusiness:member' + package: outlook! + summary: |- + OneDrive for Business. + + **Important**: For OneDrive Personal, use OTHER. + - name: Other + uid: 'outlook!Office.MailboxEnums.SaveLocation.Other:member' + package: outlook! + summary: 'Other cloud storage providers, including OneDrive Personal.' + - name: PhotoLibrary + uid: 'outlook!Office.MailboxEnums.SaveLocation.PhotoLibrary:member' + package: outlook! + summary: The device's photo library. + - name: SharePoint + uid: 'outlook!Office.MailboxEnums.SaveLocation.SharePoint:member' + package: outlook! + summary: >- + SharePoint. Includes both SharePoint Online and SharePoint on-premises (if accessed with a Microsoft Entra ID + account). diff --git a/docs/docs-ref-autogen/outlook_1_4/toc.yml b/docs/docs-ref-autogen/outlook_1_4/toc.yml index 1b6a366c20..b004a4bfcd 100644 --- a/docs/docs-ref-autogen/outlook_1_4/toc.yml +++ b/docs/docs-ref-autogen/outlook_1_4/toc.yml @@ -21,6 +21,8 @@ items: uid: 'outlook!Office.MailboxEnums.ItemNotificationMessageType:enum' - name: ItemType uid: 'outlook!Office.MailboxEnums.ItemType:enum' + - name: OpenLocation + uid: 'outlook!Office.MailboxEnums.OpenLocation:enum' - name: OWAView uid: 'outlook!Office.MailboxEnums.OWAView:enum' - name: RecipientType @@ -29,6 +31,8 @@ items: uid: 'outlook!Office.MailboxEnums.ResponseType:enum' - name: RestVersion uid: 'outlook!Office.MailboxEnums.RestVersion:enum' + - name: SaveLocation + uid: 'outlook!Office.MailboxEnums.SaveLocation:enum' - name: SourceProperty uid: 'outlook!Office.MailboxEnums.SourceProperty:enum' - name: AppointmentCompose diff --git a/docs/docs-ref-autogen/outlook_1_5/outlook.yml b/docs/docs-ref-autogen/outlook_1_5/outlook.yml index 56ace27c80..a83aee7dc7 100644 --- a/docs/docs-ref-autogen/outlook_1_5/outlook.yml +++ b/docs/docs-ref-autogen/outlook_1_5/outlook.yml @@ -43,8 +43,10 @@ enums: - 'outlook!Office.MailboxEnums.EntityType:enum' - 'outlook!Office.MailboxEnums.ItemNotificationMessageType:enum' - 'outlook!Office.MailboxEnums.ItemType:enum' + - 'outlook!Office.MailboxEnums.OpenLocation:enum' - 'outlook!Office.MailboxEnums.OWAView:enum' - 'outlook!Office.MailboxEnums.RecipientType:enum' - 'outlook!Office.MailboxEnums.ResponseType:enum' - 'outlook!Office.MailboxEnums.RestVersion:enum' + - 'outlook!Office.MailboxEnums.SaveLocation:enum' - 'outlook!Office.MailboxEnums.SourceProperty:enum' 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 8cfae69f4f..b09d41bf18 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 @@ -1259,6 +1259,124 @@ methods: return: type: void description: '' + - name: getIsIdentityManaged() + uid: 'outlook!Office.Mailbox#getIsIdentityManaged:member(1)' + package: outlook! + fullName: getIsIdentityManaged() + summary: >- + Returns true if the current mailbox is managed by [Microsoft + Intune](https://learn.microsoft.com/mem/intune/fundamentals/what-is-intune). + remarks: >- + **[Minimum permission + level](https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions)**: **read item** + + + **[Applicable Outlook + mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)**: Compose, Read + + + **Important**: This method is only supported in Outlook on Android and on iOS starting in Version 4.2443.0.To + learn more about APIs supported in Outlook on mobile devices, see [Outlook JavaScript APIs supported in Outlook on + mobile devices](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis). + + + **Errors**: + + + - `MAMServiceNotAvailable`: The client is unable to fetch the mobile application management (MAM) policy. + isPreview: false + isDeprecated: false + syntax: + content: 'getIsIdentityManaged(): boolean;' + return: + type: boolean + description: True if the current mailbox is managed by Microsoft Intune. + - name: getIsOpenFromLocationAllowed(openLocation) + uid: 'outlook!Office.Mailbox#getIsOpenFromLocationAllowed:member(1)' + package: outlook! + fullName: getIsOpenFromLocationAllowed(openLocation) + summary: >- + Returns true if an organization's [Intune mobile application management (MAM) + policy](https://learn.microsoft.com/mem/intune/apps/app-management) allows an add-in to access data from the + specified location. + remarks: >- + **[Minimum permission + level](https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions)**: **read item** + + + **[Applicable Outlook + mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)**: Compose, Read + + + **Important**: This method is only supported in Outlook on Android and on iOS starting in Version 4.2443.0. To + learn more about APIs supported in Outlook on mobile devices, see [Outlook JavaScript APIs supported in Outlook on + mobile devices](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis). + + + **Errors**: + + + - `InvalidOpenLocationInput`: The value of the specified location is invalid. + + + - `MAMServiceNotAvailable`: The client is unable to fetch the MAM policy. + isPreview: false + isDeprecated: false + syntax: + content: 'getIsOpenFromLocationAllowed(openLocation: MailboxEnums.OpenLocation): boolean;' + parameters: + - id: openLocation + description: The location from which the add-in is attempting to access data. + type: '' + return: + type: boolean + description: True if an organization's Intune MAM policy allows an add-in to access data from the specified location. + - name: getIsSaveToLocationAllowed(saveLocation) + uid: 'outlook!Office.Mailbox#getIsSaveToLocationAllowed:member(1)' + package: outlook! + fullName: getIsSaveToLocationAllowed(saveLocation) + summary: >- + Returns true if an organization's [Intune mobile application management (MAM) + policy](https://learn.microsoft.com/mem/intune/apps/app-management) allows an add-in to save data to the specified + location. + remarks: >- + **[Minimum permission + level](https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions)**: **read item** + + + **[Applicable Outlook + mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)**: Compose, Read + + + **Important**: This method is only supported in Outlook on Android and on iOS starting in Version 4.2443.0. To + learn more about APIs supported in Outlook on mobile devices, see [Outlook JavaScript APIs supported in Outlook on + mobile devices](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis). + + + **Errors**: + + + - `InvalidSaveLocationInput`: The value of the specified location is invalid. + + + - `MAMServiceNotAvailable`: The client is unable to fetch the MAM policy. + isPreview: false + isDeprecated: false + syntax: + content: 'getIsSaveToLocationAllowed(saveLocation: MailboxEnums.SaveLocation): boolean;' + parameters: + - id: saveLocation + description: The location in which the add-in is attempting to save data. + type: '' + return: + type: boolean + description: True if an organization's Intune MAM policy allows an add-in to save data to the specified location. - name: 'getUserIdentityTokenAsync(callback, userContext)' uid: 'outlook!Office.Mailbox#getUserIdentityTokenAsync:member(1)' package: outlook! 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 new file mode 100644 index 0000000000..ecc8a4a6ab --- /dev/null +++ b/docs/docs-ref-autogen/outlook_1_5/outlook/office.mailboxenums.openlocation.yml @@ -0,0 +1,51 @@ +### YamlMime:TSEnum +name: Office.MailboxEnums.OpenLocation +uid: 'outlook!Office.MailboxEnums.OpenLocation:enum' +package: outlook! +fullName: Office.MailboxEnums.OpenLocation +summary: Specifies the location from which an add-in wants to access data. +remarks: >- + **[Applicable Outlook + mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)**: + Compose, Read + + + **Important**: This enum is only supported in Outlook on Android and on iOS starting in Version 4.2443.0. To learn + more about APIs supported in Outlook on mobile devices, see [Outlook JavaScript APIs supported in Outlook on mobile + devices](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis). +isPreview: false +isDeprecated: false +fields: + - name: AccountDocument + uid: 'outlook!Office.MailboxEnums.OpenLocation.AccountDocument:member' + package: outlook! + summary: A location associated with an account within an add-in. + - name: Camera + uid: 'outlook!Office.MailboxEnums.OpenLocation.Camera:member' + package: outlook! + summary: The device's camera. + - name: Local + uid: 'outlook!Office.MailboxEnums.OpenLocation.Local:member' + package: outlook! + summary: Local storage on a device. + - name: OnedriveForBusiness + uid: 'outlook!Office.MailboxEnums.OpenLocation.OnedriveForBusiness:member' + package: outlook! + summary: |- + OneDrive for Business. + + **Important**: For OneDrive Personal, use OTHER. + - name: Other + uid: 'outlook!Office.MailboxEnums.OpenLocation.Other:member' + package: outlook! + summary: 'Other cloud storage providers, including OneDrive Personal.' + - name: PhotoLibrary + uid: 'outlook!Office.MailboxEnums.OpenLocation.PhotoLibrary:member' + package: outlook! + summary: The device's photo library. + - name: SharePoint + uid: 'outlook!Office.MailboxEnums.OpenLocation.SharePoint:member' + package: outlook! + summary: >- + SharePoint. Includes both SharePoint Online and SharePoint on-premises (if accessed with a Microsoft Entra ID + account). 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 new file mode 100644 index 0000000000..eb499cff1d --- /dev/null +++ b/docs/docs-ref-autogen/outlook_1_5/outlook/office.mailboxenums.savelocation.yml @@ -0,0 +1,59 @@ +### YamlMime:TSEnum +name: Office.MailboxEnums.SaveLocation +uid: 'outlook!Office.MailboxEnums.SaveLocation:enum' +package: outlook! +fullName: Office.MailboxEnums.SaveLocation +summary: Specifies the location in which an add-in wants to save data. +remarks: >- + **[Applicable Outlook + mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)**: + Compose, Read + + + **Important**: This enum is only supported in Outlook on Android and on iOS starting in Version 4.2443.0. To learn + more about APIs supported in Outlook on mobile devices, see [Outlook JavaScript APIs supported in Outlook on mobile + devices](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis). +isPreview: false +isDeprecated: false +fields: + - name: AccountDocument + uid: 'outlook!Office.MailboxEnums.SaveLocation.AccountDocument:member' + package: outlook! + summary: A location associated with an account within an add-in. + - name: Box + uid: 'outlook!Office.MailboxEnums.SaveLocation.Box:member' + package: outlook! + summary: Box. + - name: Dropbox + uid: 'outlook!Office.MailboxEnums.SaveLocation.Dropbox:member' + package: outlook! + summary: Dropbox. + - name: GoogleDrive + uid: 'outlook!Office.MailboxEnums.SaveLocation.GoogleDrive:member' + package: outlook! + summary: Google Drive. + - name: Local + uid: 'outlook!Office.MailboxEnums.SaveLocation.Local:member' + package: outlook! + summary: Local storage on a device. + - name: OnedriveForBusiness + uid: 'outlook!Office.MailboxEnums.SaveLocation.OnedriveForBusiness:member' + package: outlook! + summary: |- + OneDrive for Business. + + **Important**: For OneDrive Personal, use OTHER. + - name: Other + uid: 'outlook!Office.MailboxEnums.SaveLocation.Other:member' + package: outlook! + summary: 'Other cloud storage providers, including OneDrive Personal.' + - name: PhotoLibrary + uid: 'outlook!Office.MailboxEnums.SaveLocation.PhotoLibrary:member' + package: outlook! + summary: The device's photo library. + - name: SharePoint + uid: 'outlook!Office.MailboxEnums.SaveLocation.SharePoint:member' + package: outlook! + summary: >- + SharePoint. Includes both SharePoint Online and SharePoint on-premises (if accessed with a Microsoft Entra ID + account). diff --git a/docs/docs-ref-autogen/outlook_1_5/toc.yml b/docs/docs-ref-autogen/outlook_1_5/toc.yml index 1b6a366c20..b004a4bfcd 100644 --- a/docs/docs-ref-autogen/outlook_1_5/toc.yml +++ b/docs/docs-ref-autogen/outlook_1_5/toc.yml @@ -21,6 +21,8 @@ items: uid: 'outlook!Office.MailboxEnums.ItemNotificationMessageType:enum' - name: ItemType uid: 'outlook!Office.MailboxEnums.ItemType:enum' + - name: OpenLocation + uid: 'outlook!Office.MailboxEnums.OpenLocation:enum' - name: OWAView uid: 'outlook!Office.MailboxEnums.OWAView:enum' - name: RecipientType @@ -29,6 +31,8 @@ items: uid: 'outlook!Office.MailboxEnums.ResponseType:enum' - name: RestVersion uid: 'outlook!Office.MailboxEnums.RestVersion:enum' + - name: SaveLocation + uid: 'outlook!Office.MailboxEnums.SaveLocation:enum' - name: SourceProperty uid: 'outlook!Office.MailboxEnums.SourceProperty:enum' - name: AppointmentCompose diff --git a/docs/docs-ref-autogen/outlook_1_6/outlook.yml b/docs/docs-ref-autogen/outlook_1_6/outlook.yml index 56ace27c80..a83aee7dc7 100644 --- a/docs/docs-ref-autogen/outlook_1_6/outlook.yml +++ b/docs/docs-ref-autogen/outlook_1_6/outlook.yml @@ -43,8 +43,10 @@ enums: - 'outlook!Office.MailboxEnums.EntityType:enum' - 'outlook!Office.MailboxEnums.ItemNotificationMessageType:enum' - 'outlook!Office.MailboxEnums.ItemType:enum' + - 'outlook!Office.MailboxEnums.OpenLocation:enum' - 'outlook!Office.MailboxEnums.OWAView:enum' - 'outlook!Office.MailboxEnums.RecipientType:enum' - 'outlook!Office.MailboxEnums.ResponseType:enum' - 'outlook!Office.MailboxEnums.RestVersion:enum' + - 'outlook!Office.MailboxEnums.SaveLocation:enum' - 'outlook!Office.MailboxEnums.SourceProperty:enum' 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 9176973cd8..f28434ef07 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 @@ -1373,6 +1373,124 @@ methods: return: type: void description: '' + - name: getIsIdentityManaged() + uid: 'outlook!Office.Mailbox#getIsIdentityManaged:member(1)' + package: outlook! + fullName: getIsIdentityManaged() + summary: >- + Returns true if the current mailbox is managed by [Microsoft + Intune](https://learn.microsoft.com/mem/intune/fundamentals/what-is-intune). + remarks: >- + **[Minimum permission + level](https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions)**: **read item** + + + **[Applicable Outlook + mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)**: Compose, Read + + + **Important**: This method is only supported in Outlook on Android and on iOS starting in Version 4.2443.0.To + learn more about APIs supported in Outlook on mobile devices, see [Outlook JavaScript APIs supported in Outlook on + mobile devices](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis). + + + **Errors**: + + + - `MAMServiceNotAvailable`: The client is unable to fetch the mobile application management (MAM) policy. + isPreview: false + isDeprecated: false + syntax: + content: 'getIsIdentityManaged(): boolean;' + return: + type: boolean + description: True if the current mailbox is managed by Microsoft Intune. + - name: getIsOpenFromLocationAllowed(openLocation) + uid: 'outlook!Office.Mailbox#getIsOpenFromLocationAllowed:member(1)' + package: outlook! + fullName: getIsOpenFromLocationAllowed(openLocation) + summary: >- + Returns true if an organization's [Intune mobile application management (MAM) + policy](https://learn.microsoft.com/mem/intune/apps/app-management) allows an add-in to access data from the + specified location. + remarks: >- + **[Minimum permission + level](https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions)**: **read item** + + + **[Applicable Outlook + mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)**: Compose, Read + + + **Important**: This method is only supported in Outlook on Android and on iOS starting in Version 4.2443.0. To + learn more about APIs supported in Outlook on mobile devices, see [Outlook JavaScript APIs supported in Outlook on + mobile devices](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis). + + + **Errors**: + + + - `InvalidOpenLocationInput`: The value of the specified location is invalid. + + + - `MAMServiceNotAvailable`: The client is unable to fetch the MAM policy. + isPreview: false + isDeprecated: false + syntax: + content: 'getIsOpenFromLocationAllowed(openLocation: MailboxEnums.OpenLocation): boolean;' + parameters: + - id: openLocation + description: The location from which the add-in is attempting to access data. + type: '' + return: + type: boolean + description: True if an organization's Intune MAM policy allows an add-in to access data from the specified location. + - name: getIsSaveToLocationAllowed(saveLocation) + uid: 'outlook!Office.Mailbox#getIsSaveToLocationAllowed:member(1)' + package: outlook! + fullName: getIsSaveToLocationAllowed(saveLocation) + summary: >- + Returns true if an organization's [Intune mobile application management (MAM) + policy](https://learn.microsoft.com/mem/intune/apps/app-management) allows an add-in to save data to the specified + location. + remarks: >- + **[Minimum permission + level](https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions)**: **read item** + + + **[Applicable Outlook + mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)**: Compose, Read + + + **Important**: This method is only supported in Outlook on Android and on iOS starting in Version 4.2443.0. To + learn more about APIs supported in Outlook on mobile devices, see [Outlook JavaScript APIs supported in Outlook on + mobile devices](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis). + + + **Errors**: + + + - `InvalidSaveLocationInput`: The value of the specified location is invalid. + + + - `MAMServiceNotAvailable`: The client is unable to fetch the MAM policy. + isPreview: false + isDeprecated: false + syntax: + content: 'getIsSaveToLocationAllowed(saveLocation: MailboxEnums.SaveLocation): boolean;' + parameters: + - id: saveLocation + description: The location in which the add-in is attempting to save data. + type: '' + return: + type: boolean + description: True if an organization's Intune MAM policy allows an add-in to save data to the specified location. - name: 'getUserIdentityTokenAsync(callback, userContext)' uid: 'outlook!Office.Mailbox#getUserIdentityTokenAsync:member(1)' package: outlook! 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 new file mode 100644 index 0000000000..ecc8a4a6ab --- /dev/null +++ b/docs/docs-ref-autogen/outlook_1_6/outlook/office.mailboxenums.openlocation.yml @@ -0,0 +1,51 @@ +### YamlMime:TSEnum +name: Office.MailboxEnums.OpenLocation +uid: 'outlook!Office.MailboxEnums.OpenLocation:enum' +package: outlook! +fullName: Office.MailboxEnums.OpenLocation +summary: Specifies the location from which an add-in wants to access data. +remarks: >- + **[Applicable Outlook + mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)**: + Compose, Read + + + **Important**: This enum is only supported in Outlook on Android and on iOS starting in Version 4.2443.0. To learn + more about APIs supported in Outlook on mobile devices, see [Outlook JavaScript APIs supported in Outlook on mobile + devices](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis). +isPreview: false +isDeprecated: false +fields: + - name: AccountDocument + uid: 'outlook!Office.MailboxEnums.OpenLocation.AccountDocument:member' + package: outlook! + summary: A location associated with an account within an add-in. + - name: Camera + uid: 'outlook!Office.MailboxEnums.OpenLocation.Camera:member' + package: outlook! + summary: The device's camera. + - name: Local + uid: 'outlook!Office.MailboxEnums.OpenLocation.Local:member' + package: outlook! + summary: Local storage on a device. + - name: OnedriveForBusiness + uid: 'outlook!Office.MailboxEnums.OpenLocation.OnedriveForBusiness:member' + package: outlook! + summary: |- + OneDrive for Business. + + **Important**: For OneDrive Personal, use OTHER. + - name: Other + uid: 'outlook!Office.MailboxEnums.OpenLocation.Other:member' + package: outlook! + summary: 'Other cloud storage providers, including OneDrive Personal.' + - name: PhotoLibrary + uid: 'outlook!Office.MailboxEnums.OpenLocation.PhotoLibrary:member' + package: outlook! + summary: The device's photo library. + - name: SharePoint + uid: 'outlook!Office.MailboxEnums.OpenLocation.SharePoint:member' + package: outlook! + summary: >- + SharePoint. Includes both SharePoint Online and SharePoint on-premises (if accessed with a Microsoft Entra ID + account). 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 new file mode 100644 index 0000000000..eb499cff1d --- /dev/null +++ b/docs/docs-ref-autogen/outlook_1_6/outlook/office.mailboxenums.savelocation.yml @@ -0,0 +1,59 @@ +### YamlMime:TSEnum +name: Office.MailboxEnums.SaveLocation +uid: 'outlook!Office.MailboxEnums.SaveLocation:enum' +package: outlook! +fullName: Office.MailboxEnums.SaveLocation +summary: Specifies the location in which an add-in wants to save data. +remarks: >- + **[Applicable Outlook + mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)**: + Compose, Read + + + **Important**: This enum is only supported in Outlook on Android and on iOS starting in Version 4.2443.0. To learn + more about APIs supported in Outlook on mobile devices, see [Outlook JavaScript APIs supported in Outlook on mobile + devices](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis). +isPreview: false +isDeprecated: false +fields: + - name: AccountDocument + uid: 'outlook!Office.MailboxEnums.SaveLocation.AccountDocument:member' + package: outlook! + summary: A location associated with an account within an add-in. + - name: Box + uid: 'outlook!Office.MailboxEnums.SaveLocation.Box:member' + package: outlook! + summary: Box. + - name: Dropbox + uid: 'outlook!Office.MailboxEnums.SaveLocation.Dropbox:member' + package: outlook! + summary: Dropbox. + - name: GoogleDrive + uid: 'outlook!Office.MailboxEnums.SaveLocation.GoogleDrive:member' + package: outlook! + summary: Google Drive. + - name: Local + uid: 'outlook!Office.MailboxEnums.SaveLocation.Local:member' + package: outlook! + summary: Local storage on a device. + - name: OnedriveForBusiness + uid: 'outlook!Office.MailboxEnums.SaveLocation.OnedriveForBusiness:member' + package: outlook! + summary: |- + OneDrive for Business. + + **Important**: For OneDrive Personal, use OTHER. + - name: Other + uid: 'outlook!Office.MailboxEnums.SaveLocation.Other:member' + package: outlook! + summary: 'Other cloud storage providers, including OneDrive Personal.' + - name: PhotoLibrary + uid: 'outlook!Office.MailboxEnums.SaveLocation.PhotoLibrary:member' + package: outlook! + summary: The device's photo library. + - name: SharePoint + uid: 'outlook!Office.MailboxEnums.SaveLocation.SharePoint:member' + package: outlook! + summary: >- + SharePoint. Includes both SharePoint Online and SharePoint on-premises (if accessed with a Microsoft Entra ID + account). diff --git a/docs/docs-ref-autogen/outlook_1_6/toc.yml b/docs/docs-ref-autogen/outlook_1_6/toc.yml index 1b6a366c20..b004a4bfcd 100644 --- a/docs/docs-ref-autogen/outlook_1_6/toc.yml +++ b/docs/docs-ref-autogen/outlook_1_6/toc.yml @@ -21,6 +21,8 @@ items: uid: 'outlook!Office.MailboxEnums.ItemNotificationMessageType:enum' - name: ItemType uid: 'outlook!Office.MailboxEnums.ItemType:enum' + - name: OpenLocation + uid: 'outlook!Office.MailboxEnums.OpenLocation:enum' - name: OWAView uid: 'outlook!Office.MailboxEnums.OWAView:enum' - name: RecipientType @@ -29,6 +31,8 @@ items: uid: 'outlook!Office.MailboxEnums.ResponseType:enum' - name: RestVersion uid: 'outlook!Office.MailboxEnums.RestVersion:enum' + - name: SaveLocation + uid: 'outlook!Office.MailboxEnums.SaveLocation:enum' - name: SourceProperty uid: 'outlook!Office.MailboxEnums.SourceProperty:enum' - name: AppointmentCompose diff --git a/docs/docs-ref-autogen/outlook_1_7/outlook.yml b/docs/docs-ref-autogen/outlook_1_7/outlook.yml index c0e7369372..48a7eb2310 100644 --- a/docs/docs-ref-autogen/outlook_1_7/outlook.yml +++ b/docs/docs-ref-autogen/outlook_1_7/outlook.yml @@ -55,11 +55,13 @@ enums: - 'outlook!Office.MailboxEnums.ItemNotificationMessageType:enum' - 'outlook!Office.MailboxEnums.ItemType:enum' - 'outlook!Office.MailboxEnums.Month:enum' + - 'outlook!Office.MailboxEnums.OpenLocation:enum' - 'outlook!Office.MailboxEnums.OWAView:enum' - 'outlook!Office.MailboxEnums.RecipientType:enum' - 'outlook!Office.MailboxEnums.RecurrenceTimeZone:enum' - 'outlook!Office.MailboxEnums.RecurrenceType:enum' - 'outlook!Office.MailboxEnums.ResponseType:enum' - 'outlook!Office.MailboxEnums.RestVersion:enum' + - 'outlook!Office.MailboxEnums.SaveLocation:enum' - 'outlook!Office.MailboxEnums.SourceProperty:enum' - 'outlook!Office.MailboxEnums.WeekNumber:enum' 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 5a928428ab..128fa83a26 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 @@ -1373,6 +1373,124 @@ methods: return: type: void description: '' + - name: getIsIdentityManaged() + uid: 'outlook!Office.Mailbox#getIsIdentityManaged:member(1)' + package: outlook! + fullName: getIsIdentityManaged() + summary: >- + Returns true if the current mailbox is managed by [Microsoft + Intune](https://learn.microsoft.com/mem/intune/fundamentals/what-is-intune). + remarks: >- + **[Minimum permission + level](https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions)**: **read item** + + + **[Applicable Outlook + mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)**: Compose, Read + + + **Important**: This method is only supported in Outlook on Android and on iOS starting in Version 4.2443.0.To + learn more about APIs supported in Outlook on mobile devices, see [Outlook JavaScript APIs supported in Outlook on + mobile devices](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis). + + + **Errors**: + + + - `MAMServiceNotAvailable`: The client is unable to fetch the mobile application management (MAM) policy. + isPreview: false + isDeprecated: false + syntax: + content: 'getIsIdentityManaged(): boolean;' + return: + type: boolean + description: True if the current mailbox is managed by Microsoft Intune. + - name: getIsOpenFromLocationAllowed(openLocation) + uid: 'outlook!Office.Mailbox#getIsOpenFromLocationAllowed:member(1)' + package: outlook! + fullName: getIsOpenFromLocationAllowed(openLocation) + summary: >- + Returns true if an organization's [Intune mobile application management (MAM) + policy](https://learn.microsoft.com/mem/intune/apps/app-management) allows an add-in to access data from the + specified location. + remarks: >- + **[Minimum permission + level](https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions)**: **read item** + + + **[Applicable Outlook + mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)**: Compose, Read + + + **Important**: This method is only supported in Outlook on Android and on iOS starting in Version 4.2443.0. To + learn more about APIs supported in Outlook on mobile devices, see [Outlook JavaScript APIs supported in Outlook on + mobile devices](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis). + + + **Errors**: + + + - `InvalidOpenLocationInput`: The value of the specified location is invalid. + + + - `MAMServiceNotAvailable`: The client is unable to fetch the MAM policy. + isPreview: false + isDeprecated: false + syntax: + content: 'getIsOpenFromLocationAllowed(openLocation: MailboxEnums.OpenLocation): boolean;' + parameters: + - id: openLocation + description: The location from which the add-in is attempting to access data. + type: '' + return: + type: boolean + description: True if an organization's Intune MAM policy allows an add-in to access data from the specified location. + - name: getIsSaveToLocationAllowed(saveLocation) + uid: 'outlook!Office.Mailbox#getIsSaveToLocationAllowed:member(1)' + package: outlook! + fullName: getIsSaveToLocationAllowed(saveLocation) + summary: >- + Returns true if an organization's [Intune mobile application management (MAM) + policy](https://learn.microsoft.com/mem/intune/apps/app-management) allows an add-in to save data to the specified + location. + remarks: >- + **[Minimum permission + level](https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions)**: **read item** + + + **[Applicable Outlook + mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)**: Compose, Read + + + **Important**: This method is only supported in Outlook on Android and on iOS starting in Version 4.2443.0. To + learn more about APIs supported in Outlook on mobile devices, see [Outlook JavaScript APIs supported in Outlook on + mobile devices](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis). + + + **Errors**: + + + - `InvalidSaveLocationInput`: The value of the specified location is invalid. + + + - `MAMServiceNotAvailable`: The client is unable to fetch the MAM policy. + isPreview: false + isDeprecated: false + syntax: + content: 'getIsSaveToLocationAllowed(saveLocation: MailboxEnums.SaveLocation): boolean;' + parameters: + - id: saveLocation + description: The location in which the add-in is attempting to save data. + type: '' + return: + type: boolean + description: True if an organization's Intune MAM policy allows an add-in to save data to the specified location. - name: 'getUserIdentityTokenAsync(callback, userContext)' uid: 'outlook!Office.Mailbox#getUserIdentityTokenAsync:member(1)' package: outlook! 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 new file mode 100644 index 0000000000..ecc8a4a6ab --- /dev/null +++ b/docs/docs-ref-autogen/outlook_1_7/outlook/office.mailboxenums.openlocation.yml @@ -0,0 +1,51 @@ +### YamlMime:TSEnum +name: Office.MailboxEnums.OpenLocation +uid: 'outlook!Office.MailboxEnums.OpenLocation:enum' +package: outlook! +fullName: Office.MailboxEnums.OpenLocation +summary: Specifies the location from which an add-in wants to access data. +remarks: >- + **[Applicable Outlook + mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)**: + Compose, Read + + + **Important**: This enum is only supported in Outlook on Android and on iOS starting in Version 4.2443.0. To learn + more about APIs supported in Outlook on mobile devices, see [Outlook JavaScript APIs supported in Outlook on mobile + devices](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis). +isPreview: false +isDeprecated: false +fields: + - name: AccountDocument + uid: 'outlook!Office.MailboxEnums.OpenLocation.AccountDocument:member' + package: outlook! + summary: A location associated with an account within an add-in. + - name: Camera + uid: 'outlook!Office.MailboxEnums.OpenLocation.Camera:member' + package: outlook! + summary: The device's camera. + - name: Local + uid: 'outlook!Office.MailboxEnums.OpenLocation.Local:member' + package: outlook! + summary: Local storage on a device. + - name: OnedriveForBusiness + uid: 'outlook!Office.MailboxEnums.OpenLocation.OnedriveForBusiness:member' + package: outlook! + summary: |- + OneDrive for Business. + + **Important**: For OneDrive Personal, use OTHER. + - name: Other + uid: 'outlook!Office.MailboxEnums.OpenLocation.Other:member' + package: outlook! + summary: 'Other cloud storage providers, including OneDrive Personal.' + - name: PhotoLibrary + uid: 'outlook!Office.MailboxEnums.OpenLocation.PhotoLibrary:member' + package: outlook! + summary: The device's photo library. + - name: SharePoint + uid: 'outlook!Office.MailboxEnums.OpenLocation.SharePoint:member' + package: outlook! + summary: >- + SharePoint. Includes both SharePoint Online and SharePoint on-premises (if accessed with a Microsoft Entra ID + account). 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 new file mode 100644 index 0000000000..eb499cff1d --- /dev/null +++ b/docs/docs-ref-autogen/outlook_1_7/outlook/office.mailboxenums.savelocation.yml @@ -0,0 +1,59 @@ +### YamlMime:TSEnum +name: Office.MailboxEnums.SaveLocation +uid: 'outlook!Office.MailboxEnums.SaveLocation:enum' +package: outlook! +fullName: Office.MailboxEnums.SaveLocation +summary: Specifies the location in which an add-in wants to save data. +remarks: >- + **[Applicable Outlook + mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)**: + Compose, Read + + + **Important**: This enum is only supported in Outlook on Android and on iOS starting in Version 4.2443.0. To learn + more about APIs supported in Outlook on mobile devices, see [Outlook JavaScript APIs supported in Outlook on mobile + devices](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis). +isPreview: false +isDeprecated: false +fields: + - name: AccountDocument + uid: 'outlook!Office.MailboxEnums.SaveLocation.AccountDocument:member' + package: outlook! + summary: A location associated with an account within an add-in. + - name: Box + uid: 'outlook!Office.MailboxEnums.SaveLocation.Box:member' + package: outlook! + summary: Box. + - name: Dropbox + uid: 'outlook!Office.MailboxEnums.SaveLocation.Dropbox:member' + package: outlook! + summary: Dropbox. + - name: GoogleDrive + uid: 'outlook!Office.MailboxEnums.SaveLocation.GoogleDrive:member' + package: outlook! + summary: Google Drive. + - name: Local + uid: 'outlook!Office.MailboxEnums.SaveLocation.Local:member' + package: outlook! + summary: Local storage on a device. + - name: OnedriveForBusiness + uid: 'outlook!Office.MailboxEnums.SaveLocation.OnedriveForBusiness:member' + package: outlook! + summary: |- + OneDrive for Business. + + **Important**: For OneDrive Personal, use OTHER. + - name: Other + uid: 'outlook!Office.MailboxEnums.SaveLocation.Other:member' + package: outlook! + summary: 'Other cloud storage providers, including OneDrive Personal.' + - name: PhotoLibrary + uid: 'outlook!Office.MailboxEnums.SaveLocation.PhotoLibrary:member' + package: outlook! + summary: The device's photo library. + - name: SharePoint + uid: 'outlook!Office.MailboxEnums.SaveLocation.SharePoint:member' + package: outlook! + summary: >- + SharePoint. Includes both SharePoint Online and SharePoint on-premises (if accessed with a Microsoft Entra ID + account). diff --git a/docs/docs-ref-autogen/outlook_1_7/toc.yml b/docs/docs-ref-autogen/outlook_1_7/toc.yml index 33c83da0dd..15977abe2d 100644 --- a/docs/docs-ref-autogen/outlook_1_7/toc.yml +++ b/docs/docs-ref-autogen/outlook_1_7/toc.yml @@ -25,6 +25,8 @@ items: uid: 'outlook!Office.MailboxEnums.ItemType:enum' - name: Month uid: 'outlook!Office.MailboxEnums.Month:enum' + - name: OpenLocation + uid: 'outlook!Office.MailboxEnums.OpenLocation:enum' - name: OWAView uid: 'outlook!Office.MailboxEnums.OWAView:enum' - name: RecipientType @@ -37,6 +39,8 @@ items: uid: 'outlook!Office.MailboxEnums.ResponseType:enum' - name: RestVersion uid: 'outlook!Office.MailboxEnums.RestVersion:enum' + - name: SaveLocation + uid: 'outlook!Office.MailboxEnums.SaveLocation:enum' - name: SourceProperty uid: 'outlook!Office.MailboxEnums.SourceProperty:enum' - name: WeekNumber diff --git a/docs/docs-ref-autogen/outlook_1_8/outlook.yml b/docs/docs-ref-autogen/outlook_1_8/outlook.yml index bc5811c175..a93252d5d8 100644 --- a/docs/docs-ref-autogen/outlook_1_8/outlook.yml +++ b/docs/docs-ref-autogen/outlook_1_8/outlook.yml @@ -72,11 +72,13 @@ enums: - 'outlook!Office.MailboxEnums.ItemType:enum' - 'outlook!Office.MailboxEnums.LocationType:enum' - 'outlook!Office.MailboxEnums.Month:enum' + - 'outlook!Office.MailboxEnums.OpenLocation:enum' - 'outlook!Office.MailboxEnums.OWAView:enum' - 'outlook!Office.MailboxEnums.RecipientType:enum' - 'outlook!Office.MailboxEnums.RecurrenceTimeZone:enum' - 'outlook!Office.MailboxEnums.RecurrenceType:enum' - 'outlook!Office.MailboxEnums.ResponseType:enum' - 'outlook!Office.MailboxEnums.RestVersion:enum' + - 'outlook!Office.MailboxEnums.SaveLocation:enum' - 'outlook!Office.MailboxEnums.SourceProperty:enum' - 'outlook!Office.MailboxEnums.WeekNumber:enum' 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 035ebefcfa..85aaad309c 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 @@ -1457,6 +1457,124 @@ methods: return: type: void description: '' + - name: getIsIdentityManaged() + uid: 'outlook!Office.Mailbox#getIsIdentityManaged:member(1)' + package: outlook! + fullName: getIsIdentityManaged() + summary: >- + Returns true if the current mailbox is managed by [Microsoft + Intune](https://learn.microsoft.com/mem/intune/fundamentals/what-is-intune). + remarks: >- + **[Minimum permission + level](https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions)**: **read item** + + + **[Applicable Outlook + mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)**: Compose, Read + + + **Important**: This method is only supported in Outlook on Android and on iOS starting in Version 4.2443.0.To + learn more about APIs supported in Outlook on mobile devices, see [Outlook JavaScript APIs supported in Outlook on + mobile devices](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis). + + + **Errors**: + + + - `MAMServiceNotAvailable`: The client is unable to fetch the mobile application management (MAM) policy. + isPreview: false + isDeprecated: false + syntax: + content: 'getIsIdentityManaged(): boolean;' + return: + type: boolean + description: True if the current mailbox is managed by Microsoft Intune. + - name: getIsOpenFromLocationAllowed(openLocation) + uid: 'outlook!Office.Mailbox#getIsOpenFromLocationAllowed:member(1)' + package: outlook! + fullName: getIsOpenFromLocationAllowed(openLocation) + summary: >- + Returns true if an organization's [Intune mobile application management (MAM) + policy](https://learn.microsoft.com/mem/intune/apps/app-management) allows an add-in to access data from the + specified location. + remarks: >- + **[Minimum permission + level](https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions)**: **read item** + + + **[Applicable Outlook + mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)**: Compose, Read + + + **Important**: This method is only supported in Outlook on Android and on iOS starting in Version 4.2443.0. To + learn more about APIs supported in Outlook on mobile devices, see [Outlook JavaScript APIs supported in Outlook on + mobile devices](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis). + + + **Errors**: + + + - `InvalidOpenLocationInput`: The value of the specified location is invalid. + + + - `MAMServiceNotAvailable`: The client is unable to fetch the MAM policy. + isPreview: false + isDeprecated: false + syntax: + content: 'getIsOpenFromLocationAllowed(openLocation: MailboxEnums.OpenLocation): boolean;' + parameters: + - id: openLocation + description: The location from which the add-in is attempting to access data. + type: '' + return: + type: boolean + description: True if an organization's Intune MAM policy allows an add-in to access data from the specified location. + - name: getIsSaveToLocationAllowed(saveLocation) + uid: 'outlook!Office.Mailbox#getIsSaveToLocationAllowed:member(1)' + package: outlook! + fullName: getIsSaveToLocationAllowed(saveLocation) + summary: >- + Returns true if an organization's [Intune mobile application management (MAM) + policy](https://learn.microsoft.com/mem/intune/apps/app-management) allows an add-in to save data to the specified + location. + remarks: >- + **[Minimum permission + level](https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions)**: **read item** + + + **[Applicable Outlook + mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)**: Compose, Read + + + **Important**: This method is only supported in Outlook on Android and on iOS starting in Version 4.2443.0. To + learn more about APIs supported in Outlook on mobile devices, see [Outlook JavaScript APIs supported in Outlook on + mobile devices](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis). + + + **Errors**: + + + - `InvalidSaveLocationInput`: The value of the specified location is invalid. + + + - `MAMServiceNotAvailable`: The client is unable to fetch the MAM policy. + isPreview: false + isDeprecated: false + syntax: + content: 'getIsSaveToLocationAllowed(saveLocation: MailboxEnums.SaveLocation): boolean;' + parameters: + - id: saveLocation + description: The location in which the add-in is attempting to save data. + type: '' + return: + type: boolean + description: True if an organization's Intune MAM policy allows an add-in to save data to the specified location. - name: 'getUserIdentityTokenAsync(callback, userContext)' uid: 'outlook!Office.Mailbox#getUserIdentityTokenAsync:member(1)' package: outlook! 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 new file mode 100644 index 0000000000..ecc8a4a6ab --- /dev/null +++ b/docs/docs-ref-autogen/outlook_1_8/outlook/office.mailboxenums.openlocation.yml @@ -0,0 +1,51 @@ +### YamlMime:TSEnum +name: Office.MailboxEnums.OpenLocation +uid: 'outlook!Office.MailboxEnums.OpenLocation:enum' +package: outlook! +fullName: Office.MailboxEnums.OpenLocation +summary: Specifies the location from which an add-in wants to access data. +remarks: >- + **[Applicable Outlook + mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)**: + Compose, Read + + + **Important**: This enum is only supported in Outlook on Android and on iOS starting in Version 4.2443.0. To learn + more about APIs supported in Outlook on mobile devices, see [Outlook JavaScript APIs supported in Outlook on mobile + devices](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis). +isPreview: false +isDeprecated: false +fields: + - name: AccountDocument + uid: 'outlook!Office.MailboxEnums.OpenLocation.AccountDocument:member' + package: outlook! + summary: A location associated with an account within an add-in. + - name: Camera + uid: 'outlook!Office.MailboxEnums.OpenLocation.Camera:member' + package: outlook! + summary: The device's camera. + - name: Local + uid: 'outlook!Office.MailboxEnums.OpenLocation.Local:member' + package: outlook! + summary: Local storage on a device. + - name: OnedriveForBusiness + uid: 'outlook!Office.MailboxEnums.OpenLocation.OnedriveForBusiness:member' + package: outlook! + summary: |- + OneDrive for Business. + + **Important**: For OneDrive Personal, use OTHER. + - name: Other + uid: 'outlook!Office.MailboxEnums.OpenLocation.Other:member' + package: outlook! + summary: 'Other cloud storage providers, including OneDrive Personal.' + - name: PhotoLibrary + uid: 'outlook!Office.MailboxEnums.OpenLocation.PhotoLibrary:member' + package: outlook! + summary: The device's photo library. + - name: SharePoint + uid: 'outlook!Office.MailboxEnums.OpenLocation.SharePoint:member' + package: outlook! + summary: >- + SharePoint. Includes both SharePoint Online and SharePoint on-premises (if accessed with a Microsoft Entra ID + account). 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 new file mode 100644 index 0000000000..eb499cff1d --- /dev/null +++ b/docs/docs-ref-autogen/outlook_1_8/outlook/office.mailboxenums.savelocation.yml @@ -0,0 +1,59 @@ +### YamlMime:TSEnum +name: Office.MailboxEnums.SaveLocation +uid: 'outlook!Office.MailboxEnums.SaveLocation:enum' +package: outlook! +fullName: Office.MailboxEnums.SaveLocation +summary: Specifies the location in which an add-in wants to save data. +remarks: >- + **[Applicable Outlook + mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)**: + Compose, Read + + + **Important**: This enum is only supported in Outlook on Android and on iOS starting in Version 4.2443.0. To learn + more about APIs supported in Outlook on mobile devices, see [Outlook JavaScript APIs supported in Outlook on mobile + devices](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis). +isPreview: false +isDeprecated: false +fields: + - name: AccountDocument + uid: 'outlook!Office.MailboxEnums.SaveLocation.AccountDocument:member' + package: outlook! + summary: A location associated with an account within an add-in. + - name: Box + uid: 'outlook!Office.MailboxEnums.SaveLocation.Box:member' + package: outlook! + summary: Box. + - name: Dropbox + uid: 'outlook!Office.MailboxEnums.SaveLocation.Dropbox:member' + package: outlook! + summary: Dropbox. + - name: GoogleDrive + uid: 'outlook!Office.MailboxEnums.SaveLocation.GoogleDrive:member' + package: outlook! + summary: Google Drive. + - name: Local + uid: 'outlook!Office.MailboxEnums.SaveLocation.Local:member' + package: outlook! + summary: Local storage on a device. + - name: OnedriveForBusiness + uid: 'outlook!Office.MailboxEnums.SaveLocation.OnedriveForBusiness:member' + package: outlook! + summary: |- + OneDrive for Business. + + **Important**: For OneDrive Personal, use OTHER. + - name: Other + uid: 'outlook!Office.MailboxEnums.SaveLocation.Other:member' + package: outlook! + summary: 'Other cloud storage providers, including OneDrive Personal.' + - name: PhotoLibrary + uid: 'outlook!Office.MailboxEnums.SaveLocation.PhotoLibrary:member' + package: outlook! + summary: The device's photo library. + - name: SharePoint + uid: 'outlook!Office.MailboxEnums.SaveLocation.SharePoint:member' + package: outlook! + summary: >- + SharePoint. Includes both SharePoint Online and SharePoint on-premises (if accessed with a Microsoft Entra ID + account). diff --git a/docs/docs-ref-autogen/outlook_1_8/toc.yml b/docs/docs-ref-autogen/outlook_1_8/toc.yml index 4e60e43d1f..f91080ca40 100644 --- a/docs/docs-ref-autogen/outlook_1_8/toc.yml +++ b/docs/docs-ref-autogen/outlook_1_8/toc.yml @@ -35,6 +35,8 @@ items: uid: 'outlook!Office.MailboxEnums.LocationType:enum' - name: Month uid: 'outlook!Office.MailboxEnums.Month:enum' + - name: OpenLocation + uid: 'outlook!Office.MailboxEnums.OpenLocation:enum' - name: OWAView uid: 'outlook!Office.MailboxEnums.OWAView:enum' - name: RecipientType @@ -47,6 +49,8 @@ items: uid: 'outlook!Office.MailboxEnums.ResponseType:enum' - name: RestVersion uid: 'outlook!Office.MailboxEnums.RestVersion:enum' + - name: SaveLocation + uid: 'outlook!Office.MailboxEnums.SaveLocation:enum' - name: SourceProperty uid: 'outlook!Office.MailboxEnums.SourceProperty:enum' - name: WeekNumber diff --git a/docs/docs-ref-autogen/outlook_1_9/outlook.yml b/docs/docs-ref-autogen/outlook_1_9/outlook.yml index bc5811c175..a93252d5d8 100644 --- a/docs/docs-ref-autogen/outlook_1_9/outlook.yml +++ b/docs/docs-ref-autogen/outlook_1_9/outlook.yml @@ -72,11 +72,13 @@ enums: - 'outlook!Office.MailboxEnums.ItemType:enum' - 'outlook!Office.MailboxEnums.LocationType:enum' - 'outlook!Office.MailboxEnums.Month:enum' + - 'outlook!Office.MailboxEnums.OpenLocation:enum' - 'outlook!Office.MailboxEnums.OWAView:enum' - 'outlook!Office.MailboxEnums.RecipientType:enum' - 'outlook!Office.MailboxEnums.RecurrenceTimeZone:enum' - 'outlook!Office.MailboxEnums.RecurrenceType:enum' - 'outlook!Office.MailboxEnums.ResponseType:enum' - 'outlook!Office.MailboxEnums.RestVersion:enum' + - 'outlook!Office.MailboxEnums.SaveLocation:enum' - 'outlook!Office.MailboxEnums.SourceProperty:enum' - 'outlook!Office.MailboxEnums.WeekNumber:enum' 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 4f146bf02a..b36604f69b 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 @@ -2136,6 +2136,124 @@ methods: return: type: void description: '' + - name: getIsIdentityManaged() + uid: 'outlook!Office.Mailbox#getIsIdentityManaged:member(1)' + package: outlook! + fullName: getIsIdentityManaged() + summary: >- + Returns true if the current mailbox is managed by [Microsoft + Intune](https://learn.microsoft.com/mem/intune/fundamentals/what-is-intune). + remarks: >- + **[Minimum permission + level](https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions)**: **read item** + + + **[Applicable Outlook + mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)**: Compose, Read + + + **Important**: This method is only supported in Outlook on Android and on iOS starting in Version 4.2443.0.To + learn more about APIs supported in Outlook on mobile devices, see [Outlook JavaScript APIs supported in Outlook on + mobile devices](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis). + + + **Errors**: + + + - `MAMServiceNotAvailable`: The client is unable to fetch the mobile application management (MAM) policy. + isPreview: false + isDeprecated: false + syntax: + content: 'getIsIdentityManaged(): boolean;' + return: + type: boolean + description: True if the current mailbox is managed by Microsoft Intune. + - name: getIsOpenFromLocationAllowed(openLocation) + uid: 'outlook!Office.Mailbox#getIsOpenFromLocationAllowed:member(1)' + package: outlook! + fullName: getIsOpenFromLocationAllowed(openLocation) + summary: >- + Returns true if an organization's [Intune mobile application management (MAM) + policy](https://learn.microsoft.com/mem/intune/apps/app-management) allows an add-in to access data from the + specified location. + remarks: >- + **[Minimum permission + level](https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions)**: **read item** + + + **[Applicable Outlook + mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)**: Compose, Read + + + **Important**: This method is only supported in Outlook on Android and on iOS starting in Version 4.2443.0. To + learn more about APIs supported in Outlook on mobile devices, see [Outlook JavaScript APIs supported in Outlook on + mobile devices](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis). + + + **Errors**: + + + - `InvalidOpenLocationInput`: The value of the specified location is invalid. + + + - `MAMServiceNotAvailable`: The client is unable to fetch the MAM policy. + isPreview: false + isDeprecated: false + syntax: + content: 'getIsOpenFromLocationAllowed(openLocation: MailboxEnums.OpenLocation): boolean;' + parameters: + - id: openLocation + description: The location from which the add-in is attempting to access data. + type: '' + return: + type: boolean + description: True if an organization's Intune MAM policy allows an add-in to access data from the specified location. + - name: getIsSaveToLocationAllowed(saveLocation) + uid: 'outlook!Office.Mailbox#getIsSaveToLocationAllowed:member(1)' + package: outlook! + fullName: getIsSaveToLocationAllowed(saveLocation) + summary: >- + Returns true if an organization's [Intune mobile application management (MAM) + policy](https://learn.microsoft.com/mem/intune/apps/app-management) allows an add-in to save data to the specified + location. + remarks: >- + **[Minimum permission + level](https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions)**: **read item** + + + **[Applicable Outlook + mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)**: Compose, Read + + + **Important**: This method is only supported in Outlook on Android and on iOS starting in Version 4.2443.0. To + learn more about APIs supported in Outlook on mobile devices, see [Outlook JavaScript APIs supported in Outlook on + mobile devices](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis). + + + **Errors**: + + + - `InvalidSaveLocationInput`: The value of the specified location is invalid. + + + - `MAMServiceNotAvailable`: The client is unable to fetch the MAM policy. + isPreview: false + isDeprecated: false + syntax: + content: 'getIsSaveToLocationAllowed(saveLocation: MailboxEnums.SaveLocation): boolean;' + parameters: + - id: saveLocation + description: The location in which the add-in is attempting to save data. + type: '' + return: + type: boolean + description: True if an organization's Intune MAM policy allows an add-in to save data to the specified location. - name: 'getUserIdentityTokenAsync(callback, userContext)' uid: 'outlook!Office.Mailbox#getUserIdentityTokenAsync:member(1)' package: outlook! 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 new file mode 100644 index 0000000000..ecc8a4a6ab --- /dev/null +++ b/docs/docs-ref-autogen/outlook_1_9/outlook/office.mailboxenums.openlocation.yml @@ -0,0 +1,51 @@ +### YamlMime:TSEnum +name: Office.MailboxEnums.OpenLocation +uid: 'outlook!Office.MailboxEnums.OpenLocation:enum' +package: outlook! +fullName: Office.MailboxEnums.OpenLocation +summary: Specifies the location from which an add-in wants to access data. +remarks: >- + **[Applicable Outlook + mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)**: + Compose, Read + + + **Important**: This enum is only supported in Outlook on Android and on iOS starting in Version 4.2443.0. To learn + more about APIs supported in Outlook on mobile devices, see [Outlook JavaScript APIs supported in Outlook on mobile + devices](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis). +isPreview: false +isDeprecated: false +fields: + - name: AccountDocument + uid: 'outlook!Office.MailboxEnums.OpenLocation.AccountDocument:member' + package: outlook! + summary: A location associated with an account within an add-in. + - name: Camera + uid: 'outlook!Office.MailboxEnums.OpenLocation.Camera:member' + package: outlook! + summary: The device's camera. + - name: Local + uid: 'outlook!Office.MailboxEnums.OpenLocation.Local:member' + package: outlook! + summary: Local storage on a device. + - name: OnedriveForBusiness + uid: 'outlook!Office.MailboxEnums.OpenLocation.OnedriveForBusiness:member' + package: outlook! + summary: |- + OneDrive for Business. + + **Important**: For OneDrive Personal, use OTHER. + - name: Other + uid: 'outlook!Office.MailboxEnums.OpenLocation.Other:member' + package: outlook! + summary: 'Other cloud storage providers, including OneDrive Personal.' + - name: PhotoLibrary + uid: 'outlook!Office.MailboxEnums.OpenLocation.PhotoLibrary:member' + package: outlook! + summary: The device's photo library. + - name: SharePoint + uid: 'outlook!Office.MailboxEnums.OpenLocation.SharePoint:member' + package: outlook! + summary: >- + SharePoint. Includes both SharePoint Online and SharePoint on-premises (if accessed with a Microsoft Entra ID + account). 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 new file mode 100644 index 0000000000..eb499cff1d --- /dev/null +++ b/docs/docs-ref-autogen/outlook_1_9/outlook/office.mailboxenums.savelocation.yml @@ -0,0 +1,59 @@ +### YamlMime:TSEnum +name: Office.MailboxEnums.SaveLocation +uid: 'outlook!Office.MailboxEnums.SaveLocation:enum' +package: outlook! +fullName: Office.MailboxEnums.SaveLocation +summary: Specifies the location in which an add-in wants to save data. +remarks: >- + **[Applicable Outlook + mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)**: + Compose, Read + + + **Important**: This enum is only supported in Outlook on Android and on iOS starting in Version 4.2443.0. To learn + more about APIs supported in Outlook on mobile devices, see [Outlook JavaScript APIs supported in Outlook on mobile + devices](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis). +isPreview: false +isDeprecated: false +fields: + - name: AccountDocument + uid: 'outlook!Office.MailboxEnums.SaveLocation.AccountDocument:member' + package: outlook! + summary: A location associated with an account within an add-in. + - name: Box + uid: 'outlook!Office.MailboxEnums.SaveLocation.Box:member' + package: outlook! + summary: Box. + - name: Dropbox + uid: 'outlook!Office.MailboxEnums.SaveLocation.Dropbox:member' + package: outlook! + summary: Dropbox. + - name: GoogleDrive + uid: 'outlook!Office.MailboxEnums.SaveLocation.GoogleDrive:member' + package: outlook! + summary: Google Drive. + - name: Local + uid: 'outlook!Office.MailboxEnums.SaveLocation.Local:member' + package: outlook! + summary: Local storage on a device. + - name: OnedriveForBusiness + uid: 'outlook!Office.MailboxEnums.SaveLocation.OnedriveForBusiness:member' + package: outlook! + summary: |- + OneDrive for Business. + + **Important**: For OneDrive Personal, use OTHER. + - name: Other + uid: 'outlook!Office.MailboxEnums.SaveLocation.Other:member' + package: outlook! + summary: 'Other cloud storage providers, including OneDrive Personal.' + - name: PhotoLibrary + uid: 'outlook!Office.MailboxEnums.SaveLocation.PhotoLibrary:member' + package: outlook! + summary: The device's photo library. + - name: SharePoint + uid: 'outlook!Office.MailboxEnums.SaveLocation.SharePoint:member' + package: outlook! + summary: >- + SharePoint. Includes both SharePoint Online and SharePoint on-premises (if accessed with a Microsoft Entra ID + account). diff --git a/docs/docs-ref-autogen/outlook_1_9/toc.yml b/docs/docs-ref-autogen/outlook_1_9/toc.yml index 4e60e43d1f..f91080ca40 100644 --- a/docs/docs-ref-autogen/outlook_1_9/toc.yml +++ b/docs/docs-ref-autogen/outlook_1_9/toc.yml @@ -35,6 +35,8 @@ items: uid: 'outlook!Office.MailboxEnums.LocationType:enum' - name: Month uid: 'outlook!Office.MailboxEnums.Month:enum' + - name: OpenLocation + uid: 'outlook!Office.MailboxEnums.OpenLocation:enum' - name: OWAView uid: 'outlook!Office.MailboxEnums.OWAView:enum' - name: RecipientType @@ -47,6 +49,8 @@ items: uid: 'outlook!Office.MailboxEnums.ResponseType:enum' - name: RestVersion uid: 'outlook!Office.MailboxEnums.RestVersion:enum' + - name: SaveLocation + uid: 'outlook!Office.MailboxEnums.SaveLocation:enum' - name: SourceProperty uid: 'outlook!Office.MailboxEnums.SourceProperty:enum' - name: WeekNumber diff --git a/docs/docs-ref-autogen/word_1_6/word/word.document.yml b/docs/docs-ref-autogen/word_1_6/word/word.document.yml index bcd9e9aadd..d8bd256529 100644 --- a/docs/docs-ref-autogen/word_1_6/word/word.document.yml +++ b/docs/docs-ref-autogen/word_1_6/word/word.document.yml @@ -661,10 +661,10 @@ methods: return: type: '' description: '' - - name: 'importStylesFromJson(stylesJson, importedStylesConflictBehavior)' + - name: importStylesFromJson(stylesJson) uid: 'word!Word.Document#importStylesFromJson:member(1)' package: word! - fullName: 'importStylesFromJson(stylesJson, importedStylesConflictBehavior)' + fullName: importStylesFromJson(stylesJson) summary: Import styles from a JSON-formatted string. remarks: >- \[ [API set: WordApi 1.6](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] @@ -696,18 +696,11 @@ methods: isPreview: false isDeprecated: false syntax: - content: >- - importStylesFromJson(stylesJson: string, importedStylesConflictBehavior?: Word.ImportedStylesConflictBehavior): - OfficeExtension.ClientResult; + content: 'importStylesFromJson(stylesJson: string, ): OfficeExtension.ClientResult;' parameters: - id: stylesJson description: Required. A JSON-formatted string representing the styles. type: string - - id: importedStylesConflictBehavior - description: >- - Optional. Specifies how to handle any imported styles with the same name as existing styles in the current - document. - type: Word.ImportedStylesConflictBehavior return: type: '<string[]>' description: '' diff --git a/docs/docs-ref-autogen/word_1_7/word/word.document.yml b/docs/docs-ref-autogen/word_1_7/word/word.document.yml index 0f23794fdc..9c549b777f 100644 --- a/docs/docs-ref-autogen/word_1_7/word/word.document.yml +++ b/docs/docs-ref-autogen/word_1_7/word/word.document.yml @@ -678,10 +678,10 @@ methods: return: type: '' description: '' - - name: 'importStylesFromJson(stylesJson, importedStylesConflictBehavior)' + - name: importStylesFromJson(stylesJson) uid: 'word!Word.Document#importStylesFromJson:member(1)' package: word! - fullName: 'importStylesFromJson(stylesJson, importedStylesConflictBehavior)' + fullName: importStylesFromJson(stylesJson) summary: Import styles from a JSON-formatted string. remarks: >- \[ [API set: WordApi 1.6](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] @@ -713,18 +713,11 @@ methods: isPreview: false isDeprecated: false syntax: - content: >- - importStylesFromJson(stylesJson: string, importedStylesConflictBehavior?: Word.ImportedStylesConflictBehavior): - OfficeExtension.ClientResult; + content: 'importStylesFromJson(stylesJson: string, ): OfficeExtension.ClientResult;' parameters: - id: stylesJson description: Required. A JSON-formatted string representing the styles. type: string - - id: importedStylesConflictBehavior - description: >- - Optional. Specifies how to handle any imported styles with the same name as existing styles in the current - document. - type: Word.ImportedStylesConflictBehavior return: type: '<string[]>' description: '' diff --git a/docs/docs-ref-autogen/word_1_8/word/word.document.yml b/docs/docs-ref-autogen/word_1_8/word/word.document.yml index cad19f3ca9..d3fbc33ac4 100644 --- a/docs/docs-ref-autogen/word_1_8/word/word.document.yml +++ b/docs/docs-ref-autogen/word_1_8/word/word.document.yml @@ -678,10 +678,10 @@ methods: return: type: '' description: '' - - name: 'importStylesFromJson(stylesJson, importedStylesConflictBehavior)' + - name: importStylesFromJson(stylesJson) uid: 'word!Word.Document#importStylesFromJson:member(1)' package: word! - fullName: 'importStylesFromJson(stylesJson, importedStylesConflictBehavior)' + fullName: importStylesFromJson(stylesJson) summary: Import styles from a JSON-formatted string. remarks: >- \[ [API set: WordApi 1.6](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] @@ -713,18 +713,11 @@ methods: isPreview: false isDeprecated: false syntax: - content: >- - importStylesFromJson(stylesJson: string, importedStylesConflictBehavior?: Word.ImportedStylesConflictBehavior): - OfficeExtension.ClientResult; + content: 'importStylesFromJson(stylesJson: string, ): OfficeExtension.ClientResult;' parameters: - id: stylesJson description: Required. A JSON-formatted string representing the styles. type: string - - id: importedStylesConflictBehavior - description: >- - Optional. Specifies how to handle any imported styles with the same name as existing styles in the current - document. - type: Word.ImportedStylesConflictBehavior return: type: '<string[]>' description: '' diff --git a/docs/docs-ref-autogen/word_1_9/word/word.document.yml b/docs/docs-ref-autogen/word_1_9/word/word.document.yml index cad19f3ca9..d3fbc33ac4 100644 --- a/docs/docs-ref-autogen/word_1_9/word/word.document.yml +++ b/docs/docs-ref-autogen/word_1_9/word/word.document.yml @@ -678,10 +678,10 @@ methods: return: type: '' description: '' - - name: 'importStylesFromJson(stylesJson, importedStylesConflictBehavior)' + - name: importStylesFromJson(stylesJson) uid: 'word!Word.Document#importStylesFromJson:member(1)' package: word! - fullName: 'importStylesFromJson(stylesJson, importedStylesConflictBehavior)' + fullName: importStylesFromJson(stylesJson) summary: Import styles from a JSON-formatted string. remarks: >- \[ [API set: WordApi 1.6](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] @@ -713,18 +713,11 @@ methods: isPreview: false isDeprecated: false syntax: - content: >- - importStylesFromJson(stylesJson: string, importedStylesConflictBehavior?: Word.ImportedStylesConflictBehavior): - OfficeExtension.ClientResult; + content: 'importStylesFromJson(stylesJson: string, ): OfficeExtension.ClientResult;' parameters: - id: stylesJson description: Required. A JSON-formatted string representing the styles. type: string - - id: importedStylesConflictBehavior - description: >- - Optional. Specifies how to handle any imported styles with the same name as existing styles in the current - document. - type: Word.ImportedStylesConflictBehavior return: type: '<string[]>' description: '' diff --git a/docs/docs-ref-autogen/word_online/word/word.document.yml b/docs/docs-ref-autogen/word_online/word/word.document.yml index cad19f3ca9..d3fbc33ac4 100644 --- a/docs/docs-ref-autogen/word_online/word/word.document.yml +++ b/docs/docs-ref-autogen/word_online/word/word.document.yml @@ -678,10 +678,10 @@ methods: return: type: '' description: '' - - name: 'importStylesFromJson(stylesJson, importedStylesConflictBehavior)' + - name: importStylesFromJson(stylesJson) uid: 'word!Word.Document#importStylesFromJson:member(1)' package: word! - fullName: 'importStylesFromJson(stylesJson, importedStylesConflictBehavior)' + fullName: importStylesFromJson(stylesJson) summary: Import styles from a JSON-formatted string. remarks: >- \[ [API set: WordApi 1.6](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] @@ -713,18 +713,11 @@ methods: isPreview: false isDeprecated: false syntax: - content: >- - importStylesFromJson(stylesJson: string, importedStylesConflictBehavior?: Word.ImportedStylesConflictBehavior): - OfficeExtension.ClientResult; + content: 'importStylesFromJson(stylesJson: string, ): OfficeExtension.ClientResult;' parameters: - id: stylesJson description: Required. A JSON-formatted string representing the styles. type: string - - id: importedStylesConflictBehavior - description: >- - Optional. Specifies how to handle any imported styles with the same name as existing styles in the current - document. - type: Word.ImportedStylesConflictBehavior return: type: '<string[]>' description: '' diff --git a/docs/includes/word-1_6.md b/docs/includes/word-1_6.md index 96e7bceabf..cc6879765c 100644 --- a/docs/includes/word-1_6.md +++ b/docs/includes/word-1_6.md @@ -4,7 +4,7 @@ |[Body](/javascript/api/word/word.body)|[getTrackedChanges()](/javascript/api/word/word.body#word-word-body-gettrackedchanges-member(1))|Gets the collection of the TrackedChange objects in the body.| |[ContentControl](/javascript/api/word/word.contentcontrol)|[getTrackedChanges()](/javascript/api/word/word.contentcontrol#word-word-contentcontrol-gettrackedchanges-member(1))|Gets the collection of the TrackedChange objects in the content control.| |[Document](/javascript/api/word/word.document)|[getParagraphByUniqueLocalId(id: string)](/javascript/api/word/word.document#word-word-document-getparagraphbyuniquelocalid-member(1))|Gets the paragraph by its unique local ID.| -||[importStylesFromJson(stylesJson: string, importedStylesConflictBehavior?: Word.ImportedStylesConflictBehavior)](/javascript/api/word/word.document#word-word-document-importstylesfromjson-member(1))|Import styles from a JSON-formatted string.| +||[importStylesFromJson(stylesJson: string)](/javascript/api/word/word.document#word-word-document-importstylesfromjson-member(1))|Import styles from a JSON-formatted string.| ||[onParagraphAdded](/javascript/api/word/word.document#word-word-document-onparagraphadded-member)|Occurs when the user adds new paragraphs.| ||[onParagraphChanged](/javascript/api/word/word.document#word-word-document-onparagraphchanged-member)|Occurs when the user changes paragraphs.| ||[onParagraphDeleted](/javascript/api/word/word.document#word-word-document-onparagraphdeleted-member)|Occurs when the user deletes paragraphs.| diff --git a/docs/includes/word-desktop-1.1.md b/docs/includes/word-desktop-1.1.md index 999242f861..3d718f32e9 100644 --- a/docs/includes/word-desktop-1.1.md +++ b/docs/includes/word-desktop-1.1.md @@ -17,6 +17,7 @@ ||[outsideBorderType](/javascript/api/word/word.bordercollection#word-word-bordercollection-outsidebordertype-member)|Specifies the border type of the outside borders.| ||[outsideBorderWidth](/javascript/api/word/word.bordercollection#word-word-bordercollection-outsideborderwidth-member)|Specifies the width of the outside borders.| |[Document](/javascript/api/word/word.document)|[compare(filePath: string, documentCompareOptions?: Word.DocumentCompareOptions)](/javascript/api/word/word.document#word-word-document-compare-member(1))|Displays revision marks that indicate where the specified document differs from another document.| +||[importStylesFromJson(stylesJson: string, importedStylesConflictBehavior?: Word.ImportedStylesConflictBehavior)](/javascript/api/word/word.document#word-word-document-importstylesfromjson-member(1))|Import styles from a JSON-formatted string.| |[DocumentCompareOptions](/javascript/api/word/word.documentcompareoptions)|[addToRecentFiles](/javascript/api/word/word.documentcompareoptions#word-word-documentcompareoptions-addtorecentfiles-member)|True adds the document to the list of recently used files on the File menu.| ||[authorName](/javascript/api/word/word.documentcompareoptions#word-word-documentcompareoptions-authorname-member)|The reviewer name associated with the differences generated by the comparison.| ||[compareTarget](/javascript/api/word/word.documentcompareoptions#word-word-documentcompareoptions-comparetarget-member)|The target document for the comparison.| diff --git a/generate-docs/API Coverage Report.csv b/generate-docs/API Coverage Report.csv index 2665b84182..95eacb1930 100644 --- a/generate-docs/API Coverage Report.csv +++ b/generate-docs/API Coverage Report.csv @@ -8988,6 +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,"getSelectedItemsAsync(options, callback)",Method,Poor,false Office.Mailbox,"getSelectedItemsAsync(callback)",Method,Poor,true Office.Mailbox,"getUserIdentityTokenAsync(callback, userContext)",Method,Fine,true @@ -9108,6 +9111,14 @@ 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,"AccountDocument",EnumField,Fine,false +Office.MailboxEnums.OpenLocation,"Camera",EnumField,Poor,false +Office.MailboxEnums.OpenLocation,"Local",EnumField,Poor,false +Office.MailboxEnums.OpenLocation,"OnedriveForBusiness",EnumField,Fine,false +Office.MailboxEnums.OpenLocation,"Other",EnumField,Fine,false +Office.MailboxEnums.OpenLocation,"PhotoLibrary",EnumField,Poor,false +Office.MailboxEnums.OpenLocation,"SharePoint",EnumField,Good,false Office.MailboxEnums.OWAView,N/A,Enum,Fine,true Office.MailboxEnums.OWAView,"OneColumnNarrow",EnumField,Good,false Office.MailboxEnums.OWAView,"OneColumn",EnumField,Good,false @@ -9271,6 +9282,16 @@ 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,"AccountDocument",EnumField,Fine,false +Office.MailboxEnums.SaveLocation,"Box",EnumField,Poor,false +Office.MailboxEnums.SaveLocation,"Dropbox",EnumField,Poor,false +Office.MailboxEnums.SaveLocation,"GoogleDrive",EnumField,Poor,false +Office.MailboxEnums.SaveLocation,"Local",EnumField,Poor,false +Office.MailboxEnums.SaveLocation,"OnedriveForBusiness",EnumField,Fine,false +Office.MailboxEnums.SaveLocation,"Other",EnumField,Fine,false +Office.MailboxEnums.SaveLocation,"PhotoLibrary",EnumField,Poor,false +Office.MailboxEnums.SaveLocation,"SharePoint",EnumField,Good,false Office.MailboxEnums.SendModeOverride,N/A,Enum,Good,true Office.MailboxEnums.SendModeOverride,"PromptUser",EnumField,Good,false Office.MailboxEnums.SourceProperty,N/A,Enum,Good,true diff --git a/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_1/Outlook.d.ts b/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_1/Outlook.d.ts index d52d1d7d50..169585f62b 100644 --- a/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_1/Outlook.d.ts +++ b/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_1/Outlook.d.ts @@ -107,6 +107,48 @@ export declare namespace Office { + /** + * Specifies the location from which an add-in wants to access data. + * + * @remarks + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose, Read + * + * **Important**: This enum is only supported in Outlook on Android and on iOS starting in Version 4.2443.0. To learn more about APIs supported in Outlook on mobile devices, see + * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}. + */ + enum OpenLocation { + /** + * A location associated with an account within an add-in. + */ + AccountDocument, + /** + * The device's camera. + */ + Camera, + /** + * Local storage on a device. + */ + Local, + /** + * OneDrive for Business. + * + * **Important**: For OneDrive Personal, use OTHER. + */ + OnedriveForBusiness, + /** + * Other cloud storage providers, including OneDrive Personal. + */ + Other, + /** + * The device's photo library. + */ + PhotoLibrary, + /** + * SharePoint. Includes both SharePoint Online and SharePoint on-premises (if accessed with a Microsoft Entra ID account). + */ + SharePoint + } /** * Represents the current view of Outlook on the web. */ @@ -204,6 +246,56 @@ export declare namespace Office { Declined = "declined" } + /** + * Specifies the location in which an add-in wants to save data. + * + * @remarks + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose, Read + * + * **Important**: This enum is only supported in Outlook on Android and on iOS starting in Version 4.2443.0. To learn more about APIs supported in Outlook on mobile devices, see + * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}. + */ + enum SaveLocation { + /** + * A location associated with an account within an add-in. + */ + AccountDocument, + /** + * Box. + */ + Box, + /** + * Dropbox. + */ + Dropbox, + /** + * Google Drive. + */ + GoogleDrive, + /** + * Local storage on a device. + */ + Local, + /** + * OneDrive for Business. + * + * **Important**: For OneDrive Personal, use OTHER. + */ + OnedriveForBusiness, + /** + * Other cloud storage providers, including OneDrive Personal. + */ + Other, + /** + * The device's photo library. + */ + PhotoLibrary, + /** + * SharePoint. Includes both SharePoint Online and SharePoint on-premises (if accessed with a Microsoft Entra ID account). + */ + SharePoint + } @@ -2563,6 +2655,73 @@ export declare namespace Office { * @param userContext - Optional. Any state data that is passed to the asynchronous method. */ getCallbackTokenAsync(callback: (asyncResult: CommonAPI.AsyncResult) => void, userContext?: any): void; + /** + * Returns true if the current mailbox is managed by {@link https://learn.microsoft.com/mem/intune/fundamentals/what-is-intune | Microsoft Intune}. + * + * @remarks + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item** + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose, Read + * + * **Important**: This method is only supported in Outlook on Android and on iOS starting in Version 4.2443.0.To learn more about APIs supported in Outlook on mobile devices, see + * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}. + * + * **Errors**: + * + * - `MAMServiceNotAvailable`: The client is unable to fetch the mobile application management (MAM) policy. + * + * @returns True if the current mailbox is managed by Microsoft Intune. + */ + getIsIdentityManaged(): boolean; + /** + * Returns true if an organization's {@link https://learn.microsoft.com/mem/intune/apps/app-management | Intune mobile application management (MAM) policy} + * allows an add-in to access data from the specified location. + * + * @remarks + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item** + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose, Read + * + * **Important**: This method is only supported in Outlook on Android and on iOS starting in Version 4.2443.0. To learn more about APIs supported in Outlook on mobile devices, see + * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}. + * + * **Errors**: + * + * - `InvalidOpenLocationInput`: The value of the specified location is invalid. + * + * - `MAMServiceNotAvailable`: The client is unable to fetch the MAM policy. + * + * @param openLocation - The location from which the add-in is attempting to access data. + * + * @returns True if an organization's Intune MAM policy allows an add-in to access data from the specified location. + */ + getIsOpenFromLocationAllowed(openLocation: MailboxEnums.OpenLocation): boolean; + /** + * Returns true if an organization's {@link https://learn.microsoft.com/mem/intune/apps/app-management | Intune mobile application management (MAM) policy} + * allows an add-in to save data to the specified location. + * + * @remarks + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item** + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose, Read + * + * **Important**: This method is only supported in Outlook on Android and on iOS starting in Version 4.2443.0. To learn more about APIs supported in Outlook on mobile devices, see + * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}. + * + * **Errors**: + * + * - `InvalidSaveLocationInput`: The value of the specified location is invalid. + * + * - `MAMServiceNotAvailable`: The client is unable to fetch the MAM policy. + * + * @param saveLocation - The location in which the add-in is attempting to save data. + * + * @returns True if an organization's Intune MAM policy allows an add-in to save data to the specified location. + */ + getIsSaveToLocationAllowed(saveLocation: MailboxEnums.SaveLocation): boolean; /** diff --git a/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_10/outlook.d.ts b/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_10/outlook.d.ts index 957a3713bc..68fc740cda 100644 --- a/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_10/outlook.d.ts +++ b/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_10/outlook.d.ts @@ -542,6 +542,48 @@ export declare namespace Office { Dec = "dec" } + /** + * Specifies the location from which an add-in wants to access data. + * + * @remarks + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose, Read + * + * **Important**: This enum is only supported in Outlook on Android and on iOS starting in Version 4.2443.0. To learn more about APIs supported in Outlook on mobile devices, see + * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}. + */ + enum OpenLocation { + /** + * A location associated with an account within an add-in. + */ + AccountDocument, + /** + * The device's camera. + */ + Camera, + /** + * Local storage on a device. + */ + Local, + /** + * OneDrive for Business. + * + * **Important**: For OneDrive Personal, use OTHER. + */ + OnedriveForBusiness, + /** + * Other cloud storage providers, including OneDrive Personal. + */ + Other, + /** + * The device's photo library. + */ + PhotoLibrary, + /** + * SharePoint. Includes both SharePoint Online and SharePoint on-premises (if accessed with a Microsoft Entra ID account). + */ + SharePoint + } /** * Represents the current view of Outlook on the web. */ @@ -1248,6 +1290,56 @@ export declare namespace Office { */ Beta = "beta" } + /** + * Specifies the location in which an add-in wants to save data. + * + * @remarks + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose, Read + * + * **Important**: This enum is only supported in Outlook on Android and on iOS starting in Version 4.2443.0. To learn more about APIs supported in Outlook on mobile devices, see + * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}. + */ + enum SaveLocation { + /** + * A location associated with an account within an add-in. + */ + AccountDocument, + /** + * Box. + */ + Box, + /** + * Dropbox. + */ + Dropbox, + /** + * Google Drive. + */ + GoogleDrive, + /** + * Local storage on a device. + */ + Local, + /** + * OneDrive for Business. + * + * **Important**: For OneDrive Personal, use OTHER. + */ + OnedriveForBusiness, + /** + * Other cloud storage providers, including OneDrive Personal. + */ + Other, + /** + * The device's photo library. + */ + PhotoLibrary, + /** + * SharePoint. Includes both SharePoint Online and SharePoint on-premises (if accessed with a Microsoft Entra ID account). + */ + SharePoint + } /** * Specifies the source of the selected data in an item (see `Office.mailbox.item.getSelectedDataAsync` for details). @@ -6527,6 +6619,73 @@ export declare namespace Office { * @param userContext - Optional. Any state data that is passed to the asynchronous method. */ getCallbackTokenAsync(callback: (asyncResult: CommonAPI.AsyncResult) => void, userContext?: any): void; + /** + * Returns true if the current mailbox is managed by {@link https://learn.microsoft.com/mem/intune/fundamentals/what-is-intune | Microsoft Intune}. + * + * @remarks + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item** + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose, Read + * + * **Important**: This method is only supported in Outlook on Android and on iOS starting in Version 4.2443.0.To learn more about APIs supported in Outlook on mobile devices, see + * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}. + * + * **Errors**: + * + * - `MAMServiceNotAvailable`: The client is unable to fetch the mobile application management (MAM) policy. + * + * @returns True if the current mailbox is managed by Microsoft Intune. + */ + getIsIdentityManaged(): boolean; + /** + * Returns true if an organization's {@link https://learn.microsoft.com/mem/intune/apps/app-management | Intune mobile application management (MAM) policy} + * allows an add-in to access data from the specified location. + * + * @remarks + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item** + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose, Read + * + * **Important**: This method is only supported in Outlook on Android and on iOS starting in Version 4.2443.0. To learn more about APIs supported in Outlook on mobile devices, see + * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}. + * + * **Errors**: + * + * - `InvalidOpenLocationInput`: The value of the specified location is invalid. + * + * - `MAMServiceNotAvailable`: The client is unable to fetch the MAM policy. + * + * @param openLocation - The location from which the add-in is attempting to access data. + * + * @returns True if an organization's Intune MAM policy allows an add-in to access data from the specified location. + */ + getIsOpenFromLocationAllowed(openLocation: MailboxEnums.OpenLocation): boolean; + /** + * Returns true if an organization's {@link https://learn.microsoft.com/mem/intune/apps/app-management | Intune mobile application management (MAM) policy} + * allows an add-in to save data to the specified location. + * + * @remarks + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item** + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose, Read + * + * **Important**: This method is only supported in Outlook on Android and on iOS starting in Version 4.2443.0. To learn more about APIs supported in Outlook on mobile devices, see + * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}. + * + * **Errors**: + * + * - `InvalidSaveLocationInput`: The value of the specified location is invalid. + * + * - `MAMServiceNotAvailable`: The client is unable to fetch the MAM policy. + * + * @param saveLocation - The location in which the add-in is attempting to save data. + * + * @returns True if an organization's Intune MAM policy allows an add-in to save data to the specified location. + */ + getIsSaveToLocationAllowed(saveLocation: MailboxEnums.SaveLocation): boolean; /** diff --git a/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_11/outlook.d.ts b/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_11/outlook.d.ts index 0025bb6beb..2d5b607417 100644 --- a/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_11/outlook.d.ts +++ b/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_11/outlook.d.ts @@ -542,6 +542,48 @@ export declare namespace Office { Dec = "dec" } + /** + * Specifies the location from which an add-in wants to access data. + * + * @remarks + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose, Read + * + * **Important**: This enum is only supported in Outlook on Android and on iOS starting in Version 4.2443.0. To learn more about APIs supported in Outlook on mobile devices, see + * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}. + */ + enum OpenLocation { + /** + * A location associated with an account within an add-in. + */ + AccountDocument, + /** + * The device's camera. + */ + Camera, + /** + * Local storage on a device. + */ + Local, + /** + * OneDrive for Business. + * + * **Important**: For OneDrive Personal, use OTHER. + */ + OnedriveForBusiness, + /** + * Other cloud storage providers, including OneDrive Personal. + */ + Other, + /** + * The device's photo library. + */ + PhotoLibrary, + /** + * SharePoint. Includes both SharePoint Online and SharePoint on-premises (if accessed with a Microsoft Entra ID account). + */ + SharePoint + } /** * Represents the current view of Outlook on the web. */ @@ -1248,6 +1290,56 @@ export declare namespace Office { */ Beta = "beta" } + /** + * Specifies the location in which an add-in wants to save data. + * + * @remarks + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose, Read + * + * **Important**: This enum is only supported in Outlook on Android and on iOS starting in Version 4.2443.0. To learn more about APIs supported in Outlook on mobile devices, see + * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}. + */ + enum SaveLocation { + /** + * A location associated with an account within an add-in. + */ + AccountDocument, + /** + * Box. + */ + Box, + /** + * Dropbox. + */ + Dropbox, + /** + * Google Drive. + */ + GoogleDrive, + /** + * Local storage on a device. + */ + Local, + /** + * OneDrive for Business. + * + * **Important**: For OneDrive Personal, use OTHER. + */ + OnedriveForBusiness, + /** + * Other cloud storage providers, including OneDrive Personal. + */ + Other, + /** + * The device's photo library. + */ + PhotoLibrary, + /** + * SharePoint. Includes both SharePoint Online and SharePoint on-premises (if accessed with a Microsoft Entra ID account). + */ + SharePoint + } /** * Specifies the source of the selected data in an item (see `Office.mailbox.item.getSelectedDataAsync` for details). @@ -6539,6 +6631,73 @@ export declare namespace Office { * @param userContext - Optional. Any state data that is passed to the asynchronous method. */ getCallbackTokenAsync(callback: (asyncResult: CommonAPI.AsyncResult) => void, userContext?: any): void; + /** + * Returns true if the current mailbox is managed by {@link https://learn.microsoft.com/mem/intune/fundamentals/what-is-intune | Microsoft Intune}. + * + * @remarks + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item** + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose, Read + * + * **Important**: This method is only supported in Outlook on Android and on iOS starting in Version 4.2443.0.To learn more about APIs supported in Outlook on mobile devices, see + * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}. + * + * **Errors**: + * + * - `MAMServiceNotAvailable`: The client is unable to fetch the mobile application management (MAM) policy. + * + * @returns True if the current mailbox is managed by Microsoft Intune. + */ + getIsIdentityManaged(): boolean; + /** + * Returns true if an organization's {@link https://learn.microsoft.com/mem/intune/apps/app-management | Intune mobile application management (MAM) policy} + * allows an add-in to access data from the specified location. + * + * @remarks + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item** + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose, Read + * + * **Important**: This method is only supported in Outlook on Android and on iOS starting in Version 4.2443.0. To learn more about APIs supported in Outlook on mobile devices, see + * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}. + * + * **Errors**: + * + * - `InvalidOpenLocationInput`: The value of the specified location is invalid. + * + * - `MAMServiceNotAvailable`: The client is unable to fetch the MAM policy. + * + * @param openLocation - The location from which the add-in is attempting to access data. + * + * @returns True if an organization's Intune MAM policy allows an add-in to access data from the specified location. + */ + getIsOpenFromLocationAllowed(openLocation: MailboxEnums.OpenLocation): boolean; + /** + * Returns true if an organization's {@link https://learn.microsoft.com/mem/intune/apps/app-management | Intune mobile application management (MAM) policy} + * allows an add-in to save data to the specified location. + * + * @remarks + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item** + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose, Read + * + * **Important**: This method is only supported in Outlook on Android and on iOS starting in Version 4.2443.0. To learn more about APIs supported in Outlook on mobile devices, see + * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}. + * + * **Errors**: + * + * - `InvalidSaveLocationInput`: The value of the specified location is invalid. + * + * - `MAMServiceNotAvailable`: The client is unable to fetch the MAM policy. + * + * @param saveLocation - The location in which the add-in is attempting to save data. + * + * @returns True if an organization's Intune MAM policy allows an add-in to save data to the specified location. + */ + getIsSaveToLocationAllowed(saveLocation: MailboxEnums.SaveLocation): boolean; /** diff --git a/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_12/outlook.d.ts b/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_12/outlook.d.ts index b1bcee7abf..5d92944908 100644 --- a/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_12/outlook.d.ts +++ b/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_12/outlook.d.ts @@ -542,6 +542,48 @@ export declare namespace Office { Dec = "dec" } + /** + * Specifies the location from which an add-in wants to access data. + * + * @remarks + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose, Read + * + * **Important**: This enum is only supported in Outlook on Android and on iOS starting in Version 4.2443.0. To learn more about APIs supported in Outlook on mobile devices, see + * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}. + */ + enum OpenLocation { + /** + * A location associated with an account within an add-in. + */ + AccountDocument, + /** + * The device's camera. + */ + Camera, + /** + * Local storage on a device. + */ + Local, + /** + * OneDrive for Business. + * + * **Important**: For OneDrive Personal, use OTHER. + */ + OnedriveForBusiness, + /** + * Other cloud storage providers, including OneDrive Personal. + */ + Other, + /** + * The device's photo library. + */ + PhotoLibrary, + /** + * SharePoint. Includes both SharePoint Online and SharePoint on-premises (if accessed with a Microsoft Entra ID account). + */ + SharePoint + } /** * Represents the current view of Outlook on the web. */ @@ -1248,6 +1290,56 @@ export declare namespace Office { */ Beta = "beta" } + /** + * Specifies the location in which an add-in wants to save data. + * + * @remarks + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose, Read + * + * **Important**: This enum is only supported in Outlook on Android and on iOS starting in Version 4.2443.0. To learn more about APIs supported in Outlook on mobile devices, see + * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}. + */ + enum SaveLocation { + /** + * A location associated with an account within an add-in. + */ + AccountDocument, + /** + * Box. + */ + Box, + /** + * Dropbox. + */ + Dropbox, + /** + * Google Drive. + */ + GoogleDrive, + /** + * Local storage on a device. + */ + Local, + /** + * OneDrive for Business. + * + * **Important**: For OneDrive Personal, use OTHER. + */ + OnedriveForBusiness, + /** + * Other cloud storage providers, including OneDrive Personal. + */ + Other, + /** + * The device's photo library. + */ + PhotoLibrary, + /** + * SharePoint. Includes both SharePoint Online and SharePoint on-premises (if accessed with a Microsoft Entra ID account). + */ + SharePoint + } /** * Specifies the source of the selected data in an item (see `Office.mailbox.item.getSelectedDataAsync` for details). @@ -6539,6 +6631,73 @@ export declare namespace Office { * @param userContext - Optional. Any state data that is passed to the asynchronous method. */ getCallbackTokenAsync(callback: (asyncResult: CommonAPI.AsyncResult) => void, userContext?: any): void; + /** + * Returns true if the current mailbox is managed by {@link https://learn.microsoft.com/mem/intune/fundamentals/what-is-intune | Microsoft Intune}. + * + * @remarks + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item** + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose, Read + * + * **Important**: This method is only supported in Outlook on Android and on iOS starting in Version 4.2443.0.To learn more about APIs supported in Outlook on mobile devices, see + * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}. + * + * **Errors**: + * + * - `MAMServiceNotAvailable`: The client is unable to fetch the mobile application management (MAM) policy. + * + * @returns True if the current mailbox is managed by Microsoft Intune. + */ + getIsIdentityManaged(): boolean; + /** + * Returns true if an organization's {@link https://learn.microsoft.com/mem/intune/apps/app-management | Intune mobile application management (MAM) policy} + * allows an add-in to access data from the specified location. + * + * @remarks + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item** + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose, Read + * + * **Important**: This method is only supported in Outlook on Android and on iOS starting in Version 4.2443.0. To learn more about APIs supported in Outlook on mobile devices, see + * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}. + * + * **Errors**: + * + * - `InvalidOpenLocationInput`: The value of the specified location is invalid. + * + * - `MAMServiceNotAvailable`: The client is unable to fetch the MAM policy. + * + * @param openLocation - The location from which the add-in is attempting to access data. + * + * @returns True if an organization's Intune MAM policy allows an add-in to access data from the specified location. + */ + getIsOpenFromLocationAllowed(openLocation: MailboxEnums.OpenLocation): boolean; + /** + * Returns true if an organization's {@link https://learn.microsoft.com/mem/intune/apps/app-management | Intune mobile application management (MAM) policy} + * allows an add-in to save data to the specified location. + * + * @remarks + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item** + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose, Read + * + * **Important**: This method is only supported in Outlook on Android and on iOS starting in Version 4.2443.0. To learn more about APIs supported in Outlook on mobile devices, see + * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}. + * + * **Errors**: + * + * - `InvalidSaveLocationInput`: The value of the specified location is invalid. + * + * - `MAMServiceNotAvailable`: The client is unable to fetch the MAM policy. + * + * @param saveLocation - The location in which the add-in is attempting to save data. + * + * @returns True if an organization's Intune MAM policy allows an add-in to save data to the specified location. + */ + getIsSaveToLocationAllowed(saveLocation: MailboxEnums.SaveLocation): boolean; /** diff --git a/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_13/outlook.d.ts b/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_13/outlook.d.ts index 5097f3e494..4225c27888 100644 --- a/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_13/outlook.d.ts +++ b/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_13/outlook.d.ts @@ -542,6 +542,48 @@ export declare namespace Office { Dec = "dec" } + /** + * Specifies the location from which an add-in wants to access data. + * + * @remarks + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose, Read + * + * **Important**: This enum is only supported in Outlook on Android and on iOS starting in Version 4.2443.0. To learn more about APIs supported in Outlook on mobile devices, see + * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}. + */ + enum OpenLocation { + /** + * A location associated with an account within an add-in. + */ + AccountDocument, + /** + * The device's camera. + */ + Camera, + /** + * Local storage on a device. + */ + Local, + /** + * OneDrive for Business. + * + * **Important**: For OneDrive Personal, use OTHER. + */ + OnedriveForBusiness, + /** + * Other cloud storage providers, including OneDrive Personal. + */ + Other, + /** + * The device's photo library. + */ + PhotoLibrary, + /** + * SharePoint. Includes both SharePoint Online and SharePoint on-premises (if accessed with a Microsoft Entra ID account). + */ + SharePoint + } /** * Represents the current view of Outlook on the web. */ @@ -1248,6 +1290,56 @@ export declare namespace Office { */ Beta = "beta" } + /** + * Specifies the location in which an add-in wants to save data. + * + * @remarks + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose, Read + * + * **Important**: This enum is only supported in Outlook on Android and on iOS starting in Version 4.2443.0. To learn more about APIs supported in Outlook on mobile devices, see + * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}. + */ + enum SaveLocation { + /** + * A location associated with an account within an add-in. + */ + AccountDocument, + /** + * Box. + */ + Box, + /** + * Dropbox. + */ + Dropbox, + /** + * Google Drive. + */ + GoogleDrive, + /** + * Local storage on a device. + */ + Local, + /** + * OneDrive for Business. + * + * **Important**: For OneDrive Personal, use OTHER. + */ + OnedriveForBusiness, + /** + * Other cloud storage providers, including OneDrive Personal. + */ + Other, + /** + * The device's photo library. + */ + PhotoLibrary, + /** + * SharePoint. Includes both SharePoint Online and SharePoint on-premises (if accessed with a Microsoft Entra ID account). + */ + SharePoint + } /** * Specifies the source of the selected data in an item (see `Office.mailbox.item.getSelectedDataAsync` for details). @@ -6738,6 +6830,73 @@ export declare namespace Office { * @param userContext - Optional. Any state data that is passed to the asynchronous method. */ getCallbackTokenAsync(callback: (asyncResult: CommonAPI.AsyncResult) => void, userContext?: any): void; + /** + * Returns true if the current mailbox is managed by {@link https://learn.microsoft.com/mem/intune/fundamentals/what-is-intune | Microsoft Intune}. + * + * @remarks + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item** + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose, Read + * + * **Important**: This method is only supported in Outlook on Android and on iOS starting in Version 4.2443.0.To learn more about APIs supported in Outlook on mobile devices, see + * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}. + * + * **Errors**: + * + * - `MAMServiceNotAvailable`: The client is unable to fetch the mobile application management (MAM) policy. + * + * @returns True if the current mailbox is managed by Microsoft Intune. + */ + getIsIdentityManaged(): boolean; + /** + * Returns true if an organization's {@link https://learn.microsoft.com/mem/intune/apps/app-management | Intune mobile application management (MAM) policy} + * allows an add-in to access data from the specified location. + * + * @remarks + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item** + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose, Read + * + * **Important**: This method is only supported in Outlook on Android and on iOS starting in Version 4.2443.0. To learn more about APIs supported in Outlook on mobile devices, see + * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}. + * + * **Errors**: + * + * - `InvalidOpenLocationInput`: The value of the specified location is invalid. + * + * - `MAMServiceNotAvailable`: The client is unable to fetch the MAM policy. + * + * @param openLocation - The location from which the add-in is attempting to access data. + * + * @returns True if an organization's Intune MAM policy allows an add-in to access data from the specified location. + */ + getIsOpenFromLocationAllowed(openLocation: MailboxEnums.OpenLocation): boolean; + /** + * Returns true if an organization's {@link https://learn.microsoft.com/mem/intune/apps/app-management | Intune mobile application management (MAM) policy} + * allows an add-in to save data to the specified location. + * + * @remarks + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item** + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose, Read + * + * **Important**: This method is only supported in Outlook on Android and on iOS starting in Version 4.2443.0. To learn more about APIs supported in Outlook on mobile devices, see + * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}. + * + * **Errors**: + * + * - `InvalidSaveLocationInput`: The value of the specified location is invalid. + * + * - `MAMServiceNotAvailable`: The client is unable to fetch the MAM policy. + * + * @param saveLocation - The location in which the add-in is attempting to save data. + * + * @returns True if an organization's Intune MAM policy allows an add-in to save data to the specified location. + */ + getIsSaveToLocationAllowed(saveLocation: MailboxEnums.SaveLocation): boolean; /** * Gets currently selected messages on which an add-in can activate and perform operations. An add-in can activate on a maximum of 100 messages at a time. * To learn more about item multi-select, see diff --git a/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_14/outlook.d.ts b/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_14/outlook.d.ts index 702b688665..b762982a89 100644 --- a/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_14/outlook.d.ts +++ b/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_14/outlook.d.ts @@ -587,9 +587,9 @@ export declare namespace Office { * method. If you're on an Outlook on Windows version that only supports the `postProcessingAction` property, * you must assign it different string values. For a list of supported string values, see * {@link https://learn.microsoft.com/javascript/api/outlook/office.spamreportingeventcompletedoptions#outlook-office-spamreportingeventcompletedoptions-postprocessingaction-member | - * Office.SpamReportingEventCompletedOptions.postProcessingAction}. - */ - enum MoveSpamItemTo { + * Office.SpamReportingEventCompletedOptions.postProcessingAction}. + */ + enum MoveSpamItemTo { /** * Specifies that a reported message is moved to a custom folder in the mailbox. */ @@ -606,7 +606,49 @@ export declare namespace Office { * Specifies that a reported message remains in its current folder in the mailbox. */ NoMove = "noMove" - } + } + /** + * Specifies the location from which an add-in wants to access data. + * + * @remarks + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose, Read + * + * **Important**: This enum is only supported in Outlook on Android and on iOS starting in Version 4.2443.0. To learn more about APIs supported in Outlook on mobile devices, see + * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}. + */ + enum OpenLocation { + /** + * A location associated with an account within an add-in. + */ + AccountDocument, + /** + * The device's camera. + */ + Camera, + /** + * Local storage on a device. + */ + Local, + /** + * OneDrive for Business. + * + * **Important**: For OneDrive Personal, use OTHER. + */ + OnedriveForBusiness, + /** + * Other cloud storage providers, including OneDrive Personal. + */ + Other, + /** + * The device's photo library. + */ + PhotoLibrary, + /** + * SharePoint. Includes both SharePoint Online and SharePoint on-premises (if accessed with a Microsoft Entra ID account). + */ + SharePoint + } /** * Represents the current view of Outlook on the web. */ @@ -1313,6 +1355,56 @@ export declare namespace Office { */ Beta = "beta" } + /** + * Specifies the location in which an add-in wants to save data. + * + * @remarks + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose, Read + * + * **Important**: This enum is only supported in Outlook on Android and on iOS starting in Version 4.2443.0. To learn more about APIs supported in Outlook on mobile devices, see + * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}. + */ + enum SaveLocation { + /** + * A location associated with an account within an add-in. + */ + AccountDocument, + /** + * Box. + */ + Box, + /** + * Dropbox. + */ + Dropbox, + /** + * Google Drive. + */ + GoogleDrive, + /** + * Local storage on a device. + */ + Local, + /** + * OneDrive for Business. + * + * **Important**: For OneDrive Personal, use OTHER. + */ + OnedriveForBusiness, + /** + * Other cloud storage providers, including OneDrive Personal. + */ + Other, + /** + * The device's photo library. + */ + PhotoLibrary, + /** + * SharePoint. Includes both SharePoint Online and SharePoint on-premises (if accessed with a Microsoft Entra ID account). + */ + SharePoint + } /** * Specifies the {@link https://learn.microsoft.com/office/dev/add-ins/outlook/onmessagesend-onappointmentsend-events#available-send-mode-options | send mode option} * that overrides the option set in the manifest at runtime. @@ -6849,6 +6941,73 @@ export declare namespace Office { * @param userContext - Optional. Any state data that is passed to the asynchronous method. */ getCallbackTokenAsync(callback: (asyncResult: CommonAPI.AsyncResult) => void, userContext?: any): void; + /** + * Returns true if the current mailbox is managed by {@link https://learn.microsoft.com/mem/intune/fundamentals/what-is-intune | Microsoft Intune}. + * + * @remarks + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item** + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose, Read + * + * **Important**: This method is only supported in Outlook on Android and on iOS starting in Version 4.2443.0.To learn more about APIs supported in Outlook on mobile devices, see + * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}. + * + * **Errors**: + * + * - `MAMServiceNotAvailable`: The client is unable to fetch the mobile application management (MAM) policy. + * + * @returns True if the current mailbox is managed by Microsoft Intune. + */ + getIsIdentityManaged(): boolean; + /** + * Returns true if an organization's {@link https://learn.microsoft.com/mem/intune/apps/app-management | Intune mobile application management (MAM) policy} + * allows an add-in to access data from the specified location. + * + * @remarks + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item** + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose, Read + * + * **Important**: This method is only supported in Outlook on Android and on iOS starting in Version 4.2443.0. To learn more about APIs supported in Outlook on mobile devices, see + * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}. + * + * **Errors**: + * + * - `InvalidOpenLocationInput`: The value of the specified location is invalid. + * + * - `MAMServiceNotAvailable`: The client is unable to fetch the MAM policy. + * + * @param openLocation - The location from which the add-in is attempting to access data. + * + * @returns True if an organization's Intune MAM policy allows an add-in to access data from the specified location. + */ + getIsOpenFromLocationAllowed(openLocation: MailboxEnums.OpenLocation): boolean; + /** + * Returns true if an organization's {@link https://learn.microsoft.com/mem/intune/apps/app-management | Intune mobile application management (MAM) policy} + * allows an add-in to save data to the specified location. + * + * @remarks + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item** + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose, Read + * + * **Important**: This method is only supported in Outlook on Android and on iOS starting in Version 4.2443.0. To learn more about APIs supported in Outlook on mobile devices, see + * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}. + * + * **Errors**: + * + * - `InvalidSaveLocationInput`: The value of the specified location is invalid. + * + * - `MAMServiceNotAvailable`: The client is unable to fetch the MAM policy. + * + * @param saveLocation - The location in which the add-in is attempting to save data. + * + * @returns True if an organization's Intune MAM policy allows an add-in to save data to the specified location. + */ + getIsSaveToLocationAllowed(saveLocation: MailboxEnums.SaveLocation): boolean; /** * Gets currently selected messages on which an add-in can activate and perform operations. An add-in can activate on a maximum of 100 messages at a time. * To learn more about item multi-select, see diff --git a/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_2/Outlook.d.ts b/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_2/Outlook.d.ts index 89b4820f30..14c9a8a66f 100644 --- a/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_2/Outlook.d.ts +++ b/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_2/Outlook.d.ts @@ -107,6 +107,48 @@ export declare namespace Office { + /** + * Specifies the location from which an add-in wants to access data. + * + * @remarks + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose, Read + * + * **Important**: This enum is only supported in Outlook on Android and on iOS starting in Version 4.2443.0. To learn more about APIs supported in Outlook on mobile devices, see + * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}. + */ + enum OpenLocation { + /** + * A location associated with an account within an add-in. + */ + AccountDocument, + /** + * The device's camera. + */ + Camera, + /** + * Local storage on a device. + */ + Local, + /** + * OneDrive for Business. + * + * **Important**: For OneDrive Personal, use OTHER. + */ + OnedriveForBusiness, + /** + * Other cloud storage providers, including OneDrive Personal. + */ + Other, + /** + * The device's photo library. + */ + PhotoLibrary, + /** + * SharePoint. Includes both SharePoint Online and SharePoint on-premises (if accessed with a Microsoft Entra ID account). + */ + SharePoint + } /** * Represents the current view of Outlook on the web. */ @@ -204,6 +246,56 @@ export declare namespace Office { Declined = "declined" } + /** + * Specifies the location in which an add-in wants to save data. + * + * @remarks + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose, Read + * + * **Important**: This enum is only supported in Outlook on Android and on iOS starting in Version 4.2443.0. To learn more about APIs supported in Outlook on mobile devices, see + * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}. + */ + enum SaveLocation { + /** + * A location associated with an account within an add-in. + */ + AccountDocument, + /** + * Box. + */ + Box, + /** + * Dropbox. + */ + Dropbox, + /** + * Google Drive. + */ + GoogleDrive, + /** + * Local storage on a device. + */ + Local, + /** + * OneDrive for Business. + * + * **Important**: For OneDrive Personal, use OTHER. + */ + OnedriveForBusiness, + /** + * Other cloud storage providers, including OneDrive Personal. + */ + Other, + /** + * The device's photo library. + */ + PhotoLibrary, + /** + * SharePoint. Includes both SharePoint Online and SharePoint on-premises (if accessed with a Microsoft Entra ID account). + */ + SharePoint + } /** * Specifies the source of the selected data in an item (see `Office.mailbox.item.getSelectedDataAsync` for details). @@ -2686,6 +2778,73 @@ export declare namespace Office { * @param userContext - Optional. Any state data that is passed to the asynchronous method. */ getCallbackTokenAsync(callback: (asyncResult: CommonAPI.AsyncResult) => void, userContext?: any): void; + /** + * Returns true if the current mailbox is managed by {@link https://learn.microsoft.com/mem/intune/fundamentals/what-is-intune | Microsoft Intune}. + * + * @remarks + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item** + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose, Read + * + * **Important**: This method is only supported in Outlook on Android and on iOS starting in Version 4.2443.0.To learn more about APIs supported in Outlook on mobile devices, see + * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}. + * + * **Errors**: + * + * - `MAMServiceNotAvailable`: The client is unable to fetch the mobile application management (MAM) policy. + * + * @returns True if the current mailbox is managed by Microsoft Intune. + */ + getIsIdentityManaged(): boolean; + /** + * Returns true if an organization's {@link https://learn.microsoft.com/mem/intune/apps/app-management | Intune mobile application management (MAM) policy} + * allows an add-in to access data from the specified location. + * + * @remarks + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item** + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose, Read + * + * **Important**: This method is only supported in Outlook on Android and on iOS starting in Version 4.2443.0. To learn more about APIs supported in Outlook on mobile devices, see + * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}. + * + * **Errors**: + * + * - `InvalidOpenLocationInput`: The value of the specified location is invalid. + * + * - `MAMServiceNotAvailable`: The client is unable to fetch the MAM policy. + * + * @param openLocation - The location from which the add-in is attempting to access data. + * + * @returns True if an organization's Intune MAM policy allows an add-in to access data from the specified location. + */ + getIsOpenFromLocationAllowed(openLocation: MailboxEnums.OpenLocation): boolean; + /** + * Returns true if an organization's {@link https://learn.microsoft.com/mem/intune/apps/app-management | Intune mobile application management (MAM) policy} + * allows an add-in to save data to the specified location. + * + * @remarks + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item** + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose, Read + * + * **Important**: This method is only supported in Outlook on Android and on iOS starting in Version 4.2443.0. To learn more about APIs supported in Outlook on mobile devices, see + * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}. + * + * **Errors**: + * + * - `InvalidSaveLocationInput`: The value of the specified location is invalid. + * + * - `MAMServiceNotAvailable`: The client is unable to fetch the MAM policy. + * + * @param saveLocation - The location in which the add-in is attempting to save data. + * + * @returns True if an organization's Intune MAM policy allows an add-in to save data to the specified location. + */ + getIsSaveToLocationAllowed(saveLocation: MailboxEnums.SaveLocation): boolean; /** diff --git a/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_3/Outlook.d.ts b/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_3/Outlook.d.ts index 8163949daa..b8fa889c13 100644 --- a/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_3/Outlook.d.ts +++ b/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_3/Outlook.d.ts @@ -130,6 +130,48 @@ export declare namespace Office { + /** + * Specifies the location from which an add-in wants to access data. + * + * @remarks + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose, Read + * + * **Important**: This enum is only supported in Outlook on Android and on iOS starting in Version 4.2443.0. To learn more about APIs supported in Outlook on mobile devices, see + * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}. + */ + enum OpenLocation { + /** + * A location associated with an account within an add-in. + */ + AccountDocument, + /** + * The device's camera. + */ + Camera, + /** + * Local storage on a device. + */ + Local, + /** + * OneDrive for Business. + * + * **Important**: For OneDrive Personal, use OTHER. + */ + OnedriveForBusiness, + /** + * Other cloud storage providers, including OneDrive Personal. + */ + Other, + /** + * The device's photo library. + */ + PhotoLibrary, + /** + * SharePoint. Includes both SharePoint Online and SharePoint on-premises (if accessed with a Microsoft Entra ID account). + */ + SharePoint + } /** * Represents the current view of Outlook on the web. */ @@ -254,6 +296,56 @@ export declare namespace Office { */ Beta = "beta" } + /** + * Specifies the location in which an add-in wants to save data. + * + * @remarks + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose, Read + * + * **Important**: This enum is only supported in Outlook on Android and on iOS starting in Version 4.2443.0. To learn more about APIs supported in Outlook on mobile devices, see + * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}. + */ + enum SaveLocation { + /** + * A location associated with an account within an add-in. + */ + AccountDocument, + /** + * Box. + */ + Box, + /** + * Dropbox. + */ + Dropbox, + /** + * Google Drive. + */ + GoogleDrive, + /** + * Local storage on a device. + */ + Local, + /** + * OneDrive for Business. + * + * **Important**: For OneDrive Personal, use OTHER. + */ + OnedriveForBusiness, + /** + * Other cloud storage providers, including OneDrive Personal. + */ + Other, + /** + * The device's photo library. + */ + PhotoLibrary, + /** + * SharePoint. Includes both SharePoint Online and SharePoint on-premises (if accessed with a Microsoft Entra ID account). + */ + SharePoint + } /** * Specifies the source of the selected data in an item (see `Office.mailbox.item.getSelectedDataAsync` for details). @@ -3064,6 +3156,73 @@ export declare namespace Office { * @param userContext - Optional. Any state data that is passed to the asynchronous method. */ getCallbackTokenAsync(callback: (asyncResult: CommonAPI.AsyncResult) => void, userContext?: any): void; + /** + * Returns true if the current mailbox is managed by {@link https://learn.microsoft.com/mem/intune/fundamentals/what-is-intune | Microsoft Intune}. + * + * @remarks + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item** + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose, Read + * + * **Important**: This method is only supported in Outlook on Android and on iOS starting in Version 4.2443.0.To learn more about APIs supported in Outlook on mobile devices, see + * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}. + * + * **Errors**: + * + * - `MAMServiceNotAvailable`: The client is unable to fetch the mobile application management (MAM) policy. + * + * @returns True if the current mailbox is managed by Microsoft Intune. + */ + getIsIdentityManaged(): boolean; + /** + * Returns true if an organization's {@link https://learn.microsoft.com/mem/intune/apps/app-management | Intune mobile application management (MAM) policy} + * allows an add-in to access data from the specified location. + * + * @remarks + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item** + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose, Read + * + * **Important**: This method is only supported in Outlook on Android and on iOS starting in Version 4.2443.0. To learn more about APIs supported in Outlook on mobile devices, see + * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}. + * + * **Errors**: + * + * - `InvalidOpenLocationInput`: The value of the specified location is invalid. + * + * - `MAMServiceNotAvailable`: The client is unable to fetch the MAM policy. + * + * @param openLocation - The location from which the add-in is attempting to access data. + * + * @returns True if an organization's Intune MAM policy allows an add-in to access data from the specified location. + */ + getIsOpenFromLocationAllowed(openLocation: MailboxEnums.OpenLocation): boolean; + /** + * Returns true if an organization's {@link https://learn.microsoft.com/mem/intune/apps/app-management | Intune mobile application management (MAM) policy} + * allows an add-in to save data to the specified location. + * + * @remarks + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item** + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose, Read + * + * **Important**: This method is only supported in Outlook on Android and on iOS starting in Version 4.2443.0. To learn more about APIs supported in Outlook on mobile devices, see + * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}. + * + * **Errors**: + * + * - `InvalidSaveLocationInput`: The value of the specified location is invalid. + * + * - `MAMServiceNotAvailable`: The client is unable to fetch the MAM policy. + * + * @param saveLocation - The location in which the add-in is attempting to save data. + * + * @returns True if an organization's Intune MAM policy allows an add-in to save data to the specified location. + */ + getIsSaveToLocationAllowed(saveLocation: MailboxEnums.SaveLocation): boolean; /** diff --git a/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_4/Outlook.d.ts b/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_4/Outlook.d.ts index 003210542e..6b63f77c43 100644 --- a/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_4/Outlook.d.ts +++ b/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_4/Outlook.d.ts @@ -130,6 +130,48 @@ export declare namespace Office { + /** + * Specifies the location from which an add-in wants to access data. + * + * @remarks + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose, Read + * + * **Important**: This enum is only supported in Outlook on Android and on iOS starting in Version 4.2443.0. To learn more about APIs supported in Outlook on mobile devices, see + * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}. + */ + enum OpenLocation { + /** + * A location associated with an account within an add-in. + */ + AccountDocument, + /** + * The device's camera. + */ + Camera, + /** + * Local storage on a device. + */ + Local, + /** + * OneDrive for Business. + * + * **Important**: For OneDrive Personal, use OTHER. + */ + OnedriveForBusiness, + /** + * Other cloud storage providers, including OneDrive Personal. + */ + Other, + /** + * The device's photo library. + */ + PhotoLibrary, + /** + * SharePoint. Includes both SharePoint Online and SharePoint on-premises (if accessed with a Microsoft Entra ID account). + */ + SharePoint + } /** * Represents the current view of Outlook on the web. */ @@ -254,6 +296,56 @@ export declare namespace Office { */ Beta = "beta" } + /** + * Specifies the location in which an add-in wants to save data. + * + * @remarks + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose, Read + * + * **Important**: This enum is only supported in Outlook on Android and on iOS starting in Version 4.2443.0. To learn more about APIs supported in Outlook on mobile devices, see + * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}. + */ + enum SaveLocation { + /** + * A location associated with an account within an add-in. + */ + AccountDocument, + /** + * Box. + */ + Box, + /** + * Dropbox. + */ + Dropbox, + /** + * Google Drive. + */ + GoogleDrive, + /** + * Local storage on a device. + */ + Local, + /** + * OneDrive for Business. + * + * **Important**: For OneDrive Personal, use OTHER. + */ + OnedriveForBusiness, + /** + * Other cloud storage providers, including OneDrive Personal. + */ + Other, + /** + * The device's photo library. + */ + PhotoLibrary, + /** + * SharePoint. Includes both SharePoint Online and SharePoint on-premises (if accessed with a Microsoft Entra ID account). + */ + SharePoint + } /** * Specifies the source of the selected data in an item (see `Office.mailbox.item.getSelectedDataAsync` for details). @@ -3064,6 +3156,73 @@ export declare namespace Office { * @param userContext - Optional. Any state data that is passed to the asynchronous method. */ getCallbackTokenAsync(callback: (asyncResult: CommonAPI.AsyncResult) => void, userContext?: any): void; + /** + * Returns true if the current mailbox is managed by {@link https://learn.microsoft.com/mem/intune/fundamentals/what-is-intune | Microsoft Intune}. + * + * @remarks + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item** + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose, Read + * + * **Important**: This method is only supported in Outlook on Android and on iOS starting in Version 4.2443.0.To learn more about APIs supported in Outlook on mobile devices, see + * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}. + * + * **Errors**: + * + * - `MAMServiceNotAvailable`: The client is unable to fetch the mobile application management (MAM) policy. + * + * @returns True if the current mailbox is managed by Microsoft Intune. + */ + getIsIdentityManaged(): boolean; + /** + * Returns true if an organization's {@link https://learn.microsoft.com/mem/intune/apps/app-management | Intune mobile application management (MAM) policy} + * allows an add-in to access data from the specified location. + * + * @remarks + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item** + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose, Read + * + * **Important**: This method is only supported in Outlook on Android and on iOS starting in Version 4.2443.0. To learn more about APIs supported in Outlook on mobile devices, see + * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}. + * + * **Errors**: + * + * - `InvalidOpenLocationInput`: The value of the specified location is invalid. + * + * - `MAMServiceNotAvailable`: The client is unable to fetch the MAM policy. + * + * @param openLocation - The location from which the add-in is attempting to access data. + * + * @returns True if an organization's Intune MAM policy allows an add-in to access data from the specified location. + */ + getIsOpenFromLocationAllowed(openLocation: MailboxEnums.OpenLocation): boolean; + /** + * Returns true if an organization's {@link https://learn.microsoft.com/mem/intune/apps/app-management | Intune mobile application management (MAM) policy} + * allows an add-in to save data to the specified location. + * + * @remarks + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item** + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose, Read + * + * **Important**: This method is only supported in Outlook on Android and on iOS starting in Version 4.2443.0. To learn more about APIs supported in Outlook on mobile devices, see + * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}. + * + * **Errors**: + * + * - `InvalidSaveLocationInput`: The value of the specified location is invalid. + * + * - `MAMServiceNotAvailable`: The client is unable to fetch the MAM policy. + * + * @param saveLocation - The location in which the add-in is attempting to save data. + * + * @returns True if an organization's Intune MAM policy allows an add-in to save data to the specified location. + */ + getIsSaveToLocationAllowed(saveLocation: MailboxEnums.SaveLocation): boolean; /** diff --git a/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_5/Outlook.d.ts b/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_5/Outlook.d.ts index 833ef87606..96bbfe3cc6 100644 --- a/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_5/Outlook.d.ts +++ b/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_5/Outlook.d.ts @@ -130,6 +130,48 @@ export declare namespace Office { + /** + * Specifies the location from which an add-in wants to access data. + * + * @remarks + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose, Read + * + * **Important**: This enum is only supported in Outlook on Android and on iOS starting in Version 4.2443.0. To learn more about APIs supported in Outlook on mobile devices, see + * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}. + */ + enum OpenLocation { + /** + * A location associated with an account within an add-in. + */ + AccountDocument, + /** + * The device's camera. + */ + Camera, + /** + * Local storage on a device. + */ + Local, + /** + * OneDrive for Business. + * + * **Important**: For OneDrive Personal, use OTHER. + */ + OnedriveForBusiness, + /** + * Other cloud storage providers, including OneDrive Personal. + */ + Other, + /** + * The device's photo library. + */ + PhotoLibrary, + /** + * SharePoint. Includes both SharePoint Online and SharePoint on-premises (if accessed with a Microsoft Entra ID account). + */ + SharePoint + } /** * Represents the current view of Outlook on the web. */ @@ -254,6 +296,56 @@ export declare namespace Office { */ Beta = "beta" } + /** + * Specifies the location in which an add-in wants to save data. + * + * @remarks + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose, Read + * + * **Important**: This enum is only supported in Outlook on Android and on iOS starting in Version 4.2443.0. To learn more about APIs supported in Outlook on mobile devices, see + * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}. + */ + enum SaveLocation { + /** + * A location associated with an account within an add-in. + */ + AccountDocument, + /** + * Box. + */ + Box, + /** + * Dropbox. + */ + Dropbox, + /** + * Google Drive. + */ + GoogleDrive, + /** + * Local storage on a device. + */ + Local, + /** + * OneDrive for Business. + * + * **Important**: For OneDrive Personal, use OTHER. + */ + OnedriveForBusiness, + /** + * Other cloud storage providers, including OneDrive Personal. + */ + Other, + /** + * The device's photo library. + */ + PhotoLibrary, + /** + * SharePoint. Includes both SharePoint Online and SharePoint on-premises (if accessed with a Microsoft Entra ID account). + */ + SharePoint + } /** * Specifies the source of the selected data in an item (see `Office.mailbox.item.getSelectedDataAsync` for details). @@ -3225,6 +3317,73 @@ export declare namespace Office { * @param userContext - Optional. Any state data that is passed to the asynchronous method. */ getCallbackTokenAsync(callback: (asyncResult: CommonAPI.AsyncResult) => void, userContext?: any): void; + /** + * Returns true if the current mailbox is managed by {@link https://learn.microsoft.com/mem/intune/fundamentals/what-is-intune | Microsoft Intune}. + * + * @remarks + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item** + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose, Read + * + * **Important**: This method is only supported in Outlook on Android and on iOS starting in Version 4.2443.0.To learn more about APIs supported in Outlook on mobile devices, see + * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}. + * + * **Errors**: + * + * - `MAMServiceNotAvailable`: The client is unable to fetch the mobile application management (MAM) policy. + * + * @returns True if the current mailbox is managed by Microsoft Intune. + */ + getIsIdentityManaged(): boolean; + /** + * Returns true if an organization's {@link https://learn.microsoft.com/mem/intune/apps/app-management | Intune mobile application management (MAM) policy} + * allows an add-in to access data from the specified location. + * + * @remarks + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item** + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose, Read + * + * **Important**: This method is only supported in Outlook on Android and on iOS starting in Version 4.2443.0. To learn more about APIs supported in Outlook on mobile devices, see + * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}. + * + * **Errors**: + * + * - `InvalidOpenLocationInput`: The value of the specified location is invalid. + * + * - `MAMServiceNotAvailable`: The client is unable to fetch the MAM policy. + * + * @param openLocation - The location from which the add-in is attempting to access data. + * + * @returns True if an organization's Intune MAM policy allows an add-in to access data from the specified location. + */ + getIsOpenFromLocationAllowed(openLocation: MailboxEnums.OpenLocation): boolean; + /** + * Returns true if an organization's {@link https://learn.microsoft.com/mem/intune/apps/app-management | Intune mobile application management (MAM) policy} + * allows an add-in to save data to the specified location. + * + * @remarks + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item** + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose, Read + * + * **Important**: This method is only supported in Outlook on Android and on iOS starting in Version 4.2443.0. To learn more about APIs supported in Outlook on mobile devices, see + * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}. + * + * **Errors**: + * + * - `InvalidSaveLocationInput`: The value of the specified location is invalid. + * + * - `MAMServiceNotAvailable`: The client is unable to fetch the MAM policy. + * + * @param saveLocation - The location in which the add-in is attempting to save data. + * + * @returns True if an organization's Intune MAM policy allows an add-in to save data to the specified location. + */ + getIsSaveToLocationAllowed(saveLocation: MailboxEnums.SaveLocation): boolean; /** diff --git a/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_6/Outlook.d.ts b/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_6/Outlook.d.ts index 254059325d..895ab9c4d1 100644 --- a/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_6/Outlook.d.ts +++ b/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_6/Outlook.d.ts @@ -130,6 +130,48 @@ export declare namespace Office { + /** + * Specifies the location from which an add-in wants to access data. + * + * @remarks + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose, Read + * + * **Important**: This enum is only supported in Outlook on Android and on iOS starting in Version 4.2443.0. To learn more about APIs supported in Outlook on mobile devices, see + * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}. + */ + enum OpenLocation { + /** + * A location associated with an account within an add-in. + */ + AccountDocument, + /** + * The device's camera. + */ + Camera, + /** + * Local storage on a device. + */ + Local, + /** + * OneDrive for Business. + * + * **Important**: For OneDrive Personal, use OTHER. + */ + OnedriveForBusiness, + /** + * Other cloud storage providers, including OneDrive Personal. + */ + Other, + /** + * The device's photo library. + */ + PhotoLibrary, + /** + * SharePoint. Includes both SharePoint Online and SharePoint on-premises (if accessed with a Microsoft Entra ID account). + */ + SharePoint + } /** * Represents the current view of Outlook on the web. */ @@ -254,6 +296,56 @@ export declare namespace Office { */ Beta = "beta" } + /** + * Specifies the location in which an add-in wants to save data. + * + * @remarks + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose, Read + * + * **Important**: This enum is only supported in Outlook on Android and on iOS starting in Version 4.2443.0. To learn more about APIs supported in Outlook on mobile devices, see + * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}. + */ + enum SaveLocation { + /** + * A location associated with an account within an add-in. + */ + AccountDocument, + /** + * Box. + */ + Box, + /** + * Dropbox. + */ + Dropbox, + /** + * Google Drive. + */ + GoogleDrive, + /** + * Local storage on a device. + */ + Local, + /** + * OneDrive for Business. + * + * **Important**: For OneDrive Personal, use OTHER. + */ + OnedriveForBusiness, + /** + * Other cloud storage providers, including OneDrive Personal. + */ + Other, + /** + * The device's photo library. + */ + PhotoLibrary, + /** + * SharePoint. Includes both SharePoint Online and SharePoint on-premises (if accessed with a Microsoft Entra ID account). + */ + SharePoint + } /** * Specifies the source of the selected data in an item (see `Office.mailbox.item.getSelectedDataAsync` for details). @@ -3324,6 +3416,73 @@ export declare namespace Office { * @param userContext - Optional. Any state data that is passed to the asynchronous method. */ getCallbackTokenAsync(callback: (asyncResult: CommonAPI.AsyncResult) => void, userContext?: any): void; + /** + * Returns true if the current mailbox is managed by {@link https://learn.microsoft.com/mem/intune/fundamentals/what-is-intune | Microsoft Intune}. + * + * @remarks + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item** + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose, Read + * + * **Important**: This method is only supported in Outlook on Android and on iOS starting in Version 4.2443.0.To learn more about APIs supported in Outlook on mobile devices, see + * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}. + * + * **Errors**: + * + * - `MAMServiceNotAvailable`: The client is unable to fetch the mobile application management (MAM) policy. + * + * @returns True if the current mailbox is managed by Microsoft Intune. + */ + getIsIdentityManaged(): boolean; + /** + * Returns true if an organization's {@link https://learn.microsoft.com/mem/intune/apps/app-management | Intune mobile application management (MAM) policy} + * allows an add-in to access data from the specified location. + * + * @remarks + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item** + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose, Read + * + * **Important**: This method is only supported in Outlook on Android and on iOS starting in Version 4.2443.0. To learn more about APIs supported in Outlook on mobile devices, see + * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}. + * + * **Errors**: + * + * - `InvalidOpenLocationInput`: The value of the specified location is invalid. + * + * - `MAMServiceNotAvailable`: The client is unable to fetch the MAM policy. + * + * @param openLocation - The location from which the add-in is attempting to access data. + * + * @returns True if an organization's Intune MAM policy allows an add-in to access data from the specified location. + */ + getIsOpenFromLocationAllowed(openLocation: MailboxEnums.OpenLocation): boolean; + /** + * Returns true if an organization's {@link https://learn.microsoft.com/mem/intune/apps/app-management | Intune mobile application management (MAM) policy} + * allows an add-in to save data to the specified location. + * + * @remarks + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item** + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose, Read + * + * **Important**: This method is only supported in Outlook on Android and on iOS starting in Version 4.2443.0. To learn more about APIs supported in Outlook on mobile devices, see + * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}. + * + * **Errors**: + * + * - `InvalidSaveLocationInput`: The value of the specified location is invalid. + * + * - `MAMServiceNotAvailable`: The client is unable to fetch the MAM policy. + * + * @param saveLocation - The location in which the add-in is attempting to save data. + * + * @returns True if an organization's Intune MAM policy allows an add-in to save data to the specified location. + */ + getIsSaveToLocationAllowed(saveLocation: MailboxEnums.SaveLocation): boolean; /** diff --git a/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_7/Outlook.d.ts b/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_7/Outlook.d.ts index 9b426fa9e7..60a39f217a 100644 --- a/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_7/Outlook.d.ts +++ b/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_7/Outlook.d.ts @@ -236,6 +236,48 @@ export declare namespace Office { Dec = "dec" } + /** + * Specifies the location from which an add-in wants to access data. + * + * @remarks + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose, Read + * + * **Important**: This enum is only supported in Outlook on Android and on iOS starting in Version 4.2443.0. To learn more about APIs supported in Outlook on mobile devices, see + * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}. + */ + enum OpenLocation { + /** + * A location associated with an account within an add-in. + */ + AccountDocument, + /** + * The device's camera. + */ + Camera, + /** + * Local storage on a device. + */ + Local, + /** + * OneDrive for Business. + * + * **Important**: For OneDrive Personal, use OTHER. + */ + OnedriveForBusiness, + /** + * Other cloud storage providers, including OneDrive Personal. + */ + Other, + /** + * The device's photo library. + */ + PhotoLibrary, + /** + * SharePoint. Includes both SharePoint Online and SharePoint on-premises (if accessed with a Microsoft Entra ID account). + */ + SharePoint + } /** * Represents the current view of Outlook on the web. */ @@ -942,6 +984,56 @@ export declare namespace Office { */ Beta = "beta" } + /** + * Specifies the location in which an add-in wants to save data. + * + * @remarks + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose, Read + * + * **Important**: This enum is only supported in Outlook on Android and on iOS starting in Version 4.2443.0. To learn more about APIs supported in Outlook on mobile devices, see + * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}. + */ + enum SaveLocation { + /** + * A location associated with an account within an add-in. + */ + AccountDocument, + /** + * Box. + */ + Box, + /** + * Dropbox. + */ + Dropbox, + /** + * Google Drive. + */ + GoogleDrive, + /** + * Local storage on a device. + */ + Local, + /** + * OneDrive for Business. + * + * **Important**: For OneDrive Personal, use OTHER. + */ + OnedriveForBusiness, + /** + * Other cloud storage providers, including OneDrive Personal. + */ + Other, + /** + * The device's photo library. + */ + PhotoLibrary, + /** + * SharePoint. Includes both SharePoint Online and SharePoint on-premises (if accessed with a Microsoft Entra ID account). + */ + SharePoint + } /** * Specifies the source of the selected data in an item (see `Office.mailbox.item.getSelectedDataAsync` for details). @@ -4387,6 +4479,73 @@ export declare namespace Office { * @param userContext - Optional. Any state data that is passed to the asynchronous method. */ getCallbackTokenAsync(callback: (asyncResult: CommonAPI.AsyncResult) => void, userContext?: any): void; + /** + * Returns true if the current mailbox is managed by {@link https://learn.microsoft.com/mem/intune/fundamentals/what-is-intune | Microsoft Intune}. + * + * @remarks + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item** + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose, Read + * + * **Important**: This method is only supported in Outlook on Android and on iOS starting in Version 4.2443.0.To learn more about APIs supported in Outlook on mobile devices, see + * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}. + * + * **Errors**: + * + * - `MAMServiceNotAvailable`: The client is unable to fetch the mobile application management (MAM) policy. + * + * @returns True if the current mailbox is managed by Microsoft Intune. + */ + getIsIdentityManaged(): boolean; + /** + * Returns true if an organization's {@link https://learn.microsoft.com/mem/intune/apps/app-management | Intune mobile application management (MAM) policy} + * allows an add-in to access data from the specified location. + * + * @remarks + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item** + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose, Read + * + * **Important**: This method is only supported in Outlook on Android and on iOS starting in Version 4.2443.0. To learn more about APIs supported in Outlook on mobile devices, see + * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}. + * + * **Errors**: + * + * - `InvalidOpenLocationInput`: The value of the specified location is invalid. + * + * - `MAMServiceNotAvailable`: The client is unable to fetch the MAM policy. + * + * @param openLocation - The location from which the add-in is attempting to access data. + * + * @returns True if an organization's Intune MAM policy allows an add-in to access data from the specified location. + */ + getIsOpenFromLocationAllowed(openLocation: MailboxEnums.OpenLocation): boolean; + /** + * Returns true if an organization's {@link https://learn.microsoft.com/mem/intune/apps/app-management | Intune mobile application management (MAM) policy} + * allows an add-in to save data to the specified location. + * + * @remarks + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item** + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose, Read + * + * **Important**: This method is only supported in Outlook on Android and on iOS starting in Version 4.2443.0. To learn more about APIs supported in Outlook on mobile devices, see + * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}. + * + * **Errors**: + * + * - `InvalidSaveLocationInput`: The value of the specified location is invalid. + * + * - `MAMServiceNotAvailable`: The client is unable to fetch the MAM policy. + * + * @param saveLocation - The location in which the add-in is attempting to save data. + * + * @returns True if an organization's Intune MAM policy allows an add-in to save data to the specified location. + */ + getIsSaveToLocationAllowed(saveLocation: MailboxEnums.SaveLocation): boolean; /** diff --git a/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_8/outlook.d.ts b/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_8/outlook.d.ts index 0af1902a88..4c9e3d6e7b 100644 --- a/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_8/outlook.d.ts +++ b/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_8/outlook.d.ts @@ -454,6 +454,48 @@ export declare namespace Office { Dec = "dec" } + /** + * Specifies the location from which an add-in wants to access data. + * + * @remarks + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose, Read + * + * **Important**: This enum is only supported in Outlook on Android and on iOS starting in Version 4.2443.0. To learn more about APIs supported in Outlook on mobile devices, see + * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}. + */ + enum OpenLocation { + /** + * A location associated with an account within an add-in. + */ + AccountDocument, + /** + * The device's camera. + */ + Camera, + /** + * Local storage on a device. + */ + Local, + /** + * OneDrive for Business. + * + * **Important**: For OneDrive Personal, use OTHER. + */ + OnedriveForBusiness, + /** + * Other cloud storage providers, including OneDrive Personal. + */ + Other, + /** + * The device's photo library. + */ + PhotoLibrary, + /** + * SharePoint. Includes both SharePoint Online and SharePoint on-premises (if accessed with a Microsoft Entra ID account). + */ + SharePoint + } /** * Represents the current view of Outlook on the web. */ @@ -1160,6 +1202,56 @@ export declare namespace Office { */ Beta = "beta" } + /** + * Specifies the location in which an add-in wants to save data. + * + * @remarks + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose, Read + * + * **Important**: This enum is only supported in Outlook on Android and on iOS starting in Version 4.2443.0. To learn more about APIs supported in Outlook on mobile devices, see + * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}. + */ + enum SaveLocation { + /** + * A location associated with an account within an add-in. + */ + AccountDocument, + /** + * Box. + */ + Box, + /** + * Dropbox. + */ + Dropbox, + /** + * Google Drive. + */ + GoogleDrive, + /** + * Local storage on a device. + */ + Local, + /** + * OneDrive for Business. + * + * **Important**: For OneDrive Personal, use OTHER. + */ + OnedriveForBusiness, + /** + * Other cloud storage providers, including OneDrive Personal. + */ + Other, + /** + * The device's photo library. + */ + PhotoLibrary, + /** + * SharePoint. Includes both SharePoint Online and SharePoint on-premises (if accessed with a Microsoft Entra ID account). + */ + SharePoint + } /** * Specifies the source of the selected data in an item (see `Office.mailbox.item.getSelectedDataAsync` for details). @@ -5750,6 +5842,73 @@ export declare namespace Office { * @param userContext - Optional. Any state data that is passed to the asynchronous method. */ getCallbackTokenAsync(callback: (asyncResult: CommonAPI.AsyncResult) => void, userContext?: any): void; + /** + * Returns true if the current mailbox is managed by {@link https://learn.microsoft.com/mem/intune/fundamentals/what-is-intune | Microsoft Intune}. + * + * @remarks + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item** + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose, Read + * + * **Important**: This method is only supported in Outlook on Android and on iOS starting in Version 4.2443.0.To learn more about APIs supported in Outlook on mobile devices, see + * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}. + * + * **Errors**: + * + * - `MAMServiceNotAvailable`: The client is unable to fetch the mobile application management (MAM) policy. + * + * @returns True if the current mailbox is managed by Microsoft Intune. + */ + getIsIdentityManaged(): boolean; + /** + * Returns true if an organization's {@link https://learn.microsoft.com/mem/intune/apps/app-management | Intune mobile application management (MAM) policy} + * allows an add-in to access data from the specified location. + * + * @remarks + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item** + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose, Read + * + * **Important**: This method is only supported in Outlook on Android and on iOS starting in Version 4.2443.0. To learn more about APIs supported in Outlook on mobile devices, see + * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}. + * + * **Errors**: + * + * - `InvalidOpenLocationInput`: The value of the specified location is invalid. + * + * - `MAMServiceNotAvailable`: The client is unable to fetch the MAM policy. + * + * @param openLocation - The location from which the add-in is attempting to access data. + * + * @returns True if an organization's Intune MAM policy allows an add-in to access data from the specified location. + */ + getIsOpenFromLocationAllowed(openLocation: MailboxEnums.OpenLocation): boolean; + /** + * Returns true if an organization's {@link https://learn.microsoft.com/mem/intune/apps/app-management | Intune mobile application management (MAM) policy} + * allows an add-in to save data to the specified location. + * + * @remarks + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item** + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose, Read + * + * **Important**: This method is only supported in Outlook on Android and on iOS starting in Version 4.2443.0. To learn more about APIs supported in Outlook on mobile devices, see + * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}. + * + * **Errors**: + * + * - `InvalidSaveLocationInput`: The value of the specified location is invalid. + * + * - `MAMServiceNotAvailable`: The client is unable to fetch the MAM policy. + * + * @param saveLocation - The location in which the add-in is attempting to save data. + * + * @returns True if an organization's Intune MAM policy allows an add-in to save data to the specified location. + */ + getIsSaveToLocationAllowed(saveLocation: MailboxEnums.SaveLocation): boolean; /** diff --git a/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_9/outlook.d.ts b/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_9/outlook.d.ts index 4e9e66eeef..f638ff3b4b 100644 --- a/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_9/outlook.d.ts +++ b/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_9/outlook.d.ts @@ -454,6 +454,48 @@ export declare namespace Office { Dec = "dec" } + /** + * Specifies the location from which an add-in wants to access data. + * + * @remarks + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose, Read + * + * **Important**: This enum is only supported in Outlook on Android and on iOS starting in Version 4.2443.0. To learn more about APIs supported in Outlook on mobile devices, see + * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}. + */ + enum OpenLocation { + /** + * A location associated with an account within an add-in. + */ + AccountDocument, + /** + * The device's camera. + */ + Camera, + /** + * Local storage on a device. + */ + Local, + /** + * OneDrive for Business. + * + * **Important**: For OneDrive Personal, use OTHER. + */ + OnedriveForBusiness, + /** + * Other cloud storage providers, including OneDrive Personal. + */ + Other, + /** + * The device's photo library. + */ + PhotoLibrary, + /** + * SharePoint. Includes both SharePoint Online and SharePoint on-premises (if accessed with a Microsoft Entra ID account). + */ + SharePoint + } /** * Represents the current view of Outlook on the web. */ @@ -1160,6 +1202,56 @@ export declare namespace Office { */ Beta = "beta" } + /** + * Specifies the location in which an add-in wants to save data. + * + * @remarks + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose, Read + * + * **Important**: This enum is only supported in Outlook on Android and on iOS starting in Version 4.2443.0. To learn more about APIs supported in Outlook on mobile devices, see + * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}. + */ + enum SaveLocation { + /** + * A location associated with an account within an add-in. + */ + AccountDocument, + /** + * Box. + */ + Box, + /** + * Dropbox. + */ + Dropbox, + /** + * Google Drive. + */ + GoogleDrive, + /** + * Local storage on a device. + */ + Local, + /** + * OneDrive for Business. + * + * **Important**: For OneDrive Personal, use OTHER. + */ + OnedriveForBusiness, + /** + * Other cloud storage providers, including OneDrive Personal. + */ + Other, + /** + * The device's photo library. + */ + PhotoLibrary, + /** + * SharePoint. Includes both SharePoint Online and SharePoint on-premises (if accessed with a Microsoft Entra ID account). + */ + SharePoint + } /** * Specifies the source of the selected data in an item (see `Office.mailbox.item.getSelectedDataAsync` for details). @@ -6235,6 +6327,73 @@ export declare namespace Office { * @param userContext - Optional. Any state data that is passed to the asynchronous method. */ getCallbackTokenAsync(callback: (asyncResult: CommonAPI.AsyncResult) => void, userContext?: any): void; + /** + * Returns true if the current mailbox is managed by {@link https://learn.microsoft.com/mem/intune/fundamentals/what-is-intune | Microsoft Intune}. + * + * @remarks + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item** + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose, Read + * + * **Important**: This method is only supported in Outlook on Android and on iOS starting in Version 4.2443.0.To learn more about APIs supported in Outlook on mobile devices, see + * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}. + * + * **Errors**: + * + * - `MAMServiceNotAvailable`: The client is unable to fetch the mobile application management (MAM) policy. + * + * @returns True if the current mailbox is managed by Microsoft Intune. + */ + getIsIdentityManaged(): boolean; + /** + * Returns true if an organization's {@link https://learn.microsoft.com/mem/intune/apps/app-management | Intune mobile application management (MAM) policy} + * allows an add-in to access data from the specified location. + * + * @remarks + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item** + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose, Read + * + * **Important**: This method is only supported in Outlook on Android and on iOS starting in Version 4.2443.0. To learn more about APIs supported in Outlook on mobile devices, see + * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}. + * + * **Errors**: + * + * - `InvalidOpenLocationInput`: The value of the specified location is invalid. + * + * - `MAMServiceNotAvailable`: The client is unable to fetch the MAM policy. + * + * @param openLocation - The location from which the add-in is attempting to access data. + * + * @returns True if an organization's Intune MAM policy allows an add-in to access data from the specified location. + */ + getIsOpenFromLocationAllowed(openLocation: MailboxEnums.OpenLocation): boolean; + /** + * Returns true if an organization's {@link https://learn.microsoft.com/mem/intune/apps/app-management | Intune mobile application management (MAM) policy} + * allows an add-in to save data to the specified location. + * + * @remarks + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item** + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose, Read + * + * **Important**: This method is only supported in Outlook on Android and on iOS starting in Version 4.2443.0. To learn more about APIs supported in Outlook on mobile devices, see + * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}. + * + * **Errors**: + * + * - `InvalidSaveLocationInput`: The value of the specified location is invalid. + * + * - `MAMServiceNotAvailable`: The client is unable to fetch the MAM policy. + * + * @param saveLocation - The location in which the add-in is attempting to save data. + * + * @returns True if an organization's Intune MAM policy allows an add-in to save data to the specified location. + */ + getIsSaveToLocationAllowed(saveLocation: MailboxEnums.SaveLocation): boolean; /** diff --git a/generate-docs/api-extractor-inputs-outlook/outlook.d.ts b/generate-docs/api-extractor-inputs-outlook/outlook.d.ts index 0a3ec35915..73d8798405 100644 --- a/generate-docs/api-extractor-inputs-outlook/outlook.d.ts +++ b/generate-docs/api-extractor-inputs-outlook/outlook.d.ts @@ -606,6 +606,48 @@ export declare namespace Office { */ NoMove = "noMove" } + /** + * Specifies the location from which an add-in wants to access data. + * + * @remarks + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose, Read + * + * **Important**: This enum is only supported in Outlook on Android and on iOS starting in Version 4.2443.0. To learn more about APIs supported in Outlook on mobile devices, see + * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}. + */ + enum OpenLocation { + /** + * A location associated with an account within an add-in. + */ + AccountDocument, + /** + * The device's camera. + */ + Camera, + /** + * Local storage on a device. + */ + Local, + /** + * OneDrive for Business. + * + * **Important**: For OneDrive Personal, use OTHER. + */ + OnedriveForBusiness, + /** + * Other cloud storage providers, including OneDrive Personal. + */ + Other, + /** + * The device's photo library. + */ + PhotoLibrary, + /** + * SharePoint. Includes both SharePoint Online and SharePoint on-premises (if accessed with a Microsoft Entra ID account). + */ + SharePoint + } /** * Represents the current view of Outlook on the web. */ @@ -1312,6 +1354,56 @@ export declare namespace Office { */ Beta = "beta" } + /** + * Specifies the location in which an add-in wants to save data. + * + * @remarks + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose, Read + * + * **Important**: This enum is only supported in Outlook on Android and on iOS starting in Version 4.2443.0. To learn more about APIs supported in Outlook on mobile devices, see + * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}. + */ + enum SaveLocation { + /** + * A location associated with an account within an add-in. + */ + AccountDocument, + /** + * Box. + */ + Box, + /** + * Dropbox. + */ + Dropbox, + /** + * Google Drive. + */ + GoogleDrive, + /** + * Local storage on a device. + */ + Local, + /** + * OneDrive for Business. + * + * **Important**: For OneDrive Personal, use OTHER. + */ + OnedriveForBusiness, + /** + * Other cloud storage providers, including OneDrive Personal. + */ + Other, + /** + * The device's photo library. + */ + PhotoLibrary, + /** + * SharePoint. Includes both SharePoint Online and SharePoint on-premises (if accessed with a Microsoft Entra ID account). + */ + SharePoint + } /** * Specifies the {@link https://learn.microsoft.com/office/dev/add-ins/outlook/onmessagesend-onappointmentsend-events#available-send-mode-options | send mode option} * that overrides the option set in the manifest at runtime. @@ -8937,6 +9029,73 @@ export declare namespace Office { * @param userContext - Optional. Any state data that is passed to the asynchronous method. */ getCallbackTokenAsync(callback: (asyncResult: CommonAPI.AsyncResult) => void, userContext?: any): void; + /** + * Returns true if the current mailbox is managed by {@link https://learn.microsoft.com/mem/intune/fundamentals/what-is-intune | Microsoft Intune}. + * + * @remarks + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item** + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose, Read + * + * **Important**: This method is only supported in Outlook on Android and on iOS starting in Version 4.2443.0. To learn more about APIs supported in Outlook on mobile devices, see + * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}. + * + * **Errors**: + * + * - `MAMServiceNotAvailable`: The client is unable to fetch the mobile application management (MAM) policy. + * + * @returns True if the current mailbox is managed by Microsoft Intune. + */ + getIsIdentityManaged(): boolean; + /** + * Returns true if an organization's {@link https://learn.microsoft.com/mem/intune/apps/app-management | Intune mobile application management (MAM) policy} + * allows an add-in to access data from the specified location. + * + * @remarks + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item** + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose, Read + * + * **Important**: This method is only supported in Outlook on Android and on iOS starting in Version 4.2443.0. To learn more about APIs supported in Outlook on mobile devices, see + * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}. + * + * **Errors**: + * + * - `InvalidOpenLocationInput`: The value of the specified location is invalid. + * + * - `MAMServiceNotAvailable`: The client is unable to fetch the MAM policy. + * + * @param openLocation - The location from which the add-in is attempting to access data. + * + * @returns True if an organization's Intune MAM policy allows an add-in to access data from the specified location. + */ + getIsOpenFromLocationAllowed(openLocation: MailboxEnums.OpenLocation): boolean; + /** + * Returns true if an organization's {@link https://learn.microsoft.com/mem/intune/apps/app-management | Intune mobile application management (MAM) policy} + * allows an add-in to save data to the specified location. + * + * @remarks + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item** + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose, Read + * + * **Important**: This method is only supported in Outlook on Android and on iOS starting in Version 4.2443.0. To learn more about APIs supported in Outlook on mobile devices, see + * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}. + * + * **Errors**: + * + * - `InvalidSaveLocationInput`: The value of the specified location is invalid. + * + * - `MAMServiceNotAvailable`: The client is unable to fetch the MAM policy. + * + * @param saveLocation - The location in which the add-in is attempting to save data. + * + * @returns True if an organization's Intune MAM policy allows an add-in to save data to the specified location. + */ + getIsSaveToLocationAllowed(saveLocation: MailboxEnums.SaveLocation): boolean; /** * Gets currently selected messages on which an add-in can activate and perform operations. An add-in can activate on a maximum of 100 messages at a time. * To learn more about item multi-select, see diff --git a/generate-docs/api-extractor-inputs-word-release/word_1_5_hidden_document/word-desktop1.d.ts b/generate-docs/api-extractor-inputs-word-release/word_1_5_hidden_document/word-desktop1.d.ts index afdc04f3d2..70e9063222 100644 --- a/generate-docs/api-extractor-inputs-word-release/word_1_5_hidden_document/word-desktop1.d.ts +++ b/generate-docs/api-extractor-inputs-word-release/word_1_5_hidden_document/word-desktop1.d.ts @@ -2927,9 +2927,9 @@ export declare namespace Word { * Note: The `importedStylesConflictBehavior` parameter was introduced in WordApiDesktop 1.1. * * @param stylesJson - Required. A JSON-formatted string representing the styles. - * @param importedStylesConflictBehavior - Optional. Specifies how to handle any imported styles with the same name as existing styles in the current document. + * */ - importStylesFromJson(stylesJson: string, importedStylesConflictBehavior?: Word.ImportedStylesConflictBehavior): OfficeExtension.ClientResult; + importStylesFromJson(stylesJson: string, ): OfficeExtension.ClientResult; /** * Import styles from a JSON-formatted string. * diff --git a/generate-docs/api-extractor-inputs-word-release/word_1_5_hidden_document/word-desktop2.d.ts b/generate-docs/api-extractor-inputs-word-release/word_1_5_hidden_document/word-desktop2.d.ts index d0ff89aa00..ad72beea6a 100644 --- a/generate-docs/api-extractor-inputs-word-release/word_1_5_hidden_document/word-desktop2.d.ts +++ b/generate-docs/api-extractor-inputs-word-release/word_1_5_hidden_document/word-desktop2.d.ts @@ -2858,9 +2858,9 @@ export declare namespace Word { * Note: The `importedStylesConflictBehavior` parameter was introduced in WordApiDesktop 1.1. * * @param stylesJson - Required. A JSON-formatted string representing the styles. - * @param importedStylesConflictBehavior - Optional. Specifies how to handle any imported styles with the same name as existing styles in the current document. + * */ - importStylesFromJson(stylesJson: string, importedStylesConflictBehavior?: Word.ImportedStylesConflictBehavior): OfficeExtension.ClientResult; + importStylesFromJson(stylesJson: string, ): OfficeExtension.ClientResult; /** * Import styles from a JSON-formatted string. * diff --git a/generate-docs/api-extractor-inputs-word-release/word_1_5_hidden_document/word-desktop3.d.ts b/generate-docs/api-extractor-inputs-word-release/word_1_5_hidden_document/word-desktop3.d.ts index ba907c0ec5..be4ad6fb39 100644 --- a/generate-docs/api-extractor-inputs-word-release/word_1_5_hidden_document/word-desktop3.d.ts +++ b/generate-docs/api-extractor-inputs-word-release/word_1_5_hidden_document/word-desktop3.d.ts @@ -2425,9 +2425,9 @@ export declare namespace Word { * Note: The `importedStylesConflictBehavior` parameter was introduced in WordApiDesktop 1.1. * * @param stylesJson - Required. A JSON-formatted string representing the styles. - * @param importedStylesConflictBehavior - Optional. Specifies how to handle any imported styles with the same name as existing styles in the current document. + * */ - importStylesFromJson(stylesJson: string, importedStylesConflictBehavior?: Word.ImportedStylesConflictBehavior): OfficeExtension.ClientResult; + importStylesFromJson(stylesJson: string, ): OfficeExtension.ClientResult; /** * Import styles from a JSON-formatted string. * diff --git a/generate-docs/api-extractor-inputs-word-release/word_1_6/word.d.ts b/generate-docs/api-extractor-inputs-word-release/word_1_6/word.d.ts index 2185e2d7ee..d73c0073c5 100644 --- a/generate-docs/api-extractor-inputs-word-release/word_1_6/word.d.ts +++ b/generate-docs/api-extractor-inputs-word-release/word_1_6/word.d.ts @@ -2425,9 +2425,9 @@ export declare namespace Word { * Note: The `importedStylesConflictBehavior` parameter was introduced in WordApiDesktop 1.1. * * @param stylesJson - Required. A JSON-formatted string representing the styles. - * @param importedStylesConflictBehavior - Optional. Specifies how to handle any imported styles with the same name as existing styles in the current document. + * */ - importStylesFromJson(stylesJson: string, importedStylesConflictBehavior?: Word.ImportedStylesConflictBehavior): OfficeExtension.ClientResult; + importStylesFromJson(stylesJson: string, ): OfficeExtension.ClientResult; /** * Import styles from a JSON-formatted string. * diff --git a/generate-docs/api-extractor-inputs-word-release/word_1_7/word.d.ts b/generate-docs/api-extractor-inputs-word-release/word_1_7/word.d.ts index db53fcb294..99da7403d5 100644 --- a/generate-docs/api-extractor-inputs-word-release/word_1_7/word.d.ts +++ b/generate-docs/api-extractor-inputs-word-release/word_1_7/word.d.ts @@ -2858,9 +2858,9 @@ export declare namespace Word { * Note: The `importedStylesConflictBehavior` parameter was introduced in WordApiDesktop 1.1. * * @param stylesJson - Required. A JSON-formatted string representing the styles. - * @param importedStylesConflictBehavior - Optional. Specifies how to handle any imported styles with the same name as existing styles in the current document. + * */ - importStylesFromJson(stylesJson: string, importedStylesConflictBehavior?: Word.ImportedStylesConflictBehavior): OfficeExtension.ClientResult; + importStylesFromJson(stylesJson: string, ): OfficeExtension.ClientResult; /** * Import styles from a JSON-formatted string. * diff --git a/generate-docs/api-extractor-inputs-word-release/word_1_8/word.d.ts b/generate-docs/api-extractor-inputs-word-release/word_1_8/word.d.ts index 9c4ec7db4d..e3b3c1bc24 100644 --- a/generate-docs/api-extractor-inputs-word-release/word_1_8/word.d.ts +++ b/generate-docs/api-extractor-inputs-word-release/word_1_8/word.d.ts @@ -2927,9 +2927,9 @@ export declare namespace Word { * Note: The `importedStylesConflictBehavior` parameter was introduced in WordApiDesktop 1.1. * * @param stylesJson - Required. A JSON-formatted string representing the styles. - * @param importedStylesConflictBehavior - Optional. Specifies how to handle any imported styles with the same name as existing styles in the current document. + * */ - importStylesFromJson(stylesJson: string, importedStylesConflictBehavior?: Word.ImportedStylesConflictBehavior): OfficeExtension.ClientResult; + importStylesFromJson(stylesJson: string, ): OfficeExtension.ClientResult; /** * Import styles from a JSON-formatted string. * diff --git a/generate-docs/api-extractor-inputs-word-release/word_1_9/word.d.ts b/generate-docs/api-extractor-inputs-word-release/word_1_9/word.d.ts index d8a3921bc0..c5e99ac503 100644 --- a/generate-docs/api-extractor-inputs-word-release/word_1_9/word.d.ts +++ b/generate-docs/api-extractor-inputs-word-release/word_1_9/word.d.ts @@ -3083,9 +3083,9 @@ export declare namespace Word { * Note: The `importedStylesConflictBehavior` parameter was introduced in WordApiDesktop 1.1. * * @param stylesJson - Required. A JSON-formatted string representing the styles. - * @param importedStylesConflictBehavior - Optional. Specifies how to handle any imported styles with the same name as existing styles in the current document. + * */ - importStylesFromJson(stylesJson: string, importedStylesConflictBehavior?: Word.ImportedStylesConflictBehavior): OfficeExtension.ClientResult; + importStylesFromJson(stylesJson: string, ): OfficeExtension.ClientResult; /** * Import styles from a JSON-formatted string. * diff --git a/generate-docs/api-extractor-inputs-word-release/word_online/word-online1.d.ts b/generate-docs/api-extractor-inputs-word-release/word_online/word-online1.d.ts index c8978a2f72..24b636c37e 100644 --- a/generate-docs/api-extractor-inputs-word-release/word_online/word-online1.d.ts +++ b/generate-docs/api-extractor-inputs-word-release/word_online/word-online1.d.ts @@ -3083,9 +3083,9 @@ export declare namespace Word { * Note: The `importedStylesConflictBehavior` parameter was introduced in WordApiDesktop 1.1. * * @param stylesJson - Required. A JSON-formatted string representing the styles. - * @param importedStylesConflictBehavior - Optional. Specifies how to handle any imported styles with the same name as existing styles in the current document. + * */ - importStylesFromJson(stylesJson: string, importedStylesConflictBehavior?: Word.ImportedStylesConflictBehavior): OfficeExtension.ClientResult; + importStylesFromJson(stylesJson: string, ): OfficeExtension.ClientResult; /** * Import styles from a JSON-formatted string. * diff --git a/generate-docs/api-extractor-inputs-word-release/word_online/word-online2.d.ts b/generate-docs/api-extractor-inputs-word-release/word_online/word-online2.d.ts index fd2c2ddb8e..3386736e01 100644 --- a/generate-docs/api-extractor-inputs-word-release/word_online/word-online2.d.ts +++ b/generate-docs/api-extractor-inputs-word-release/word_online/word-online2.d.ts @@ -3083,9 +3083,9 @@ export declare namespace Word { * Note: The `importedStylesConflictBehavior` parameter was introduced in WordApiDesktop 1.1. * * @param stylesJson - Required. A JSON-formatted string representing the styles. - * @param importedStylesConflictBehavior - Optional. Specifies how to handle any imported styles with the same name as existing styles in the current document. + * */ - importStylesFromJson(stylesJson: string, importedStylesConflictBehavior?: Word.ImportedStylesConflictBehavior): OfficeExtension.ClientResult; + importStylesFromJson(stylesJson: string, ): OfficeExtension.ClientResult; /** * Import styles from a JSON-formatted string. * diff --git a/generate-docs/api-extractor-inputs-word-release/word_online/word-online3.d.ts b/generate-docs/api-extractor-inputs-word-release/word_online/word-online3.d.ts index 837f227263..1219029887 100644 --- a/generate-docs/api-extractor-inputs-word-release/word_online/word-online3.d.ts +++ b/generate-docs/api-extractor-inputs-word-release/word_online/word-online3.d.ts @@ -3083,9 +3083,9 @@ export declare namespace Word { * Note: The `importedStylesConflictBehavior` parameter was introduced in WordApiDesktop 1.1. * * @param stylesJson - Required. A JSON-formatted string representing the styles. - * @param importedStylesConflictBehavior - Optional. Specifies how to handle any imported styles with the same name as existing styles in the current document. + * */ - importStylesFromJson(stylesJson: string, importedStylesConflictBehavior?: Word.ImportedStylesConflictBehavior): OfficeExtension.ClientResult; + importStylesFromJson(stylesJson: string, ): OfficeExtension.ClientResult; /** * Import styles from a JSON-formatted string. * diff --git a/generate-docs/api-extractor-inputs-word-release/word_online/word.d.ts b/generate-docs/api-extractor-inputs-word-release/word_online/word.d.ts index d8a3921bc0..c5e99ac503 100644 --- a/generate-docs/api-extractor-inputs-word-release/word_online/word.d.ts +++ b/generate-docs/api-extractor-inputs-word-release/word_online/word.d.ts @@ -3083,9 +3083,9 @@ export declare namespace Word { * Note: The `importedStylesConflictBehavior` parameter was introduced in WordApiDesktop 1.1. * * @param stylesJson - Required. A JSON-formatted string representing the styles. - * @param importedStylesConflictBehavior - Optional. Specifies how to handle any imported styles with the same name as existing styles in the current document. + * */ - importStylesFromJson(stylesJson: string, importedStylesConflictBehavior?: Word.ImportedStylesConflictBehavior): OfficeExtension.ClientResult; + importStylesFromJson(stylesJson: string, ): OfficeExtension.ClientResult; /** * Import styles from a JSON-formatted string. * diff --git a/generate-docs/script-inputs/office.d.ts b/generate-docs/script-inputs/office.d.ts index b107398e30..42208c8eb3 100644 --- a/generate-docs/script-inputs/office.d.ts +++ b/generate-docs/script-inputs/office.d.ts @@ -9335,9 +9335,9 @@ declare namespace Office { * method. If you're on an Outlook on Windows version that only supports the `postProcessingAction` property, * you must assign it different string values. For a list of supported string values, see * {@link https://learn.microsoft.com/javascript/api/outlook/office.spamreportingeventcompletedoptions#outlook-office-spamreportingeventcompletedoptions-postprocessingaction-member | - * Office.SpamReportingEventCompletedOptions.postProcessingAction}. - */ - enum MoveSpamItemTo { + * Office.SpamReportingEventCompletedOptions.postProcessingAction}. + */ + enum MoveSpamItemTo { /** * Specifies that a reported message is moved to a custom folder in the mailbox. */ @@ -9354,7 +9354,49 @@ declare namespace Office { * Specifies that a reported message remains in its current folder in the mailbox. */ NoMove = "noMove" - } + } + /** + * Specifies the location from which an add-in wants to access data. + * + * @remarks + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose, Read + * + * **Important**: This enum is only supported in Outlook on Android and on iOS starting in Version 4.2443.0. To learn more about APIs supported in Outlook on mobile devices, see + * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}. + */ + enum OpenLocation { + /** + * A location associated with an account within an add-in. + */ + AccountDocument, + /** + * The device's camera. + */ + Camera, + /** + * Local storage on a device. + */ + Local, + /** + * OneDrive for Business. + * + * **Important**: For OneDrive Personal, use OTHER. + */ + OnedriveForBusiness, + /** + * Other cloud storage providers, including OneDrive Personal. + */ + Other, + /** + * The device's photo library. + */ + PhotoLibrary, + /** + * SharePoint. Includes both SharePoint Online and SharePoint on-premises (if accessed with a Microsoft Entra ID account). + */ + SharePoint + } /** * Represents the current view of Outlook on the web. */ @@ -10061,6 +10103,56 @@ declare namespace Office { */ Beta = "beta" } + /** + * Specifies the location in which an add-in wants to save data. + * + * @remarks + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose, Read + * + * **Important**: This enum is only supported in Outlook on Android and on iOS starting in Version 4.2443.0. To learn more about APIs supported in Outlook on mobile devices, see + * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}. + */ + enum SaveLocation { + /** + * A location associated with an account within an add-in. + */ + AccountDocument, + /** + * Box. + */ + Box, + /** + * Dropbox. + */ + Dropbox, + /** + * Google Drive. + */ + GoogleDrive, + /** + * Local storage on a device. + */ + Local, + /** + * OneDrive for Business. + * + * **Important**: For OneDrive Personal, use OTHER. + */ + OnedriveForBusiness, + /** + * Other cloud storage providers, including OneDrive Personal. + */ + Other, + /** + * The device's photo library. + */ + PhotoLibrary, + /** + * SharePoint. Includes both SharePoint Online and SharePoint on-premises (if accessed with a Microsoft Entra ID account). + */ + SharePoint + } /** * Specifies the {@link https://learn.microsoft.com/office/dev/add-ins/outlook/onmessagesend-onappointmentsend-events#available-send-mode-options | send mode option} * that overrides the option set in the manifest at runtime. @@ -15597,6 +15689,73 @@ declare namespace Office { * @param userContext - Optional. Any state data that is passed to the asynchronous method. */ getCallbackTokenAsync(callback: (asyncResult: Office.AsyncResult) => void, userContext?: any): void; + /** + * Returns true if the current mailbox is managed by {@link https://learn.microsoft.com/mem/intune/fundamentals/what-is-intune | Microsoft Intune}. + * + * @remarks + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item** + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose, Read + * + * **Important**: This method is only supported in Outlook on Android and on iOS starting in Version 4.2443.0.To learn more about APIs supported in Outlook on mobile devices, see + * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}. + * + * **Errors**: + * + * - `MAMServiceNotAvailable`: The client is unable to fetch the mobile application management (MAM) policy. + * + * @returns True if the current mailbox is managed by Microsoft Intune. + */ + getIsIdentityManaged(): boolean; + /** + * Returns true if an organization's {@link https://learn.microsoft.com/mem/intune/apps/app-management | Intune mobile application management (MAM) policy} + * allows an add-in to access data from the specified location. + * + * @remarks + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item** + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose, Read + * + * **Important**: This method is only supported in Outlook on Android and on iOS starting in Version 4.2443.0. To learn more about APIs supported in Outlook on mobile devices, see + * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}. + * + * **Errors**: + * + * - `InvalidOpenLocationInput`: The value of the specified location is invalid. + * + * - `MAMServiceNotAvailable`: The client is unable to fetch the MAM policy. + * + * @param openLocation - The location from which the add-in is attempting to access data. + * + * @returns True if an organization's Intune MAM policy allows an add-in to access data from the specified location. + */ + getIsOpenFromLocationAllowed(openLocation: MailboxEnums.OpenLocation): boolean; + /** + * Returns true if an organization's {@link https://learn.microsoft.com/mem/intune/apps/app-management | Intune mobile application management (MAM) policy} + * allows an add-in to save data to the specified location. + * + * @remarks + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item** + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose, Read + * + * **Important**: This method is only supported in Outlook on Android and on iOS starting in Version 4.2443.0. To learn more about APIs supported in Outlook on mobile devices, see + * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}. + * + * **Errors**: + * + * - `InvalidSaveLocationInput`: The value of the specified location is invalid. + * + * - `MAMServiceNotAvailable`: The client is unable to fetch the MAM policy. + * + * @param saveLocation - The location in which the add-in is attempting to save data. + * + * @returns True if an organization's Intune MAM policy allows an add-in to save data to the specified location. + */ + getIsSaveToLocationAllowed(saveLocation: MailboxEnums.SaveLocation): boolean; /** * Gets currently selected messages on which an add-in can activate and perform operations. An add-in can activate on a maximum of 100 messages at a time. * To learn more about item multi-select, see diff --git a/generate-docs/script-inputs/office_preview.d.ts b/generate-docs/script-inputs/office_preview.d.ts index 1e646c52b1..4ba1c4e304 100644 --- a/generate-docs/script-inputs/office_preview.d.ts +++ b/generate-docs/script-inputs/office_preview.d.ts @@ -9406,6 +9406,48 @@ declare namespace Office { */ NoMove = "noMove" } + /** + * Specifies the location from which an add-in wants to access data. + * + * @remarks + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose, Read + * + * **Important**: This enum is only supported in Outlook on Android and on iOS starting in Version 4.2443.0. To learn more about APIs supported in Outlook on mobile devices, see + * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}. + */ + enum OpenLocation { + /** + * A location associated with an account within an add-in. + */ + AccountDocument, + /** + * The device's camera. + */ + Camera, + /** + * Local storage on a device. + */ + Local, + /** + * OneDrive for Business. + * + * **Important**: For OneDrive Personal, use OTHER. + */ + OnedriveForBusiness, + /** + * Other cloud storage providers, including OneDrive Personal. + */ + Other, + /** + * The device's photo library. + */ + PhotoLibrary, + /** + * SharePoint. Includes both SharePoint Online and SharePoint on-premises (if accessed with a Microsoft Entra ID account). + */ + SharePoint + } /** * Represents the current view of Outlook on the web. */ @@ -10112,6 +10154,56 @@ declare namespace Office { */ Beta = "beta" } + /** + * Specifies the location in which an add-in wants to save data. + * + * @remarks + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose, Read + * + * **Important**: This enum is only supported in Outlook on Android and on iOS starting in Version 4.2443.0. To learn more about APIs supported in Outlook on mobile devices, see + * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}. + */ + enum SaveLocation { + /** + * A location associated with an account within an add-in. + */ + AccountDocument, + /** + * Box. + */ + Box, + /** + * Dropbox. + */ + Dropbox, + /** + * Google Drive. + */ + GoogleDrive, + /** + * Local storage on a device. + */ + Local, + /** + * OneDrive for Business. + * + * **Important**: For OneDrive Personal, use OTHER. + */ + OnedriveForBusiness, + /** + * Other cloud storage providers, including OneDrive Personal. + */ + Other, + /** + * The device's photo library. + */ + PhotoLibrary, + /** + * SharePoint. Includes both SharePoint Online and SharePoint on-premises (if accessed with a Microsoft Entra ID account). + */ + SharePoint + } /** * Specifies the {@link https://learn.microsoft.com/office/dev/add-ins/outlook/onmessagesend-onappointmentsend-events#available-send-mode-options | send mode option} * that overrides the option set in the manifest at runtime. @@ -17737,6 +17829,73 @@ declare namespace Office { * @param userContext - Optional. Any state data that is passed to the asynchronous method. */ getCallbackTokenAsync(callback: (asyncResult: Office.AsyncResult) => void, userContext?: any): void; + /** + * Returns true if the current mailbox is managed by {@link https://learn.microsoft.com/mem/intune/fundamentals/what-is-intune | Microsoft Intune}. + * + * @remarks + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item** + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose, Read + * + * **Important**: This method is only supported in Outlook on Android and on iOS starting in Version 4.2443.0. To learn more about APIs supported in Outlook on mobile devices, see + * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}. + * + * **Errors**: + * + * - `MAMServiceNotAvailable`: The client is unable to fetch the mobile application management (MAM) policy. + * + * @returns True if the current mailbox is managed by Microsoft Intune. + */ + getIsIdentityManaged(): boolean; + /** + * Returns true if an organization's {@link https://learn.microsoft.com/mem/intune/apps/app-management | Intune mobile application management (MAM) policy} + * allows an add-in to access data from the specified location. + * + * @remarks + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item** + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose, Read + * + * **Important**: This method is only supported in Outlook on Android and on iOS starting in Version 4.2443.0. To learn more about APIs supported in Outlook on mobile devices, see + * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}. + * + * **Errors**: + * + * - `InvalidOpenLocationInput`: The value of the specified location is invalid. + * + * - `MAMServiceNotAvailable`: The client is unable to fetch the MAM policy. + * + * @param openLocation - The location from which the add-in is attempting to access data. + * + * @returns True if an organization's Intune MAM policy allows an add-in to access data from the specified location. + */ + getIsOpenFromLocationAllowed(openLocation: MailboxEnums.OpenLocation): boolean; + /** + * Returns true if an organization's {@link https://learn.microsoft.com/mem/intune/apps/app-management | Intune mobile application management (MAM) policy} + * allows an add-in to save data to the specified location. + * + * @remarks + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item** + * + * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose, Read + * + * **Important**: This method is only supported in Outlook on Android and on iOS starting in Version 4.2443.0. To learn more about APIs supported in Outlook on mobile devices, see + * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}. + * + * **Errors**: + * + * - `InvalidSaveLocationInput`: The value of the specified location is invalid. + * + * - `MAMServiceNotAvailable`: The client is unable to fetch the MAM policy. + * + * @param saveLocation - The location in which the add-in is attempting to save data. + * + * @returns True if an organization's Intune MAM policy allows an add-in to save data to the specified location. + */ + getIsSaveToLocationAllowed(saveLocation: MailboxEnums.SaveLocation): boolean; /** * Gets currently selected messages on which an add-in can activate and perform operations. An add-in can activate on a maximum of 100 messages at a time. * To learn more about item multi-select, see diff --git a/generate-docs/tools/version-remover.ts b/generate-docs/tools/version-remover.ts index 33f300312d..b43a1e68e4 100644 --- a/generate-docs/tools/version-remover.ts +++ b/generate-docs/tools/version-remover.ts @@ -55,11 +55,17 @@ if (process.argv[3] === "Mailbox 1.14") { } if (process.argv[3] === "Mailbox 1.12") { - console.log("Address SmartAlertsEventCompletedOptions reference when removing Mailbox 1.14"); + console.log("Address SmartAlertsEventCompletedOptions reference when removing Mailbox 1.12"); wholeDts = wholeDts.replace(/options\?: SmartAlertsEventCompletedOptions/g, ""); wholeDts = wholeDts.replace(/@param options - Optional. An object that specifies the behavior of an event-based or spam-reporting add-in when it completes processing an event./g, ""); } +if (process.argv[3] === "WordApiDesktop 1.1") { + console.log("Address ImportedStylesConflictBehavior reference when removing WordApiDesktop 1.1"); + wholeDts = wholeDts.replace(/importedStylesConflictBehavior\?: Word.ImportedStylesConflictBehavior/g, ""); + wholeDts = wholeDts.replace(/@param importedStylesConflictBehavior - Optional. Specifies how to handle any imported styles with the same name as existing styles in the current document./g, ""); +} + fsx.writeFileSync(process.argv[4], wholeDts);