Interface: AuthenticationProvider

定义于: packages/extension-api/src/extension-api.d.ts:4255

执行服务认证的提供程序。

属性

onDidChangeSessions

readonly onDidChangeSessions: Event<AuthenticationProviderAuthenticationSessionsChangeEvent>

定义于: packages/extension-api/src/extension-api.d.ts:4260

当 session 数组发生更改或 session 内的数据发生更改时触发的 event。

方法

createSession()

createSession(scopes): Promise<AuthenticationSession>

定义于: packages/extension-api/src/extension-api.d.ts:4283

提示用户登录。

如果登录成功，则应触发 onDidChangeSessions 事件。

如果登录失败，应返回一个被拒绝的 promise。

如果提供程序已指定它不支持多个帐户，那么如果已经存在匹配这些范围的 session，则不应调用此方法。

参数

scopes

string[]

用于创建新 session 的范围、权限列表。

返回

Promise<AuthenticationSession>

解析为身份验证 session 的 promise。

---

getSessions()

getSessions(scopes?): Promise<readonly AuthenticationSession[]>

定义于: packages/extension-api/src/extension-api.d.ts:4268

获取 session 列表。

参数

scopes?

string[]

可选的范围列表。如果提供，则返回的 session 应匹配这些权限，否则应返回所有 session。

返回值

Promise<readonly AuthenticationSession[]>

解析为身份验证 session 数组的 promise。

---

removeSession()

removeSession(sessionId): Promise<void>

定义于: packages/extension-api/src/extension-api.d.ts:4293

删除与 session id 对应的 session。

如果删除成功，则应触发 onDidChangeSessions 事件。

如果无法删除 session，则提供程序应拒绝并返回错误消息。

参数

sessionId

string

要删除的 session 的 id。

返回值

Promise<void>