Interface AuthenticationService

interface AuthenticationService {
    onDidChangeSessions: Event<{
        event: AuthenticationProviderAuthenticationSessionsChangeEvent;
        label: string;
        providerId: string;
    }>;
    onDidRegisterAuthenticationProvider: Event<AuthenticationProviderInformation>;
    onDidUnregisterAuthenticationProvider: Event<AuthenticationProviderInformation>;
    onDidUpdateSignInCount: Event<number>;
    getLabel(providerId): string;
    getProviderIds(): string[];
    getSessions(providerId, scopes?, user?): Promise<readonly AuthenticationSession[]>;
    isAuthenticationProviderRegistered(id): boolean;
    login(providerId, scopes, options?): Promise<AuthenticationSession>;
    logout(providerId, sessionId): Promise<void>;
    registerAuthenticationProvider(id, provider): void;
    requestNewSession(id, scopes, extensionId, extensionName): void;
    signOutOfAccount(providerId, accountName): Promise<void>;
    supportsMultipleAccounts(providerId): boolean;
    unregisterAuthenticationProvider(id): void;
    updateSessions(providerId, event): void;
}

Implemented by

AuthenticationServiceImpl

Index

Properties

onDidChangeSessions onDidRegisterAuthenticationProvider onDidUnregisterAuthenticationProvider onDidUpdateSignInCount

Methods

getLabel getProviderIds getSessions isAuthenticationProviderRegistered login logout registerAuthenticationProvider requestNewSession signOutOfAccount supportsMultipleAccounts unregisterAuthenticationProvider updateSessions

Properties

`Readonly` onDidChangeSessions

onDidChangeSessions: Event<{
    event: AuthenticationProviderAuthenticationSessionsChangeEvent;
    label: string;
    providerId: string;
}>

Type declaration

event: AuthenticationProviderAuthenticationSessionsChangeEvent
label: string
providerId: string

`Readonly` onDidRegisterAuthenticationProvider

onDidRegisterAuthenticationProvider: Event<AuthenticationProviderInformation>

`Readonly` onDidUnregisterAuthenticationProvider

onDidUnregisterAuthenticationProvider: Event<AuthenticationProviderInformation>

`Readonly` onDidUpdateSignInCount

onDidUpdateSignInCount: Event<number>

Methods

getLabel

getLabel(providerId): string
Parameters
- providerId: string
Returns string
- Defined in packages/core/src/browser/authentication-service.ts:137

getProviderIds

getProviderIds(): string[]
Returns string[]
- Defined in packages/core/src/browser/authentication-service.ts:125

getSessions

getSessions(providerId, scopes?, user?): Promise<readonly AuthenticationSession[]>
Parameters
- providerId: string
- Optional scopes: string[]
- Optional user: AuthenticationSessionAccountInformation
Returns Promise<readonly AuthenticationSession[]>
- Defined in packages/core/src/browser/authentication-service.ts:136

isAuthenticationProviderRegistered

isAuthenticationProviderRegistered(id): boolean
Parameters
- id: string
Returns boolean
- Defined in packages/core/src/browser/authentication-service.ts:124

login

login(providerId, scopes, options?): Promise<AuthenticationSession>
Parameters
- providerId: string
- scopes: string[]
- Optional options: AuthenticationProviderSessionOptions
Returns Promise<AuthenticationSession>
- Defined in packages/core/src/browser/authentication-service.ts:139

logout

logout(providerId, sessionId): Promise<void>
Parameters
- providerId: string
- sessionId: string
Returns Promise<void>
- Defined in packages/core/src/browser/authentication-service.ts:140

registerAuthenticationProvider

registerAuthenticationProvider(id, provider): void
Parameters
- id: string
- provider: AuthenticationProvider
Returns void
- Defined in packages/core/src/browser/authentication-service.ts:126

requestNewSession

requestNewSession(id, scopes, extensionId, extensionName): void
Parameters
- id: string
- scopes: string[]
- extensionId: string
- extensionName: string
Returns void
- Defined in packages/core/src/browser/authentication-service.ts:128

signOutOfAccount

signOutOfAccount(providerId, accountName): Promise<void>
Parameters
- providerId: string
- accountName: string
Returns Promise<void>
- Defined in packages/core/src/browser/authentication-service.ts:142

supportsMultipleAccounts

supportsMultipleAccounts(providerId): boolean
Parameters
- providerId: string
Returns boolean
- Defined in packages/core/src/browser/authentication-service.ts:138

unregisterAuthenticationProvider

unregisterAuthenticationProvider(id): void
Parameters
- id: string
Returns void
- Defined in packages/core/src/browser/authentication-service.ts:127

updateSessions

updateSessions(providerId, event): void
Parameters
- providerId: string
- event: AuthenticationProviderAuthenticationSessionsChangeEvent
Returns void
- Defined in packages/core/src/browser/authentication-service.ts:129

Interface AuthenticationService

Implemented by

Index

Properties

Methods

Properties

Readonly onDidChangeSessions

Type declaration

event: AuthenticationProviderAuthenticationSessionsChangeEvent

label: string

providerId: string

Readonly onDidRegisterAuthenticationProvider

Readonly onDidUnregisterAuthenticationProvider

Readonly onDidUpdateSignInCount

Methods

getLabel

Parameters

Returns string

getProviderIds

Returns string[]

getSessions

Parameters

Returns Promise<readonly AuthenticationSession[]>

isAuthenticationProviderRegistered

Parameters

Returns boolean

login

Parameters

Returns Promise<AuthenticationSession>

logout

Parameters

Returns Promise<void>

registerAuthenticationProvider

Parameters

Returns void

requestNewSession

Parameters

Returns void

signOutOfAccount

Parameters

Returns Promise<void>

supportsMultipleAccounts

Parameters

Returns boolean

unregisterAuthenticationProvider

Parameters

Returns void

updateSessions

Parameters

Returns void

Settings

Member Visibility

Theme

On This Page

`Readonly` onDidChangeSessions

`Readonly` onDidRegisterAuthenticationProvider

`Readonly` onDidUnregisterAuthenticationProvider

`Readonly` onDidUpdateSignInCount