Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Admin] (Publish) #2147

Merged
merged 4 commits into from
Dec 3, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 45 additions & 0 deletions docs/code-snippets/outlook-snippets.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -769,6 +769,31 @@ Office.Mailbox#convertToUtcClientTime:member(1):

// Output should be "2019-08-26T22:37:02.002Z".
console.log(result.toISOString());
Office.Mailbox#getIsIdentityManaged:member(1):
- |-
// Checks if the mailbox is managed by Microsoft Intune.
const isIdentityManaged = Office.context.mailbox.getIsIdentityManaged();
console.log(`Intune-managed mailbox: ${isIdentityManaged}`);
Office.Mailbox#getIsOpenFromLocationAllowed:member(1):
- |-
// Checks if the add-in can access data from the device's photo library.
const isOpenFromPhotoLibraryAllowed = Office.context.mailbox.getIsOpenFromLocationAllowed(Office.MailboxEnums.OpenLocation.PhotoLibrary);
if (isOpenFromPhotoLibraryAllowed) {
console.log("Access to the photo library is allowed.");
// Do something.
} else {
console.log("Access to the photo library isn't allowed.");
}
Office.Mailbox#getIsSaveToLocationAllowed:member(1):
- |-
// Checks if the add-in can save data to SharePoint.
const isSaveToSharePointAllowed = Office.context.mailbox.getIsSaveToLocationAllowed(Office.MailboxEnums.SaveLocation.SharePoint);
if (isSaveToSharePointAllowed) {
console.log("Saving to SharePoint is allowed.");
// Do something.
} else {
console.log("Saving to SharePoint isn't allowed.");
}
Office.Mailbox#makeEwsRequestAsync:member(1):
- |-
function getSubjectRequest(id) {
Expand Down Expand Up @@ -975,6 +1000,26 @@ Office.MailboxEnums.MoveSpamItemTo:enum:
});
});
}
Office.MailboxEnums.OpenLocation:enum:
- |-
// Checks if the add-in can access data from the device's photo library.
const isOpenFromPhotoLibraryAllowed = Office.context.mailbox.getIsOpenFromLocationAllowed(Office.MailboxEnums.OpenLocation.PhotoLibrary);
if (isOpenFromPhotoLibraryAllowed) {
console.log("Access to the photo library is allowed.");
// Do something.
} else {
console.log("Access to the photo library isn't allowed.");
}
Office.MailboxEnums.SaveLocation:enum:
- |-
// Checks if the add-in can save data to SharePoint.
const isSaveToSharePointAllowed = Office.context.mailbox.getIsSaveToLocationAllowed(Office.MailboxEnums.SaveLocation.SharePoint);
if (isSaveToSharePointAllowed) {
console.log("Saving to SharePoint is allowed.");
// Do something.
} else {
console.log("Saving to SharePoint isn't allowed.");
}
Office.MailboxEnums.SendModeOverride:enum:
- |-
// The following example checks whether a location is specified in an appointment before it's sent.
Expand Down
6 changes: 0 additions & 6 deletions docs/docs-ref-autogen/office/office/office.auth.yml
Original file line number Diff line number Diff line change
Expand Up @@ -113,9 +113,6 @@ methods:

**Important**: In Outlook, this API isn't supported if the add-in is loaded in an Outlook.com or Gmail
mailbox.


**Warning**: `getAccessTokenAsync` has been deprecated. Use `Office.auth.getAccessToken` instead.
remarks: >-
**Applications**: Excel, OneNote, Outlook, PowerPoint, Word

Expand Down Expand Up @@ -176,9 +173,6 @@ methods:

**Important**: In Outlook, this API isn't supported if the add-in is loaded in an Outlook.com or Gmail
mailbox.


**Warning**: `getAccessTokenAsync` has been deprecated. Use `Office.auth.getAccessToken` instead.
remarks: >-
**Applications**: Excel, OneNote, Outlook, PowerPoint, Word

Expand Down
6 changes: 0 additions & 6 deletions docs/docs-ref-autogen/office/office/office.authoptions.yml
Original file line number Diff line number Diff line change
Expand Up @@ -83,9 +83,6 @@ properties:
summary: >-
Prompts the user to add their Office account (or to switch to it, if it is already added). Default value is
`false`<!-- -->.


**Warning**: `forceAddAccount` has been deprecated. Use `allowSignInPrompt` instead.
remarks: ''
isPreview: false
isDeprecated: true
Expand All @@ -101,9 +98,6 @@ properties:
summary: >-
Causes Office to display the add-in consent experience. Useful if the add-in's Azure permissions have changed or
if the user's consent has been revoked. Default value is `false`<!-- -->.


