Class AuthenticationProviderImpl

Our authentication provider should at least contain the following information:

The signature of authentication providers from vscode
Registration information about the provider (id, label)
Provider options (supportsMultipleAccounts)

Additionally, we provide the possibility to sign out of a specific account name.

Implements

AuthenticationProvider

Index

Constructors

Properties

id label onDidChangeSessions supportsMultipleAccounts

Methods

createSession getSessions hasSessions login logout removeSession signOut updateSessionItems

Constructors

constructor

new AuthenticationProviderImpl(
    proxy: AuthenticationExt,
    id: string,
    label: string,
    supportsMultipleAccounts: boolean,
    storageService: StorageService,
    messageService: MessageService,
): AuthenticationProviderImpl
Parameters
- proxy: AuthenticationExt
- id: string
- label: string
- supportsMultipleAccounts: boolean
- storageService: StorageService
- messageService: MessageService
Returns AuthenticationProviderImpl
- Defined in packages/plugin-ext/src/main/browser/authentication-main.ts:298

Properties

`Readonly`id

id: string

`Readonly`label

label: string

`Readonly`onDidChangeSessions

onDidChangeSessions: Event<
AuthenticationProviderAuthenticationSessionsChangeEvent,
>

An event which fires when the array of sessions has changed, or data within a session has changed.

`Readonly`supportsMultipleAccounts

supportsMultipleAccounts: boolean

Methods

createSession

createSession(
scopes: string[],
options: AuthenticationProviderSessionOptions,
): Thenable<AuthenticationSession>
Prompts a user to login.
Parameters
- scopes: string[]
  A list of scopes, permissions, that the new session should be created with.
- options: AuthenticationProviderSessionOptions
  The options for createing the session
Returns Thenable<AuthenticationSession>
A promise that resolves to an authentication session.
Implementation of AuthenticationProvider.createSession
- Defined in packages/plugin-ext/src/main/browser/authentication-main.ts:376

getSessions

getSessions(
scopes?: string[],
account?: AuthenticationSessionAccountInformation,
): Promise<readonly AuthenticationSession[]>
Get a list of sessions.
Parameters
- Optionalscopes: string[]
  An optional list of scopes. If provided, the sessions returned should match these permissions, otherwise all sessions should be returned.
- Optionalaccount: AuthenticationSessionAccountInformation
  The optional account that you would like to get the session for
Returns Promise<readonly AuthenticationSession[]>
A promise that resolves to an array of authentication sessions.
Implementation of AuthenticationProvider.getSessions
- Defined in packages/plugin-ext/src/main/browser/authentication-main.ts:339

hasSessions

hasSessions(): boolean
Returns boolean
Implementation of AuthenticationProvider.hasSessions
- Defined in packages/plugin-ext/src/main/browser/authentication-main.ts:307

login(
scopes: string[],
options: AuthenticationProviderSessionOptions,
): Promise<AuthenticationSession>
Parameters
- scopes: string[]
- options: AuthenticationProviderSessionOptions
Returns Promise<AuthenticationSession>
- Defined in packages/plugin-ext/src/main/browser/authentication-main.ts:368

logout

logout(sessionId: string): Promise<void>
Parameters
- sessionId: string
Returns Promise<void>
- Defined in packages/plugin-ext/src/main/browser/authentication-main.ts:372

removeSession

removeSession(sessionId: string): Thenable<void>
Removes the session corresponding to session id.
Parameters
- sessionId: string
  The id of the session to remove.
Returns Thenable<void>
Implementation of AuthenticationProvider.removeSession
- Defined in packages/plugin-ext/src/main/browser/authentication-main.ts:380

signOut

signOut(accountName: string): Promise<void>
Parameters
- accountName: string
Returns Promise<void>
Implementation of AuthenticationProvider.signOut
- Defined in packages/plugin-ext/src/main/browser/authentication-main.ts:323

updateSessionItems

updateSessionItems(
event: AuthenticationProviderAuthenticationSessionsChangeEvent,
): Promise<void>
Parameters
- event: AuthenticationProviderAuthenticationSessionsChangeEvent
Returns Promise<void>
Implementation of AuthenticationProvider.updateSessionItems
- Defined in packages/plugin-ext/src/main/browser/authentication-main.ts:343