casraf/DefinitelyTyped
1
0
Fork 0
mirror of https://github.com/chenasraf/DefinitelyTyped.git synced 2026-05-18 01:49:01 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update getAccessToken support in Outlook (#65646)

Browse Source
This commit is contained in:
Sam Ramon
2023-05-30 14:21:29 -07:00
committed by GitHub
parent 6ffd2748f1
commit f785493e3e
3 changed files with 21 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
types/office-js-preview/index.d.ts vendored
View File

@@ -1549,9 +1549,13 @@ declare namespace Office {
* **Applications**: Excel, OneNote, Outlook, PowerPoint, Word
*
* **Requirement set**: {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/identity-api-requirement-sets | IdentityAPI 1.3}
*
* **Important**: In Outlook, this API isn't supported if the add-in is loaded in an Outlook.com or Gmail mailbox.
*
*
* **Important**: In Outlook, this API isn't supported in the following scenarios.
*
* - If the add-in is loaded in an Outlook.com or Gmail mailbox.
*
* - If the add-in is loaded in Outlook on the web in the Safari browser. This results in error 13001 ("The user is not signed into Office").
*
* **Note**: In an Outlook event-based activation add-in, this API is supported in Outlook on Windows starting from Version 2111 (Build 14701.20000).
* To retrieve an access token in older builds, use
* {@link https://learn.microsoft.com/javascript/api/office-runtime/officeruntime.auth?view=common-js-preview#office-runtime-officeruntime-auth-getaccesstoken-member(1) |

12
types/office-js/index.d.ts vendored
View File

@@ -1541,11 +1541,15 @@ declare namespace Office {
* @remarks
*
* **Applications**: Excel, OneNote, Outlook, PowerPoint, Word
*
*
* **Requirement set**: {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/identity-api-requirement-sets | IdentityAPI 1.3}
*
* **Important**: In Outlook, this API isn't supported if the add-in is loaded in an Outlook.com or Gmail mailbox.
*
*
* **Important**: In Outlook, this API isn't supported in the following scenarios.
*
* - If the add-in is loaded in an Outlook.com or Gmail mailbox.
*
* - If the add-in is loaded in Outlook on the web in the Safari browser. This results in error 13001 ("The user is not signed into Office").
*
* **Note**: In an Outlook event-based activation add-in, this API is supported in Outlook on Windows starting from Version 2111 (Build 14701.20000).
* To retrieve an access token in older builds, use
* {@link https://learn.microsoft.com/javascript/api/office-runtime/officeruntime.auth?view=common-js#office-runtime-officeruntime-auth-getaccesstoken-member(1) |

8
types/office-runtime/index.d.ts vendored
View File

@@ -349,12 +349,16 @@ declare namespace OfficeRuntime {
* This API requires a single sign-on configuration that bridges the add-in to an Azure application. Office users sign-in with Organizational
* Accounts and Microsoft Accounts. Microsoft Azure returns tokens intended for both user account types to access resources in the Microsoft Graph.
*
* **Important**: In Outlook, this API isn't supported if the add-in is loaded in an Outlook.com or Gmail mailbox.
*
* @remarks
*
* **Applications**: Excel, Outlook, PowerPoint, Word
*
* **Important**: In Outlook, this API isn't supported in the following scenarios.
*
* - If the add-in is loaded in an Outlook.com or Gmail mailbox.
*
* - If the add-in is loaded in Outlook on the web in the Safari browser. This results in error 13001 ("The user is not signed into Office").
*
* @param options - Optional. Accepts an `AuthOptions` object to define sign-on behaviors.
* @returns Promise to the access token.
*/