跳到主要内容

函数: getSession()

getSession(providerId, scopes, options)

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

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

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

参数

providerId: string

要使用的提供程序的 ID

scopes: string[]

表示请求的权限的范围列表。这些依赖于身份验证提供程序

options: AuthenticationGetSessionOptions & object

要使用的 getSessionOptions

返回值

Promise<AuthenticationSession | undefined>

解析为身份验证会话的承诺

定义于

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

getSession(providerId, scopes, options)

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

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

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

参数

providerId: string

要使用的提供程序的 ID

scopes: string[]

表示请求的权限的范围列表。这些依赖于身份验证提供程序

options?: AuthenticationGetSessionOptions

要使用的 getSessionOptions

返回值

Promise<AuthenticationSession | undefined>

如果可用,则解析为身份验证会话的承诺;如果不存在会话,则解析为 undefined

定义于

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