**Warning**: `forceConsent` has been deprecated. Use `allowConsentPrompt` instead.
remarks: ''
isPreview: false
isDeprecated: true
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,12 +33,7 @@ methods:
uid: 'office!Office.RequirementSetSupport#isSetSupported:member(2)'
package: office!
fullName: 'isSetSupported(name, minVersionNumber)'
summary: >-
Check if the specified requirement set is supported by the Office application.


**Warning**: This overload of `isSetSupported` (where `minVersionNumber` is a number) has been deprecated. Use
the string overload of `isSetSupported` instead.
summary: Check if the specified requirement set is supported by the Office application.
remarks: ''
isPreview: false
isDeprecated: true
Expand Down
6 changes: 0 additions & 6 deletions docs/docs-ref-autogen/office_release/office/office.auth.yml
Original file line number Diff line number Diff line change
Expand Up @@ -113,9 +113,6 @@ methods:

**Important**: In Outlook, this API isn't supported if the add-in is loaded in an Outlook.com or Gmail
mailbox.


**Warning**: `getAccessTokenAsync` has been deprecated. Use `Office.auth.getAccessToken` instead.
remarks: >-
**Applications**: Excel, OneNote, Outlook, PowerPoint, Word

Expand Down Expand Up @@ -176,9 +173,6 @@ methods:

**Important**: In Outlook, this API isn't supported if the add-in is loaded in an Outlook.com or Gmail
mailbox.


**Warning**: `getAccessTokenAsync` has been deprecated. Use `Office.auth.getAccessToken` instead.
remarks: >-
**Applications**: Excel, OneNote, Outlook, PowerPoint, Word

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -83,9 +83,6 @@ properties:
summary: >-
Prompts the user to add their Office account (or to switch to it, if it is already added). Default value is
`false`<!-- -->.


**Warning**: `forceAddAccount` has been deprecated. Use `allowSignInPrompt` instead.
remarks: ''
isPreview: false
isDeprecated: true
Expand All @@ -101,9 +98,6 @@ properties:
summary: >-
Causes Office to display the add-in consent experience. Useful if the add-in's Azure permissions have changed or
if the user's consent has been revoked. Default value is `false`<!-- -->.


**Warning**: `forceConsent` has been deprecated. Use `allowConsentPrompt` instead.
remarks: ''
isPreview: false
isDeprecated: true
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,12 +33,7 @@ methods:
uid: 'office!Office.RequirementSetSupport#isSetSupported:member(2)'
package: office!
fullName: 'isSetSupported(name, minVersionNumber)'
summary: >-
Check if the specified requirement set is supported by the Office application.


**Warning**: This overload of `isSetSupported` (where `minVersionNumber` is a number) has been deprecated. Use
the string overload of `isSetSupported` instead.
summary: Check if the specified requirement set is supported by the Office application.
remarks: ''
isPreview: false
isDeprecated: true
Expand Down
54 changes: 54 additions & 0 deletions docs/docs-ref-autogen/outlook/outlook/office.mailbox.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2163,6 +2163,20 @@ methods:


- `MAMServiceNotAvailable`<!-- -->: The client is unable to fetch the mobile application management (MAM) policy.


#### Examples


```TypeScript

// Checks if the mailbox is managed by Microsoft Intune.

const isIdentityManaged = Office.context.mailbox.getIsIdentityManaged();

console.log(`Intune-managed mailbox: ${isIdentityManaged}`);

```
isPreview: false
isDeprecated: false
syntax:
Expand Down Expand Up @@ -2201,6 +2215,26 @@ methods:


- `MAMServiceNotAvailable`<!-- -->: The client is unable to fetch the MAM policy.


#### Examples


```TypeScript

// Checks if the add-in can access data from the device's photo library.

const isOpenFromPhotoLibraryAllowed =
Office.context.mailbox.getIsOpenFromLocationAllowed(Office.MailboxEnums.OpenLocation.PhotoLibrary);

if (isOpenFromPhotoLibraryAllowed) {
console.log("Access to the photo library is allowed.");
// Do something.
} else {
console.log("Access to the photo library isn't allowed.");
}

```
isPreview: false
isDeprecated: false
syntax:
Expand Down Expand Up @@ -2243,6 +2277,26 @@ methods:


- `MAMServiceNotAvailable`<!-- -->: The client is unable to fetch the MAM policy.


#### Examples


