Interface AuthenticationProvider

Should match the definition from the theia/vscode types

Hierarchy

AuthenticationProvider

Index

Properties

Methods

Properties

id

id: string

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.

supportsMultipleAccounts

supportsMultipleAccounts: boolean

Methods

createSession

createSession(scopes: string[]): Thenable<AuthenticationSession>

- Defined in packages/core/src/browser/authentication-service.ts:103
Prompts a user to login.

Parameters
- scopes: string[]
  
  A list of scopes, permissions, that the new session should be created with.
Returns Thenable<AuthenticationSession>
A promise that resolves to an authentication session.

getSessions

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

- Defined in packages/core/src/browser/authentication-service.ts:76
Parameters
- Optional scopes: string[]
Returns Promise<readonly AuthenticationSession[]>
- Defined in packages/core/src/browser/authentication-service.ts:96
Get a list of sessions.

Parameters
- Optional scopes: string[]
  
  An optional list of scopes. If provided, the sessions returned should match these permissions, otherwise all sessions should be returned.
Returns Thenable<readonly AuthenticationSession[]>
A promise that resolves to an array of authentication sessions.

hasSessions

hasSessions(): boolean

- Defined in packages/core/src/browser/authentication-service.ts:72
Returns boolean

login

login(scopes: string[]): Promise<AuthenticationSession>

- Defined in packages/core/src/browser/authentication-service.ts:80
Parameters
- scopes: string[]
Returns Promise<AuthenticationSession>

logout

logout(sessionId: string): Promise<void>

- Defined in packages/core/src/browser/authentication-service.ts:82
Parameters
- sessionId: string
Returns Promise<void>

removeSession

removeSession(sessionId: string): Thenable<void>

- Defined in packages/core/src/browser/authentication-service.ts:109
Removes the session corresponding to session id.

Parameters
- sessionId: string
  
  The id of the session to remove.
Returns Thenable<void>

signOut

signOut(accountName: string): Promise<void>

- Defined in packages/core/src/browser/authentication-service.ts:74
Parameters
- accountName: string
Returns Promise<void>

updateSessionItems

updateSessionItems(event: AuthenticationProviderAuthenticationSessionsChangeEvent): Promise<void>

- Defined in packages/core/src/browser/authentication-service.ts:78
Parameters
- event: AuthenticationProviderAuthenticationSessionsChangeEvent
Returns Promise<void>