跳至主要内容

接口:AuthenticationProvider

用于执行服务身份验证的提供程序。

属性

onDidChangeSessions

readonly onDidChangeSessions: 事件<身份验证提供者身份验证会话更改事件>

当会话数组发生更改或会话中的数据发生更改时触发的事件

定义在

packages/extension-api/src/extension-api.d.ts:4112

方法

createSession()

createSession(scopes): Promise<身份验证会话>

提示用户登录。

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

如果登录失败,则应返回一个被拒绝的 Promise。

如果提供程序已指定它不支持多个帐户,则如果已存在与这些范围匹配的现有会话,则永远不应调用此方法。

参数

scopes: string[]

新会话应创建的一系列范围(权限)。

返回

Promise<身份验证会话>

解析为身份验证会话的 Promise。

定义在

packages/extension-api/src/extension-api.d.ts:4135


getSessions()

getSessions(scopes?): Promise<readonly 身份验证会话[]>

获取会话列表。

参数

scopes?: string[]

一个可选的范围列表。如果提供,则返回的会话应匹配这些权限,否则应返回所有会话。

返回

Promise<readonly 身份验证会话[]>

解析为身份验证会话数组的 Promise。

定义在

packages/extension-api/src/extension-api.d.ts:4120


removeSession()

removeSession(sessionId): Promise<void>

删除与会话 ID 相对应的会话。

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

如果无法删除会话,则提供程序应使用错误消息拒绝。

参数

sessionId: string

要删除的会话的 ID。

返回

Promise<void>

定义在

packages/extension-api/src/extension-api.d.ts:4145