Add note about providerIds
This commit is contained in:
parent
0b773db915
commit
d9b5e57a2b
1 changed files with 9 additions and 0 deletions
9
src/vs/vscode.d.ts
vendored
9
src/vs/vscode.d.ts
vendored
|
@ -11605,12 +11605,18 @@ declare module 'vscode' {
|
||||||
readonly provider: AuthenticationProviderInformation;
|
readonly provider: AuthenticationProviderInformation;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Namespace for authentication.
|
||||||
|
*/
|
||||||
export namespace authentication {
|
export namespace authentication {
|
||||||
/**
|
/**
|
||||||
* Get an authentication session matching the desired scopes. Rejects if a provider with providerId is not
|
* Get an authentication session matching the desired scopes. Rejects if a provider with providerId is not
|
||||||
* registered, or if the user does not consent to sharing authentication information with
|
* registered, or if the user does not consent to sharing authentication information with
|
||||||
* the extension. If there are multiple sessions with the same scopes, the user will be shown a
|
* the extension. If there are multiple sessions with the same scopes, the user will be shown a
|
||||||
* quickpick to select which account they would like to use.
|
* quickpick to select which account they would like to use.
|
||||||
|
*
|
||||||
|
* Currently, there are only two authentication providers that are contributed from built in extensions
|
||||||
|
* to VS Code that implement GitHub and Microsoft authentication: their providerId's are 'github' and 'microsoft'.
|
||||||
* @param providerId The id of the provider to use
|
* @param providerId The id of the provider to use
|
||||||
* @param scopes A list of scopes representing the permissions requested. These are dependent on the authentication provider
|
* @param scopes A list of scopes representing the permissions requested. These are dependent on the authentication provider
|
||||||
* @param options The [getSessionOptions](#GetSessionOptions) to use
|
* @param options The [getSessionOptions](#GetSessionOptions) to use
|
||||||
|
@ -11623,6 +11629,9 @@ declare module 'vscode' {
|
||||||
* registered, or if the user does not consent to sharing authentication information with
|
* registered, or if the user does not consent to sharing authentication information with
|
||||||
* the extension. If there are multiple sessions with the same scopes, the user will be shown a
|
* the extension. If there are multiple sessions with the same scopes, the user will be shown a
|
||||||
* quickpick to select which account they would like to use.
|
* quickpick to select which account they would like to use.
|
||||||
|
*
|
||||||
|
* Currently, there are only two authentication providers that are contributed from built in extensions
|
||||||
|
* to VS Code that implement GitHub and Microsoft authentication: their providerId's are 'github' and 'microsoft'.
|
||||||
* @param providerId The id of the provider to use
|
* @param providerId The id of the provider to use
|
||||||
* @param scopes A list of scopes representing the permissions requested. These are dependent on the authentication provider
|
* @param scopes A list of scopes representing the permissions requested. These are dependent on the authentication provider
|
||||||
* @param options The [getSessionOptions](#GetSessionOptions) to use
|
* @param options The [getSessionOptions](#GetSessionOptions) to use
|
||||||
|
|
Loading…
Reference in a new issue