ckaczor/sqltoolsservice
1
0
Fork 0
mirror of https://github.com/ckaczor/sqltoolsservice.git synced 2026-01-22 17:24:07 -05:00
Code Issues Packages Projects Releases Wiki Activity

Add docs template

Browse Source
This commit is contained in:
Karl Burtram
2016-12-15 17:06:28 -08:00
parent b9f1c2b60e 2346ffff38
commit edb3c4aa1f
275 changed files with 10751 additions and 19075 deletions
Download Patch File Download Diff File Expand all files Collapse all files

119
docs/_site/api/Microsoft.SqlTools.ServiceLayer.Credentials.Contracts.Credential.html
View File

@@ -10,43 +10,45 @@
<meta name="viewport" content="width=device-width">
<meta name="title" content="Class Credential
">
<meta name="generator" content="docfx 1.0.0.0">
<link rel="shortcut icon" href="../favicon.ico">
<link rel="stylesheet" href="http://maxcdn.bootstrapcdn.com/font-awesome/4.3.0/css/font-awesome.min.css">
<link rel="stylesheet" href="../styles/docfx.vendor.css">
<link rel="stylesheet" href="../styles/docfx.css">
<link rel="stylesheet" href="../styles/main.css">
<link rel="stylesheet" href="../styles/docfx.css">
<link rel="stylesheet" href="../styles/style.css">
<meta property="docfx:navrel" content="../toc.html">
<meta property="docfx:tocrel" content="toc.html">
</head>
<body data-spy="scroll" data-target="#affix">
<!--
<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', 'UA-63735192-1', 'auto');
ga('send', 'pageview');
</script>
-->
</head> <body data-spy="scroll" data-target="#affix">
<div id="wrapper">
<header>
<nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
<div class="container">
<div class="navbar-header">
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="../index.html">
<img id="logo" class="svg" src="../logo.svg" alt="">
</a>
</div>
<div class="collapse navbar-collapse" id="navbar">
<form class="navbar-form navbar-right" role="search" id="search">
<div class="form-group">
<input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
</div>
</form>
</div>
</div>
</nav>
<nav class="navbar navbar-inverse">
<div class="container">
<a href="../"><img height="50px" src="../images/sqlserver.png" style="float:right;"></a>
<div class="navbar-header ">
<button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar" aria-expanded="false" aria-controls="navbar">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="../"><span class="dotnet">SQL Tools Service</span></a>
</div>
<div id="navbar" class="collapse navbar-collapse">
</div><!--/.nav-collapse -->
</div>
</nav>
<div class="subnav navbar navbar-default">
<div class="container hide-when-search" id="breadcrumb">
@@ -68,7 +70,8 @@
<div class="col-md-10">
<article class="content wrap" id="_content">
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Credentials_Contracts_Credential.md&amp;value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Credentials.Contracts.Credential%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A" class="pull-right mobile-hide"><span class="fa fa-github"></span>Improve this Doc</a>
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Credentials/Contracts/Credential.cs/#L16" class="pull-right mobile-hide">View Source</a>
<h1 id="Microsoft_SqlTools_ServiceLayer_Credentials_Contracts_Credential" data-uid="Microsoft.SqlTools.ServiceLayer.Credentials.Contracts.Credential">Class Credential
</h1>
<div class="markdown level0 summary"><p>A Credential containing information needed to log into a resource. This is primarily
@@ -81,30 +84,6 @@ that&#39;s linked to it. </p>
<div class="level0"><span class="xref">System.Object</span></div>
<div class="level1"><span class="xref">Credential</span></div>
</div>
<div class="inheritedMembers">
<h5>Inherited Members</h5>
<div>
<span class="xref">System.Object.Equals(System.Object)</span>
</div>
<div>
<span class="xref">System.Object.Equals(System.Object, System.Object)</span>
</div>
<div>
<span class="xref">System.Object.GetHashCode()</span>
</div>
<div>
<span class="xref">System.Object.GetType()</span>
</div>
<div>
<span class="xref">System.Object.MemberwiseClone()</span>
</div>
<div>
<span class="xref">System.Object.ReferenceEquals(System.Object, System.Object)</span>
</div>
<div>
<span class="xref">System.Object.ToString()</span>
</div>
</div>
<h6><strong>Namespace</strong>:Microsoft.SqlTools.ServiceLayer.Credentials.Contracts</h6>
<h6><strong>Assembly</strong>:Microsoft.SqlTools.ServiceLayer.dll</h6>
<h5 id="Microsoft_SqlTools_ServiceLayer_Credentials_Contracts_Credential_syntax">Syntax</h5>
@@ -120,7 +99,6 @@ that&#39;s linked to it. </p>
<span class="small pull-right mobile-hide">
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Credentials/Contracts/Credential.cs/#L31">View Source</a>
</span>
<a id="Microsoft_SqlTools_ServiceLayer_Credentials_Contracts_Credential__ctor_" data-uid="Microsoft.SqlTools.ServiceLayer.Credentials.Contracts.Credential.#ctor*"></a>
<h4 id="Microsoft_SqlTools_ServiceLayer_Credentials_Contracts_Credential__ctor" data-uid="Microsoft.SqlTools.ServiceLayer.Credentials.Contracts.Credential.#ctor">Credential()</h4>
<div class="markdown level1 summary"><p>Default Constructor</p>
</div>
@@ -136,7 +114,6 @@ that&#39;s linked to it. </p>
<span class="small pull-right mobile-hide">
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Credentials/Contracts/Credential.cs/#L39">View Source</a>
</span>
<a id="Microsoft_SqlTools_ServiceLayer_Credentials_Contracts_Credential__ctor_" data-uid="Microsoft.SqlTools.ServiceLayer.Credentials.Contracts.Credential.#ctor*"></a>
<h4 id="Microsoft_SqlTools_ServiceLayer_Credentials_Contracts_Credential__ctor_System_String_" data-uid="Microsoft.SqlTools.ServiceLayer.Credentials.Contracts.Credential.#ctor(System.String)">Credential(String)</h4>
<div class="markdown level1 summary"><p>Constructor used when only <span class="paramref">credentialId</span> is known</p>
</div>
@@ -157,7 +134,7 @@ that&#39;s linked to it. </p>
<tbody>
<tr>
<td><span class="xref">System.String</span></td>
<td><span class="parametername">credentialId</span></td>
<td><em>credentialId</em></td>
<td><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Credentials.Contracts.Credential.html#Microsoft_SqlTools_ServiceLayer_Credentials_Contracts_Credential_CredentialId">CredentialId</a></td>
</tr>
</tbody>
@@ -169,7 +146,6 @@ that&#39;s linked to it. </p>
<span class="small pull-right mobile-hide">
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Credentials/Contracts/Credential.cs/#L50">View Source</a>
</span>
<a id="Microsoft_SqlTools_ServiceLayer_Credentials_Contracts_Credential__ctor_" data-uid="Microsoft.SqlTools.ServiceLayer.Credentials.Contracts.Credential.#ctor*"></a>
<h4 id="Microsoft_SqlTools_ServiceLayer_Credentials_Contracts_Credential__ctor_System_String_System_String_" data-uid="Microsoft.SqlTools.ServiceLayer.Credentials.Contracts.Credential.#ctor(System.String,System.String)">Credential(String, String)</h4>
<div class="markdown level1 summary"><p>Constructor</p>
</div>
@@ -190,12 +166,12 @@ that&#39;s linked to it. </p>
<tbody>
<tr>
<td><span class="xref">System.String</span></td>
<td><span class="parametername">credentialId</span></td>
<td><em>credentialId</em></td>
<td><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Credentials.Contracts.Credential.html#Microsoft_SqlTools_ServiceLayer_Credentials_Contracts_Credential_CredentialId">CredentialId</a></td>
</tr>
<tr>
<td><span class="xref">System.String</span></td>
<td><span class="parametername">password</span></td>
<td><em>password</em></td>
<td><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Credentials.Contracts.Credential.html#Microsoft_SqlTools_ServiceLayer_Credentials_Contracts_Credential_Password">Password</a></td>
</tr>
</tbody>
@@ -209,7 +185,6 @@ that&#39;s linked to it. </p>
<span class="small pull-right mobile-hide">
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Credentials/Contracts/Credential.cs/#L21">View Source</a>
</span>
<a id="Microsoft_SqlTools_ServiceLayer_Credentials_Contracts_Credential_CredentialId_" data-uid="Microsoft.SqlTools.ServiceLayer.Credentials.Contracts.Credential.CredentialId*"></a>
<h4 id="Microsoft_SqlTools_ServiceLayer_Credentials_Contracts_Credential_CredentialId" data-uid="Microsoft.SqlTools.ServiceLayer.Credentials.Contracts.Credential.CredentialId">CredentialId</h4>
<div class="markdown level1 summary"><p>A unique ID to identify the credential being saved. </p>
</div>
@@ -218,7 +193,7 @@ that&#39;s linked to it. </p>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public string CredentialId { get; set; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<h5 class="propertyValue"></h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
@@ -240,7 +215,6 @@ that&#39;s linked to it. </p>
<span class="small pull-right mobile-hide">
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Credentials/Contracts/Credential.cs/#L26">View Source</a>
</span>
<a id="Microsoft_SqlTools_ServiceLayer_Credentials_Contracts_Credential_Password_" data-uid="Microsoft.SqlTools.ServiceLayer.Credentials.Contracts.Credential.Password*"></a>
<h4 id="Microsoft_SqlTools_ServiceLayer_Credentials_Contracts_Credential_Password" data-uid="Microsoft.SqlTools.ServiceLayer.Credentials.Contracts.Credential.Password">Password</h4>
<div class="markdown level1 summary"><p>The Password stored for this credential. </p>
</div>
@@ -249,7 +223,7 @@ that&#39;s linked to it. </p>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public string Password { get; set; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<h5 class="propertyValue"></h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
@@ -273,7 +247,6 @@ that&#39;s linked to it. </p>
<span class="small pull-right mobile-hide">
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Credentials/Contracts/Credential.cs/#L68">View Source</a>
</span>
<a id="Microsoft_SqlTools_ServiceLayer_Credentials_Contracts_Credential_ValidateForLookup_" data-uid="Microsoft.SqlTools.ServiceLayer.Credentials.Contracts.Credential.ValidateForLookup*"></a>
<h4 id="Microsoft_SqlTools_ServiceLayer_Credentials_Contracts_Credential_ValidateForLookup_Microsoft_SqlTools_ServiceLayer_Credentials_Contracts_Credential_" data-uid="Microsoft.SqlTools.ServiceLayer.Credentials.Contracts.Credential.ValidateForLookup(Microsoft.SqlTools.ServiceLayer.Credentials.Contracts.Credential)">ValidateForLookup(Credential)</h4>
<div class="markdown level1 summary"><p>Validates the credential has all the properties needed to look up the password</p>
</div>
@@ -294,7 +267,7 @@ that&#39;s linked to it. </p>
<tbody>
<tr>
<td><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Credentials.Contracts.Credential.html">Credential</a></td>
<td><span class="parametername">credential</span></td>
<td><em>credential</em></td>
<td></td>
</tr>
</tbody>
@@ -306,7 +279,6 @@ that&#39;s linked to it. </p>
<span class="small pull-right mobile-hide">
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Credentials/Contracts/Credential.cs/#L78">View Source</a>
</span>
<a id="Microsoft_SqlTools_ServiceLayer_Credentials_Contracts_Credential_ValidateForSave_" data-uid="Microsoft.SqlTools.ServiceLayer.Credentials.Contracts.Credential.ValidateForSave*"></a>
<h4 id="Microsoft_SqlTools_ServiceLayer_Credentials_Contracts_Credential_ValidateForSave_Microsoft_SqlTools_ServiceLayer_Credentials_Contracts_Credential_" data-uid="Microsoft.SqlTools.ServiceLayer.Credentials.Contracts.Credential.ValidateForSave(Microsoft.SqlTools.ServiceLayer.Credentials.Contracts.Credential)">ValidateForSave(Credential)</h4>
<div class="markdown level1 summary"><p>Validates the credential has all the properties needed to save a password</p>
</div>
@@ -327,7 +299,7 @@ that&#39;s linked to it. </p>
<tbody>
<tr>
<td><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Credentials.Contracts.Credential.html">Credential</a></td>
<td><span class="parametername">credential</span></td>
<td><em>credential</em></td>
<td></td>
</tr>
</tbody>
@@ -356,16 +328,9 @@ that&#39;s linked to it. </p>
</div>
<footer>
<div class="grad-bottom"></div>
<div class="footer">
<div class="container">
<span class="pull-right">
<a href="#top">Back to top</a>
</span>
<span>Copyright © 2015-2016 Microsoft<br>Generated by <strong>DocFX</strong></span>
<div class="inner-footer">
<p>© Microsoft &nbsp;//&nbsp; Generated with <a href="https://github.com/dotnet/docfx">DocFX</a></p>
</div>
</div>
</footer>
</div>