如果应用程序中已有身份验证代码,可以创建自定义提供程序,以启用 Microsoft Graph 组件的身份验证Graph Toolkit访问。 有两种方法可创建自定义提供程序:
- 通过传递
SimpleProvider用于获取访问令牌的函数创建新令牌 - 扩展抽象
IProvider类
本文将更详细地介绍每种方法。
SimpleProvider
通过传入将 SimpleProvider 返回传入作用域的访问令牌的函数来实例化类。
let provider = new SimpleProvider((scopes: string[]) => {
// return a promise with accessToken
});
此外,还可以提供可选 login logout 和 函数,用于处理登录和从 登录 组件注销调用。
Important: 若要向组件指示他们可以在用户成功登录后开始调用 Microsoft Graph API,你需要调用
Providers.setState(ProviderState.SignedIn)。 以下函数中显示了这一login点的示例。
function getAccessToken(scopes: string[]) {
// return a promise with accessToken string
}
function login() {
//login code
Providers.globalProvider.setState(ProviderState.SignedIn)
}
function logout() {
// logout code
}
let provider = new SimpleProvider(getAccessToken, login, logout);
管理状态
若要使组件了解 provider.setState(state: ProviderState) 提供程序的状态,则需要在状态发生更改时调用 方法。 例如,当用户登录后,调用 provider.setState(ProviderState.SignedIn)。 枚举 ProviderState 定义三种状态,如下所示。
export enum ProviderState {
Loading,
SignedOut,
SignedIn
}
IProvider
您可以扩展抽象 IProvider 类以创建自己的提供程序。
状态
提供程序必须跟踪身份验证状态,并更新状态更改时的组件。 类 IProvider 已实现 onStateChanged(eventHandler) 处理程序和 state: ProviderState 属性。 只需在实现中 setState(state:ProviderState) 使用此方法,在状态发生更改时更新状态。 更新状态将启动事件 stateChanged 并自动更新所有组件。
登录/注销
如果提供程序提供登录或注销功能,请实现 login(): Promise<void> 和 logout(): Promise<void> 方法。 这些方法是可选的。
访问令牌
必须实现 getAccessToken({'scopes': scopes[]}) : Promise<string> 方法。 此方法用于获取有效的令牌之前每次调用 Microsoft Graph。
Graph
这些组件使用 Microsoft Graph Javascript SDK 调用 Microsoft Graph。 提供程序必须通过 属性使 graph SDK 可用。 在构造函数中,创建一个新 Graph 实例,如下所示。
this.graph = new Graph(this);
该类Graph是 Microsoft Graph SDK 顶部的浅色包装。
示例
所有提供程序扩展抽象 IProvider 类。 例如,查看任何现有提供程序的 源代码。
设置全局提供程序
组件使用 Providers.globalProvider 属性访问提供程序。 创建自己的提供程序后,将此属性设置为提供程序。
import { Providers } from '@microsoft/mgt';
Providers.globalProvider = myProvider;
所有组件都将收到新提供程序的通知,并开始使用它。
历史资料。此文对应 2023-02-03 的中文文档快照,适用产品版本和命令行为以原文为准。
来源与署名:Microsoft 和文档贡献者(原始作者元数据 sebastienlevert)。固定版本原文。文档采用 CC BY 4.0,示例代码采用 MIT 授权。本站将 Markdown 转为 HTML,规范化链接,移除外部媒体和导航标记。
