AadTokenProvider class
此类允许开发人员从 Azure AD 获取 OAuth2 令牌。
OAuth2 令牌用于从 SharePoint 页面向其他服务(如 PowerBI、Sway、Exchange、Yammer 等)对用户进行身份验证。
注解
此类标记为 @sealed
。 子类不应扩展它。
此类的构造函数标记为内部。 第三方代码不应直接调用构造函数或创建扩展类的 AadTokenProvider
子类。
方法
get |
如果当前登录的用户有权访问该资源,则提取资源的 AAD OAuth2 令牌。 OAuth2 令牌不应由调用方缓存,因为它已由 方法本身缓存。 |
get |
事件
on |
在发生整页重定向之前通知开发人员。 |
popup |
通知开发人员逻辑流是否要请求弹出流进行用户交互。 |
token |
当令牌获取需要用户操作时通知开发人员。 |
方法详细信息
getToken(resourceEndpoint, options)
如果当前登录的用户有权访问该资源,则提取资源的 AAD OAuth2 令牌。
OAuth2 令牌不应由调用方缓存,因为它已由 方法本身缓存。
getToken(resourceEndpoint: string, options?: IGetTokenOptions): Promise<string>;
参数
- resourceEndpoint
-
string
应为其获取令牌的资源
- options
- IGetTokenOptions
返回
Promise<string>
将使用令牌履行的承诺,或者将拒绝并显示错误消息的承诺
getToken(resourceEndpoint, useCachedToken)
getToken(resourceEndpoint: string, useCachedToken?: boolean): Promise<string>;
参数
- resourceEndpoint
-
string
- useCachedToken
-
boolean
返回
Promise<string>
事件详细信息
onBeforeRedirectEvent
在发生整页重定向之前通知开发人员。
readonly onBeforeRedirectEvent: SPEvent<BeforeRedirectEventArgs>;
事件类型
popupEvent
tokenAcquisitionEvent
当令牌获取需要用户操作时通知开发人员。
get tokenAcquisitionEvent(): SPEvent<TokenAcquisitionEventArgs>;