```TypeScript

// Checks if the add-in can save data to SharePoint.

const isSaveToSharePointAllowed =
Office.context.mailbox.getIsSaveToLocationAllowed(Office.MailboxEnums.SaveLocation.SharePoint);

if (isSaveToSharePointAllowed) {
console.log("Saving to SharePoint is allowed.");
// Do something.
} else {
console.log("Saving to SharePoint isn't allowed.");
}

```
isPreview: false
isDeprecated: false
syntax:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,26 @@ remarks: >-
**Important**: This enum is only supported in Outlook on Android and on iOS starting in Version 4.2443.0. To learn
more about APIs supported in Outlook on mobile devices, see [Outlook JavaScript APIs supported in Outlook on mobile
devices](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis)<!-- -->.


#### Examples


```TypeScript

// Checks if the add-in can access data from the device's photo library.

const isOpenFromPhotoLibraryAllowed =
Office.context.mailbox.getIsOpenFromLocationAllowed(Office.MailboxEnums.OpenLocation.PhotoLibrary);

if (isOpenFromPhotoLibraryAllowed) {
console.log("Access to the photo library is allowed.");
// Do something.
} else {
console.log("Access to the photo library isn't allowed.");
}

```
isPreview: false
isDeprecated: false
fields:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,26 @@ remarks: >-
**Important**: This enum is only supported in Outlook on Android and on iOS starting in Version 4.2443.0. To learn
more about APIs supported in Outlook on mobile devices, see [Outlook JavaScript APIs supported in Outlook on mobile
devices](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis)<!-- -->.


#### Examples


```TypeScript

// Checks if the add-in can save data to SharePoint.

const isSaveToSharePointAllowed =
Office.context.mailbox.getIsSaveToLocationAllowed(Office.MailboxEnums.SaveLocation.SharePoint);

if (isSaveToSharePointAllowed) {
console.log("Saving to SharePoint is allowed.");
// Do something.
} else {
console.log("Saving to SharePoint isn't allowed.");
}

```
isPreview: false
isDeprecated: false
fields:
Expand Down
54 changes: 54 additions & 0 deletions docs/docs-ref-autogen/outlook_1_1/outlook/office.mailbox.yml
Original file line number Diff line number Diff line change
Expand Up @@ -741,6 +741,20 @@ methods:


- `MAMServiceNotAvailable`<!-- -->: The client is unable to fetch the mobile application management (MAM) policy.


#### Examples


```TypeScript

// Checks if the mailbox is managed by Microsoft Intune.

const isIdentityManaged = Office.context.mailbox.getIsIdentityManaged();

console.log(`Intune-managed mailbox: ${isIdentityManaged}`);

```
isPreview: false
isDeprecated: false
syntax:
Expand Down Expand Up @@ -779,6 +793,26 @@ methods:


- `MAMServiceNotAvailable`<!-- -->: The client is unable to fetch the MAM policy.


#### Examples


```TypeScript

// Checks if the add-in can access data from the device's photo library.

const isOpenFromPhotoLibraryAllowed =
Office.context.mailbox.getIsOpenFromLocationAllowed(Office.MailboxEnums.OpenLocation.PhotoLibrary);

if (isOpenFromPhotoLibraryAllowed) {
console.log("Access to the photo library is allowed.");
// Do something.
} else {
console.log("Access to the photo library isn't allowed.");
}

```
isPreview: false
isDeprecated: false
syntax:
Expand Down Expand Up @@ -821,6 +855,26 @@ methods:


- `MAMServiceNotAvailable`<!-- -->: The client is unable to fetch the MAM policy.


#### Examples


```TypeScript

// Checks if the add-in can save data to SharePoint.

const isSaveToSharePointAllowed =
Office.context.mailbox.getIsSaveToLocationAllowed(Office.MailboxEnums.SaveLocation.SharePoint);

if (isSaveToSharePointAllowed) {
console.log("Saving to SharePoint is allowed.");
// Do something.
} else {
console.log("Saving to SharePoint isn't allowed.");
}

```
isPreview: false
isDeprecated: false
syntax:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,26 @@ remarks: >-
**Important**: This enum is only supported in Outlook on Android and on iOS starting in Version 4.2443.0. To learn
more about APIs supported in Outlook on mobile devices, see [Outlook JavaScript APIs supported in Outlook on mobile
devices](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis)<!-- -->.


#### Examples


```TypeScript

// Checks if the add-in can access data from the device's photo library.

const isOpenFromPhotoLibraryAllowed =
Office.context.mailbox.getIsOpenFromLocationAllowed(Office.MailboxEnums.OpenLocation.PhotoLibrary);

if (isOpenFromPhotoLibraryAllowed) {
console.log("Access to the photo library is allowed.");
// Do something.
} else {
console.log("Access to the photo library isn't allowed.");
}

```
isPreview: false
isDeprecated: false
fields:
Expand Down
Loading