|
|
|
|
|
<!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="VS Code API 是一系列你可以在 Visual Studio Code 扩展中调用的 JavaScript API。这个站点列出了扩展开发者可以使用的所有 vscode api 中文文档。">
|
|
|
|
|
|
<meta property="og:site_name" content="Vscode Api 中文文档">
|
|
|
|
|
|
<meta property="og:type" content="docs">
|
|
|
|
|
|
<meta property="og:url" content="https://vscode-api-cn.js.org/index.html">
|
|
|
|
|
|
<meta property="article:tag" content="vscode">
|
|
|
|
|
|
<meta property="article:tag" content="vscode api">
|
|
|
|
|
|
<meta property="article:tag" content="vscode api 中文文档">
|
|
|
|
|
|
<meta property="article:tag" content="vscode api 文档">
|
|
|
|
|
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
|
|
|
|
<link rel="shortcut icon" href="https://code.visualstudio.com/favicon.ico" sizes="128x128">
|
|
|
|
|
|
<link rel="stylesheet" href="../assets/css/main.css">
|
|
|
|
|
|
<script async src="../assets/js/search.js" id="search-script"></script>
|
|
|
|
|
|
<script async src="https://pagead2.googlesyndication.com/pagead/js/adsbygoogle.js?client=ca-pub-7962287588031867" crossorigin="anonymous"></script>
|
|
|
|
|
|
<script type="text/javascript">
|
|
|
|
|
|
(function (c, l, a, r, i, t, y) {
|
|
|
|
|
|
c[a] = c[a] || function () { (c[a].q = c[a].q || []).push(arguments) };
|
|
|
|
|
|
t = l.createElement(r); t.async = 1; t.src = "https://www.clarity.ms/tag/" + i;
|
|
|
|
|
|
y = l.getElementsByTagName(r)[0]; y.parentNode.insertBefore(t, y);
|
|
|
|
|
|
})(window, document, "clarity", "script", "g1cbw4nxoq");
|
|
|
|
|
|
</script>
|
|
|
|
|
|
<style>
|
|
|
|
|
|
.github-corner svg {
|
|
|
|
|
|
z-index: 1;
|
|
|
|
|
|
}
|
|
|
|
|
|
.github-corner:hover .octo-arm {
|
|
|
|
|
|
animation:octocat-wave 560ms ease-in-out
|
|
|
|
|
|
}
|
|
|
|
|
|
@keyframes octocat-wave {
|
|
|
|
|
|
0%,100%{transform:rotate(0)}
|
|
|
|
|
|
20%,60%{transform:rotate(-25deg)}
|
|
|
|
|
|
40%,80%{transform:rotate(10deg)}
|
|
|
|
|
|
}
|
|
|
|
|
|
@media (max-width:500px) {
|
|
|
|
|
|
.github-corner:hover
|
|
|
|
|
|
.octo-arm{animation:none}
|
|
|
|
|
|
.github-corner .octo-arm{
|
|
|
|
|
|
animation:octocat-wave 560ms ease-in-out
|
|
|
|
|
|
}
|
|
|
|
|
|
}
|
|
|
|
|
|
.container-main {
|
|
|
|
|
|
padding-bottom: 50px;
|
|
|
|
|
|
}
|
|
|
|
|
|
</style>
|
|
|
|
|
|
</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="../modules.html">VS Code API 中文文档</a>
|
|
|
|
|
|
</li>
|
|
|
|
|
|
<li>
|
|
|
|
|
|
<a href="vscode.html">vscode</a>
|
|
|
|
|
|
</li>
|
|
|
|
|
|
<li>
|
|
|
|
|
|
<a href="vscode.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>用于校验身份的命名空间</p>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<dl class="tsd-comment-tags">
|
|
|
|
|
|
<dt>maintainer</dt>
|
|
|
|
|
|
<dd><p><a href="https://github.com/cxk0831" class="external">@cxk0831</a></p>
|
|
|
|
|
|
</dd>
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
</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（3）</h3>
|
|
|
|
|
|
<ul class="tsd-index-list">
|
|
|
|
|
|
<li class="tsd-kind-function tsd-parent-kind-namespace"><a href="vscode.authentication.html#getSession" class="tsd-kind-icon">get<wbr>Session</a></li>
|
|
|
|
|
|
<li class="tsd-kind-function tsd-parent-kind-namespace"><a href="vscode.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="vscode.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（3）</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/vscode.AuthenticationGetSessionOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">AuthenticationGetSessionOptions</a><span class="tsd-signature-symbol"> & </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"><</span><a href="../interfaces/vscode.AuthenticationSession.html" class="tsd-signature-type" data-tsd-kind="Interface">AuthenticationSession</a><span class="tsd-signature-symbol">></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/vscode.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"><</span><a href="../interfaces/vscode.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">></span></li>
|
|
|
|
|
|
</ul>
|
|
|
|
|
|
<ul class="tsd-descriptions">
|
|
|
|
|
|
<li class="tsd-description">
|
|
|
|
|
|
<aside class="tsd-sources">
|
|
|
|
|
|
<ul>
|
|
|
|
|
|
<li>Defined in <a href="https://github.com/vscode-cn/vscode-api-cn/blob/791ff1c/vscode.d.ts#L13819">vscode.d.ts:13819</a></li>
|
|
|
|
|
|
</ul>
|
|
|
|
|
|
</aside>
|
|
|
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
|
|
|
<div class="lead">
|
|
|
|
|
|
<p>获取符合所需范围的认证会话。
|
|
|
|
|
|
如果一个具有 providerId 的认证 provider 没有注册，或者用户不同意与扩展共享认证信息，则拒绝。
|
|
|
|
|
|
如果有多个具有相同作用域的会话，将向用户显示一个快速选择，以选择他们想使用的账户。</p>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<p>目前，只有两个认证 provider 是由编辑器的内置扩展贡献的，它们实现了 GitHub 和微软的认证：
|
|
|
|
|
|
它们的供应商 ID 是 "github" 和 "microsoft"。</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>认证供应商的 id</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>代表所请求权限的范围列表。它们由 providerId 决定</p>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
</li>
|
|
|
|
|
|
<li>
|
|
|
|
|
|
<h5>options: <a href="../interfaces/vscode.AuthenticationGetSessionOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">AuthenticationGetSessionOptions</a><span class="tsd-signature-symbol"> & </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><a href="../interfaces/vscode.AuthenticationGetSessionOptions.html">AuthenticationGetSessionOptions</a></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"><</span><a href="../interfaces/vscode.AuthenticationSession.html" class="tsd-signature-type" data-tsd-kind="Interface">AuthenticationSession</a><span class="tsd-signature-symbol">></span></h4>
|
|
|
|
|
|
<p>一个可以解析到认证会话的 thenable</p>
|
|
|
|
|
|
</li>
|
|
|
|
|
|
<li class="tsd-description">
|
|
|
|
|
|
<aside class="tsd-sources">
|
|
|
|
|
|
<ul>
|
|
|
|
|
|
<li>Defined in <a href="https://github.com/vscode-cn/vscode-api-cn/blob/791ff1c/vscode.d.ts#L13833">vscode.d.ts:13833</a></li>
|
|
|
|
|
|
</ul>
|
|
|
|
|
|
</aside>
|
|
|
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
|
|
|
<div class="lead">
|
|
|
|
|
|
<p>获取符合所需范围的认证会话。
|
|
|
|
|
|
如果一个具有 providerId 的认证 provider 没有注册，或者用户不同意与扩展共享认证信息，则拒绝。
|
|
|
|
|
|
如果有多个具有相同作用域的会话，将向用户显示一个快速选择，以选择他们想使用的账户。</p>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<p>目前，只有两个认证 provider 是由编辑器的内置扩展贡献的，它们实现了 GitHub 和微软的认证：
|
|
|
|
|
|
它们的供应商 ID 是 "github" 和 "microsoft"。</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>认证供应商的 id</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>代表所请求权限的范围列表。它们由 providerId 决定</p>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
</li>
|
|
|
|
|
|
<li>
|
|
|
|
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <a href="../interfaces/vscode.AuthenticationGetSessionOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">AuthenticationGetSessionOptions</a></h5>
|
|
|
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
|
|
|
<p><a href="../interfaces/vscode.AuthenticationGetSessionOptions.html">AuthenticationGetSessionOptions</a></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"><</span><a href="../interfaces/vscode.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">></span></h4>
|
|
|
|
|
|
<p>一个可以解析到认证会话的 thenable，如果没有会话的话是 <code>undefined</code>。</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/vscode.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>, thisArgs<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span>, disposables<span class="tsd-signature-symbol">?: </span><a href="../classes/vscode.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/vscode.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/vscode-cn/vscode-api-cn/blob/791ff1c/vscode.d.ts#L13839">vscode.d.ts:13839</a></li>
|
|
|
|
|
|
</ul>
|
|
|
|
|
|
</aside>
|
|
|
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
|
|
|
<div class="lead">
|
|
|
|
|
|
<p>An <a href="../interfaces/vscode.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/vscode.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></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/vscode.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/vscode.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/vscode.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/vscode.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/vscode.AuthenticationProvider.html" class="tsd-signature-type" data-tsd-kind="Interface">AuthenticationProvider</a>, options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/vscode.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/vscode.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/vscode-cn/vscode-api-cn/blob/791ff1c/vscode.d.ts#L13853">vscode.d.ts:13853</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/vscode.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/vscode.AuthenticationProviderOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">AuthenticationProviderOptions</a></h5>
|
|
|
|
|
|
</li>
|
|
|
|
|
|
</ul>
|
|
|
|
|
|
<h4 class="tsd-returns-title">Returns <a href="../classes/vscode.Disposable.html" class="tsd-signature-type" data-tsd-kind="Class">Disposable</a></h4>
|
|
|
|
|
|
<p>A <a href="../classes/vscode.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="../modules.html">Exports</a>
|
|
|
|
|
|
</li>
|
|
|
|
|
|
<li class="current tsd-kind-namespace">
|
|
|
|
|
|
<a href="vscode.html">vscode</a>
|
|
|
|
|
|
<ul>
|
|
|
|
|
|
<li class="current tsd-kind-namespace tsd-parent-kind-namespace">
|
|
|
|
|
|
<a href="vscode.authentication.html">authentication</a>
|
|
|
|
|
|
</li>
|
|
|
|
|
|
<li class=" tsd-kind-namespace tsd-parent-kind-namespace">
|
|
|
|
|
|
<a href="vscode.commands.html">commands</a>
|
|
|
|
|
|
</li>
|
|
|
|
|
|
<li class=" tsd-kind-namespace tsd-parent-kind-namespace">
|
|
|
|
|
|
<a href="vscode.comments.html">comments</a>
|
|
|
|
|
|
</li>
|
|
|
|
|
|
<li class=" tsd-kind-namespace tsd-parent-kind-namespace">
|
|
|
|
|
|
<a href="vscode.debug.html">debug</a>
|
|
|
|
|
|
</li>
|
|
|
|
|
|
<li class=" tsd-kind-namespace tsd-parent-kind-namespace">
|
|
|
|
|
|
<a href="vscode.env.html">env</a>
|
|
|
|
|
|
</li>
|
|
|
|
|
|
<li class=" tsd-kind-namespace tsd-parent-kind-namespace">
|
|
|
|
|
|
<a href="vscode.extensions.html">extensions</a>
|
|
|
|
|
|
</li>
|
|
|
|
|
|
<li class=" tsd-kind-namespace tsd-parent-kind-namespace">
|
|
|
|
|
|
<a href="vscode.languages.html">languages</a>
|
|
|
|
|
|
</li>
|
|
|
|
|
|
<li class=" tsd-kind-namespace tsd-parent-kind-namespace">
|
|
|
|
|
|
<a href="vscode.notebooks.html">notebooks</a>
|
|
|
|
|
|
</li>
|
|
|
|
|
|
<li class=" tsd-kind-namespace tsd-parent-kind-namespace">
|
|
|
|
|
|
<a href="vscode.scm.html">scm</a>
|
|
|
|
|
|
</li>
|
|
|
|
|
|
<li class=" tsd-kind-namespace tsd-parent-kind-namespace">
|
|
|
|
|
|
<a href="vscode.tasks.html">tasks</a>
|
|
|
|
|
|
</li>
|
|
|
|
|
|
<li class=" tsd-kind-namespace tsd-parent-kind-namespace">
|
|
|
|
|
|
<a href="vscode.tests.html">tests</a>
|
|
|
|
|
|
</li>
|
|
|
|
|
|
<li class=" tsd-kind-namespace tsd-parent-kind-namespace">
|
|
|
|
|
|
<a href="vscode.window.html">window</a>
|
|
|
|
|
|
</li>
|
|
|
|
|
|
<li class=" tsd-kind-namespace tsd-parent-kind-namespace">
|
|
|
|
|
|
<a href="vscode.workspace.html">workspace</a>
|
|
|
|
|
|
</li>
|
|
|
|
|
|
</ul>
|
|
|
|
|
|
</li>
|
|
|
|
|
|
</ul>
|
|
|
|
|
|
</nav>
|
|
|
|
|
|
<nav class="tsd-navigation secondary menu-sticky">
|
|
|
|
|
|
<div style="width: 200px">
|
|
|
|
|
|
<script type="text/javascript" id="clstr_globe" src="//clustrmaps.com/globe.js?d=cMnk-gSDNcAzNMMm67U8rWRaHnjUc0Xb0giSGndepK4"></script>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<ul class="before-current">
|
|
|
|
|
|
<li class=" tsd-kind-function tsd-parent-kind-namespace">
|
|
|
|
|
|
<a href="vscode.authentication.html#getSession" class="tsd-kind-icon">get<wbr>Session</a>
|
|
|
|
|
|
</li>
|
|
|
|
|
|
<li class=" tsd-kind-function tsd-parent-kind-namespace">
|
|
|
|
|
|
<a href="vscode.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="vscode.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">
|
|
|
|
|
|
</div>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
</footer>
|
|
|
|
|
|
<div class="container tsd-generator">
|
|
|
|
|
|
<p><a href="https://liiked.github.io/VS-Code-Extension-Doc-ZH/" target="_blank">VS Code 插件开发中文文档</a> | <a href="https://jeasonstudio.gitbooks.io/vscode-cn-doc/content/" target="_blank">VS Code 中文文档</a> | <a href="https://code.visualstudio.com/docs" target="_blank">VS Code 官网文档</a> | <a href="https://marketplace.visualstudio.com/" target="_blank">VS Code 扩展市场</a></p>
|
|
|
|
|
|
<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>
|
|
|
|
|
|
<script>
|
|
|
|
|
|
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
|
|
|
|
|
|
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
|
|
|
|
|
|
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
|
|
|
|
|
|
})(window,document,'script','//www.google-analytics.com/analytics.js','ga');
|
|
|
|
|
|
|
|
|
|
|
|
ga('create', 'G-T4TRRS1LB1', 'auto');
|
|
|
|
|
|
ga('send', 'pageview');
|
|
|
|
|
|
</script>
|
|
|
|
|
|
<a href="https://github.com/youngjuning/vscode-api-cn" target="_blank" class="github-corner" aria-label="View source on GitHub"><svg width="80" height="80" viewBox="0 0 250 250" style="fill:#151513; color:#fff; position: fixed; top: 0; border: 0; right: 0;" aria-hidden="true"><path d="M0,0 L115,115 L130,115 L142,142 L250,250 L250,0 Z"></path><path d="M128.3,109.0 C113.8,99.7 119.0,89.6 119.0,89.6 C122.0,82.7 120.5,78.6 120.5,78.6 C119.2,72.0 123.4,76.3 123.4,76.3 C127.3,80.9 125.5,87.3 125.5,87.3 C122.9,97.6 130.6,101.9 134.4,103.2" fill="currentColor" style="transform-origin: 130px 106px;" class="octo-arm"></path><path d="M115.0,115.0 C114.9,115.1 118.7,116.5 119.8,115.4 L133.7,101.6 C136.9,99.2 139.9,98.4 142.2,98.6 C133.8,88.0 127.5,74.4 143.8,58.0 C148.5,53.4 154.0,51.2 159.7,51.0 C160.3,49.4 163.2,43.6 171.4,40.1 C171.4,40.1 176.1,42.5 178.8,56.2 C183.1,58.6 187.2,61.8 190.9,65.4 C194.5,69.0 197.7,73.2 200.1,77.6 C213.8,80.2 216.3,84.9 216.3,84.9 C212.7,93.1 206.9,96.0 205.4,96.6 C205.1,102.4 203.0,107.8 198.3,112.5 C181.9,128.9 168.3,122.5 157.7,114.1 C157.9,116.9 156.7,120.9 152.7,124.9 L141.0,136.5 C139.8,137.7 141.6,141.9 141.8,141.8 Z" fill="currentColor" class="octo-body"></path></svg></a>
|
|
|
|
|
|
</body>
|
|
|
|
|
|
</html>
|
