vhad/DefinitelyTyped
1
0
Fork 0
mirror of https://github.com/gosticks/DefinitelyTyped.git synced 2026-10-06 15:57:13 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Merge pull request #28463 from Rick-Kirkham/office-js-getAccessTokenAsync-fixes

Browse Source 
fix errors in getAccessTokenAsync doc
This commit is contained in:
Armando Aguirre
2018-08-29 11:16:56 -07:00
committed by GitHub
parent 0b369e6525 375f7aa133
commit 0814826dde
1 changed files with 7 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files
types/office-js/index.d.ts
Vendored
+7 -8
View File
@@ -1132,12 +1132,14 @@ declare namespace Office {
asyncContext?: any
}
/**
* The Office Auth namespace, Office.context.auth, provides a method that allows the Office host to obtain and access the add-in token.
* Indirectly, enable the add-in to access the signed-in user's Microsoft Graph data without requiring the user to sign in a second time.
* The Office Auth namespace, Office.context.auth, provides a method that allows the Office host to obtain an access token to the add-in's web application.
* Indirectly, this also enables the add-in to access the signed-in user's Microsoft Graph data without requiring the user to sign in a second time.
*
* @beta
*/
interface Auth {
/**
* Calls the Azure Active Directory V 2.0 endpoint to get an access token to your add-in's web application. Allows add-ins to identify users.
* Calls the Azure Active Directory V 2.0 endpoint to get an access token to your add-in's web application. Enables add-ins to identify users.
* Server side code can use this token to access Microsoft Graph for the add-in's web application by using the
* {@link https://docs.microsoft.com/azure/active-directory/develop/active-directory-v2-protocols-oauth-on-behalf-of | "on behalf of" OAuth flow}.
*
@@ -1148,11 +1150,8 @@ declare namespace Office {
*
* <tr><td>Requirement sets</td><td>{@link https://docs.microsoft.com/office/dev/add-ins/develop/specify-office-hosts-and-api-requirements | IdentityAPI}</td></tr></table>
*
* 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.
*
* @param options - Optional. Accepts an AuthOptions object to define sign-on behaviors.
* @param callback - Optional. Accepts a callback method to handle the token acquisition attempt.
* @param callback - Optional. Accepts a callback method that can parse the token for the user's ID or use the token in the "on behalf of" flow to get access to Microsoft Graph.
* If AsyncResult.status is "succeeded", then AsyncResult.value is the raw AAD v. 2.0-formatted access token.
*
* @beta
@@ -1170,7 +1169,7 @@ declare namespace Office {
*/
forceConsent?: boolean,
/**
* Prompts the user to add (or to switch if already added) his or her Office account.
* Prompts the user to add their Office account (or to switch to it, if it is already added).
*/
forceAddAccount?: boolean,
/**