You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
vscode-api-cn.js/modules/authentication.html

384 lines
22 KiB

<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>authentication | VS Code API 中文文档</title>
<meta name="description" content="Documentation for VS Code API 中文文档">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">VS Code API 中文文档</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
<input type="checkbox" id="tsd-filter-externals" checked />
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../index.html">VS Code API 中文文档</a>
</li>
<li>
<a href="authentication.html">authentication</a>
</li>
</ul>
<h1>Namespace authentication</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-comment">
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Namespace for authentication.</p>
</div>
</div>
</section>
<section class="tsd-panel-group tsd-index-group">
<h2>索引</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section ">
<h3>Functions</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-function tsd-parent-kind-namespace"><a href="authentication.html#getSession" class="tsd-kind-icon">get<wbr>Session</a></li>
<li class="tsd-kind-function tsd-parent-kind-namespace"><a href="authentication.html#onDidChangeSessions" class="tsd-kind-icon">on<wbr>Did<wbr>Change<wbr>Sessions</a></li>
<li class="tsd-kind-function tsd-parent-kind-namespace"><a href="authentication.html#registerAuthenticationProvider" class="tsd-kind-icon">register<wbr>Authentication<wbr>Provider</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Functions</h2>
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace">
<a name="getSession" class="tsd-anchor"></a>
<h3>get<wbr>Session</h3>
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace">
<li class="tsd-signature tsd-kind-icon">get<wbr>Session<span class="tsd-signature-symbol">(</span>providerId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, scopes<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">readonly </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span>, options<span class="tsd-signature-symbol">: </span><a href="../interfaces/AuthenticationGetSessionOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">AuthenticationGetSessionOptions</a><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-symbol">{ </span>createIfNone<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">true</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/Thenable.html" class="tsd-signature-type" data-tsd-kind="Interface">Thenable</a><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/AuthenticationSession.html" class="tsd-signature-type" data-tsd-kind="Interface">AuthenticationSession</a><span class="tsd-signature-symbol">&gt;</span></li>
<li class="tsd-signature tsd-kind-icon">get<wbr>Session<span class="tsd-signature-symbol">(</span>providerId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, scopes<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">readonly </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span>, options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/AuthenticationGetSessionOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">AuthenticationGetSessionOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/Thenable.html" class="tsd-signature-type" data-tsd-kind="Interface">Thenable</a><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/AuthenticationSession.html" class="tsd-signature-type" data-tsd-kind="Interface">AuthenticationSession</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/youngjuning/vscode-api-cn/blob/2939fda/vscode.d.ts#L13794">vscode.d.ts:13794</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>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
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.</p>
</div>
<p>Currently, there are only two authentication providers that are contributed from built in extensions
to the editor that implement GitHub and Microsoft authentication: their providerId&#39;s are &#39;github&#39; and &#39;microsoft&#39;.</p>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>providerId: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>The id of the provider to use</p>
</div>
</li>
<li>
<h5>scopes: <span class="tsd-signature-symbol">readonly </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5>
<div class="tsd-comment tsd-typography">
<p>A list of scopes representing the permissions requested. These are dependent on the authentication provider</p>
</div>
</li>
<li>
<h5>options: <a href="../interfaces/AuthenticationGetSessionOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">AuthenticationGetSessionOptions</a><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-symbol">{ </span>createIfNone<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">true</span><span class="tsd-signature-symbol"> }</span></h5>
<div class="tsd-comment tsd-typography">
<p>The {@link GetSessionOptions} to use</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="../interfaces/Thenable.html" class="tsd-signature-type" data-tsd-kind="Interface">Thenable</a><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/AuthenticationSession.html" class="tsd-signature-type" data-tsd-kind="Interface">AuthenticationSession</a><span class="tsd-signature-symbol">&gt;</span></h4>
<p>A thenable that resolves to an authentication session</p>
</li>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/youngjuning/vscode-api-cn/blob/2939fda/vscode.d.ts#L13809">vscode.d.ts:13809</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>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
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.</p>
</div>
<p>Currently, there are only two authentication providers that are contributed from built in extensions
to the editor that implement GitHub and Microsoft authentication: their providerId&#39;s are &#39;github&#39; and &#39;microsoft&#39;.</p>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>providerId: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>The id of the provider to use</p>
</div>
</li>
<li>
<h5>scopes: <span class="tsd-signature-symbol">readonly </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5>
<div class="tsd-comment tsd-typography">
<p>A list of scopes representing the permissions requested. These are dependent on the authentication provider</p>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <a href="../interfaces/AuthenticationGetSessionOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">AuthenticationGetSessionOptions</a></h5>
<div class="tsd-comment tsd-typography">
<p>The {@link GetSessionOptions} to use</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="../interfaces/Thenable.html" class="tsd-signature-type" data-tsd-kind="Interface">Thenable</a><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/AuthenticationSession.html" class="tsd-signature-type" data-tsd-kind="Interface">AuthenticationSession</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">&gt;</span></h4>
<p>A thenable that resolves to an authentication session if available, or undefined if there are no sessions</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace">
<a name="onDidChangeSessions" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagConst">Const</span> on<wbr>Did<wbr>Change<wbr>Sessions</h3>
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace">
<li class="tsd-signature tsd-kind-icon">on<wbr>Did<wbr>Change<wbr>Sessions<span class="tsd-signature-symbol">(</span>listener<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>e<span class="tsd-signature-symbol">: </span><a href="../interfaces/AuthenticationSessionsChangeEvent.html" class="tsd-signature-type" data-tsd-kind="Interface">AuthenticationSessionsChangeEvent</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">any</span>, thisArgs<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span>, disposables<span class="tsd-signature-symbol">?: </span><a href="../classes/Disposable.html" class="tsd-signature-type" data-tsd-kind="Class">Disposable</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../classes/Disposable.html" class="tsd-signature-type" data-tsd-kind="Class">Disposable</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/youngjuning/vscode-api-cn/blob/2939fda/vscode.d.ts#L13815">vscode.d.ts:13815</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>An <a href="../interfaces/Event.html">Event</a> which fires when the authentication sessions of an authentication provider have
been added, removed, or changed.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>listener: <span class="tsd-signature-symbol">(</span>e<span class="tsd-signature-symbol">: </span><a href="../interfaces/AuthenticationSessionsChangeEvent.html" class="tsd-signature-type" data-tsd-kind="Interface">AuthenticationSessionsChangeEvent</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">any</span></h5>
<ul class="tsd-parameters">
<li class="tsd-parameter-signature">
<ul class="tsd-signatures tsd-kind-type-literal">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>e<span class="tsd-signature-symbol">: </span><a href="../interfaces/AuthenticationSessionsChangeEvent.html" class="tsd-signature-type" data-tsd-kind="Interface">AuthenticationSessionsChangeEvent</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>e: <a href="../interfaces/AuthenticationSessionsChangeEvent.html" class="tsd-signature-type" data-tsd-kind="Interface">AuthenticationSessionsChangeEvent</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
</li>
</ul>
</li>
</ul>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> thisArgs: <span class="tsd-signature-type">any</span></h5>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> disposables: <a href="../classes/Disposable.html" class="tsd-signature-type" data-tsd-kind="Class">Disposable</a><span class="tsd-signature-symbol">[]</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="../classes/Disposable.html" class="tsd-signature-type" data-tsd-kind="Class">Disposable</a></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace">
<a name="registerAuthenticationProvider" class="tsd-anchor"></a>
<h3>register<wbr>Authentication<wbr>Provider</h3>
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace">
<li class="tsd-signature tsd-kind-icon">register<wbr>Authentication<wbr>Provider<span class="tsd-signature-symbol">(</span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, label<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, provider<span class="tsd-signature-symbol">: </span><a href="../interfaces/AuthenticationProvider.html" class="tsd-signature-type" data-tsd-kind="Interface">AuthenticationProvider</a>, options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/AuthenticationProviderOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">AuthenticationProviderOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../classes/Disposable.html" class="tsd-signature-type" data-tsd-kind="Class">Disposable</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/youngjuning/vscode-api-cn/blob/2939fda/vscode.d.ts#L13829">vscode.d.ts:13829</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Register an authentication provider.</p>
</div>
<p>There can only be one provider per id and an error is being thrown when an id
has already been used by another provider. Ids are case-sensitive.</p>
<dl class="tsd-comment-tags">
<dt>params</dt>
<dd><p>options Additional options for the provider.</p>
</dd>
</dl>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>id: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>The unique identifier of the provider.</p>
</div>
</li>
<li>
<h5>label: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>The human-readable name of the provider.</p>
</div>
</li>
<li>
<h5>provider: <a href="../interfaces/AuthenticationProvider.html" class="tsd-signature-type" data-tsd-kind="Interface">AuthenticationProvider</a></h5>
<div class="tsd-comment tsd-typography">
<p>The authentication provider provider.</p>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <a href="../interfaces/AuthenticationProviderOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">AuthenticationProviderOptions</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="../classes/Disposable.html" class="tsd-signature-type" data-tsd-kind="Class">Disposable</a></h4>
<p>A <a href="../classes/Disposable.html">Disposable</a> that unregisters this provider when being disposed.</p>
</li>
</ul>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class=" ">
<a href="../index.html">Exports</a>
</li>
<li class="current tsd-kind-namespace">
<a href="authentication.html">authentication</a>
</li>
<li class=" tsd-kind-namespace">
<a href="commands.html">commands</a>
</li>
<li class=" tsd-kind-namespace">
<a href="comments.html">comments</a>
</li>
<li class=" tsd-kind-namespace">
<a href="debug.html">debug</a>
</li>
<li class=" tsd-kind-namespace">
<a href="env.html">env</a>
</li>
<li class=" tsd-kind-namespace">
<a href="extensions.html">extensions</a>
</li>
<li class=" tsd-kind-namespace">
<a href="languages.html">languages</a>
</li>
<li class=" tsd-kind-namespace">
<a href="notebooks.html">notebooks</a>
</li>
<li class=" tsd-kind-namespace">
<a href="scm.html">scm</a>
</li>
<li class=" tsd-kind-namespace">
<a href="tasks.html">tasks</a>
</li>
<li class=" tsd-kind-namespace">
<a href="tests.html">tests</a>
</li>
<li class=" tsd-kind-namespace">
<a href="window.html">window</a>
</li>
<li class=" tsd-kind-namespace">
<a href="workspace.html">workspace</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
<li class=" tsd-kind-function tsd-parent-kind-namespace">
<a href="authentication.html#getSession" class="tsd-kind-icon">get<wbr>Session</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-namespace">
<a href="authentication.html#onDidChangeSessions" class="tsd-kind-icon">on<wbr>Did<wbr>Change<wbr>Sessions</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-namespace">
<a href="authentication.html#registerAuthenticationProvider" class="tsd-kind-icon">register<wbr>Authentication<wbr>Provider</a>
</li>
</ul>
</nav>
</div>
</div>
</div>
<footer class="with-border-bottom">
<div class="container">
<h2>图例</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul>
</div>
</div>
</footer>
<div class="container tsd-generator">
<p>Generated by <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
</div>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>