ckaczor/sqltoolsservice
1
0
Fork 0
mirror of https://github.com/ckaczor/sqltoolsservice.git synced 2026-01-23 09:35:38 -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

140
docs/_site/api/Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts.Message.html
View File

@@ -10,43 +10,45 @@
<meta name="viewport" content="width=device-width">
<meta name="title" content="Class Message
">
<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_Hosting_Protocol_Contracts_Message.md&amp;value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts.Message%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/Hosting/Protocol/Contracts/Message.cs/#L25" class="pull-right mobile-hide">View Source</a>
<h1 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Contracts_Message" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts.Message">Class Message
</h1>
<div class="markdown level0 summary"><p>Provides common details for protocol messages of any format.</p>
@@ -79,30 +82,6 @@
<div class="level0"><span class="xref">System.Object</span></div>
<div class="level1"><span class="xref">Message</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.Hosting.Protocol.Contracts</h6>
<h6><strong>Assembly</strong>:Microsoft.SqlTools.ServiceLayer.dll</h6>
<h5 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Contracts_Message_syntax">Syntax</h5>
@@ -118,7 +97,6 @@
<span class="small pull-right mobile-hide">
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/Protocol/Contracts/Message.cs/#L46">View Source</a>
</span>
<a id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Contracts_Message_Contents_" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts.Message.Contents*"></a>
<h4 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Contracts_Message_Contents" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts.Message.Contents">Contents</h4>
<div class="markdown level1 summary"><p>Gets or sets a JToken containing the contents of the message.</p>
</div>
@@ -127,7 +105,7 @@
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public JToken Contents { 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>
@@ -149,7 +127,6 @@
<span class="small pull-right mobile-hide">
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/Protocol/Contracts/Message.cs/#L51">View Source</a>
</span>
<a id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Contracts_Message_Error_" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts.Message.Error*"></a>
<h4 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Contracts_Message_Error" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts.Message.Error">Error</h4>
<div class="markdown level1 summary"><p>Gets or sets a JToken containing error details.</p>
</div>
@@ -158,7 +135,7 @@
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public JToken Error { 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>
@@ -180,7 +157,6 @@
<span class="small pull-right mobile-hide">
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/Protocol/Contracts/Message.cs/#L36">View Source</a>
</span>
<a id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Contracts_Message_Id_" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts.Message.Id*"></a>
<h4 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Contracts_Message_Id" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts.Message.Id">Id</h4>
<div class="markdown level1 summary"><p>Gets or sets the message&#39;s sequence ID.</p>
</div>
@@ -189,7 +165,7 @@
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public string Id { 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>
@@ -211,7 +187,6 @@
<span class="small pull-right mobile-hide">
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/Protocol/Contracts/Message.cs/#L31">View Source</a>
</span>
<a id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Contracts_Message_MessageType_" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts.Message.MessageType*"></a>
<h4 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Contracts_Message_MessageType" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts.Message.MessageType">MessageType</h4>
<div class="markdown level1 summary"><p>Gets or sets the message type.</p>
</div>
@@ -220,7 +195,7 @@
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public MessageType MessageType { 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>
@@ -242,7 +217,6 @@
<span class="small pull-right mobile-hide">
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/Protocol/Contracts/Message.cs/#L41">View Source</a>
</span>
<a id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Contracts_Message_Method_" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts.Message.Method*"></a>
<h4 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Contracts_Message_Method" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts.Message.Method">Method</h4>
<div class="markdown level1 summary"><p>Gets or sets the message&#39;s method/command name.</p>
</div>
@@ -251,7 +225,7 @@
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public string Method { 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>
@@ -275,7 +249,6 @@
<span class="small pull-right mobile-hide">
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/Protocol/Contracts/Message.cs/#L125">View Source</a>
</span>
<a id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Contracts_Message_Event_" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts.Message.Event*"></a>
<h4 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Contracts_Message_Event_System_String_Newtonsoft_Json_Linq_JToken_" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts.Message.Event(System.String,Newtonsoft.Json.Linq.JToken)">Event(String, JToken)</h4>
<div class="markdown level1 summary"><p>Creates a message with an Event type.</p>
</div>
@@ -296,13 +269,13 @@
<tbody>
<tr>
<td><span class="xref">System.String</span></td>
<td><span class="parametername">method</span></td>
<td><em>method</em></td>
<td><p>The method name of the event.</p>
</td>
</tr>
<tr>
<td><span class="xref">Newtonsoft.Json.Linq.JToken</span></td>
<td><span class="parametername">contents</span></td>
<td><em>contents</em></td>
<td><p>The contents of the event.</p>
</td>
</tr>
@@ -331,7 +304,6 @@
<span class="small pull-right mobile-hide">
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/Protocol/Contracts/Message.cs/#L72">View Source</a>
</span>
<a id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Contracts_Message_Request_" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts.Message.Request*"></a>
<h4 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Contracts_Message_Request_System_String_System_String_Newtonsoft_Json_Linq_JToken_" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts.Message.Request(System.String,System.String,Newtonsoft.Json.Linq.JToken)">Request(String, String, JToken)</h4>
<div class="markdown level1 summary"><p>Creates a message with a Request type.</p>
</div>
@@ -352,19 +324,19 @@
<tbody>
<tr>
<td><span class="xref">System.String</span></td>
<td><span class="parametername">id</span></td>
<td><em>id</em></td>
<td><p>The sequence ID of the request.</p>
</td>
</tr>
<tr>
<td><span class="xref">System.String</span></td>
<td><span class="parametername">method</span></td>
<td><em>method</em></td>
<td><p>The method name of the request.</p>
</td>
</tr>
<tr>
<td><span class="xref">Newtonsoft.Json.Linq.JToken</span></td>
<td><span class="parametername">contents</span></td>
<td><em>contents</em></td>
<td><p>The contents of the request.</p>
</td>
</tr>
@@ -393,7 +365,6 @@
<span class="small pull-right mobile-hide">
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/Protocol/Contracts/Message.cs/#L90">View Source</a>
</span>
<a id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Contracts_Message_Response_" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts.Message.Response*"></a>
<h4 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Contracts_Message_Response_System_String_System_String_Newtonsoft_Json_Linq_JToken_" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts.Message.Response(System.String,System.String,Newtonsoft.Json.Linq.JToken)">Response(String, String, JToken)</h4>
<div class="markdown level1 summary"><p>Creates a message with a Response type.</p>
</div>
@@ -414,19 +385,19 @@
<tbody>
<tr>
<td><span class="xref">System.String</span></td>
<td><span class="parametername">id</span></td>
<td><em>id</em></td>
<td><p>The sequence ID of the original request.</p>
</td>
</tr>
<tr>
<td><span class="xref">System.String</span></td>
<td><span class="parametername">method</span></td>
<td><em>method</em></td>
<td><p>The method name of the original request.</p>
</td>
</tr>
<tr>
<td><span class="xref">Newtonsoft.Json.Linq.JToken</span></td>
<td><span class="parametername">contents</span></td>
<td><em>contents</em></td>
<td><p>The contents of the response.</p>
</td>
</tr>
@@ -455,7 +426,6 @@
<span class="small pull-right mobile-hide">
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/Protocol/Contracts/Message.cs/#L108">View Source</a>
</span>
<a id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Contracts_Message_ResponseError_" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts.Message.ResponseError*"></a>
<h4 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Contracts_Message_ResponseError_System_String_System_String_Newtonsoft_Json_Linq_JToken_" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts.Message.ResponseError(System.String,System.String,Newtonsoft.Json.Linq.JToken)">ResponseError(String, String, JToken)</h4>
<div class="markdown level1 summary"><p>Creates a message with a Response type and error details.</p>
</div>
@@ -476,19 +446,19 @@
<tbody>
<tr>
<td><span class="xref">System.String</span></td>
<td><span class="parametername">id</span></td>
<td><em>id</em></td>
<td><p>The sequence ID of the original request.</p>
</td>
</tr>
<tr>
<td><span class="xref">System.String</span></td>
<td><span class="parametername">method</span></td>
<td><em>method</em></td>
<td><p>The method name of the original request.</p>
</td>
</tr>
<tr>
<td><span class="xref">Newtonsoft.Json.Linq.JToken</span></td>
<td><span class="parametername">error</span></td>
<td><em>error</em></td>
<td><p>The error details of the response.</p>
</td>
</tr>
@@ -517,7 +487,6 @@
<span class="small pull-right mobile-hide">
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/Protocol/Contracts/Message.cs/#L57">View Source</a>
</span>
<a id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Contracts_Message_Unknown_" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts.Message.Unknown*"></a>
<h4 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Contracts_Message_Unknown" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts.Message.Unknown">Unknown()</h4>
<div class="markdown level1 summary"><p>Creates a message with an Unknown type.</p>
</div>
@@ -566,16 +535,9 @@
</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>