A provider for performing authentication to a service.
Fields
removeSession(sessionId:String):Thenable<Void>
Removes the session corresponding to session id.
If the removal is successful, the onDidChangeSessions event should be fired.
If a session cannot be removed, the provider should reject with an error message.
Parameters:
sessionId | The id of the session to remove. |
|---|
read onlyonDidChangeSessions:Event<AuthenticationProviderAuthenticationSessionsChangeEvent>
An {@link Event} which fires when the array of sessions has changed, or data within a session has changed.
getSessions(?scopes:ReadOnlyArray<String>):Thenable<ReadOnlyArray<AuthenticationSession>>
Get a list of sessions.
Parameters:
scopes | An optional list of scopes. If provided, the sessions returned should match these permissions, otherwise all sessions should be returned. |
|---|
Returns:
A promise that resolves to an array of authentication sessions.
createSession(scopes:ReadOnlyArray<String>):Thenable<AuthenticationSession>
Prompts a user to login.
If login is successful, the onDidChangeSessions event should be fired.
If login fails, a rejected promise should be returned.
If the provider has specified that it does not support multiple accounts, then this should never be called if there is already an existing session matching these scopes.
Parameters:
scopes | A list of scopes, permissions, that the new session should be created with. |
|---|
Returns:
A promise that resolves to an authentication session.