跳转到主内容

函数:getSession()

调用签名

getSession(providerId, scopes, options): Promise<undefined | AuthenticationSession>

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

获取一个与所需作用域匹配的身份验证会话。如果未注册具有 providerId 的提供程序,或者用户未同意与扩展共享身份验证信息,则会拒绝。如果存在具有相同作用域的多个会话,则会向用户显示一个快速选择器,以选择他们希望使用的帐户。

目前,只有两个身份验证提供程序是从 VS Code 的内置扩展贡献的,它们实现了 GitHub 和 Microsoft 身份验证:它们的 providerId 分别是 'github' 和 'microsoft'。

参数

providerId

string

要使用的提供程序的 ID

scopes

string[]

表示请求的权限的作用域列表。这些取决于身份验证提供程序

options

AuthenticationGetSessionOptions & object

要使用的 getSessionOptions

返回

Promise<undefined | AuthenticationSession>

一个解析为身份验证会话的 Promise

调用签名

getSession(providerId, scopes, options?): Promise<undefined | AuthenticationSession>

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

获取一个与所需作用域匹配的身份验证会话。如果未注册具有 providerId 的提供程序,或者用户未同意与扩展共享身份验证信息,则会拒绝。如果存在具有相同作用域的多个会话,则会向用户显示一个快速选择器,以选择他们希望使用的帐户。

目前,只有两个身份验证提供程序是从 VS Code 的内置扩展贡献的,它们实现了 GitHub 和 Microsoft 身份验证:它们的 providerId 分别是 'github' 和 'microsoft'。

参数

providerId

string

要使用的提供程序的 ID

scopes

string[]

表示请求的权限的作用域列表。这些取决于身份验证提供程序

options?

AuthenticationGetSessionOptions

要使用的 getSessionOptions

返回值

Promise<undefined | AuthenticationSession>

一个解析为可用身份验证会话的 Promise,如果不存在会话则为 undefined