Skip to content

Commit

Permalink
Commiting documentation to gh-pages. Resolves #4
Browse files Browse the repository at this point in the history
  • Loading branch information
@tpeczek
tpeczek committed Sep 30, 2017
0 parents commit d55d073
Show file tree
Hide file tree
Showing 31 changed files with 7,182 additions and 0 deletions.
261 changes: 261 additions & 0 deletions api/Lib.AspNetCore.ServerSentEvents.IServerSentEventsClient.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,261 @@
<!DOCTYPE html>
<!--[if IE]><![endif]-->
<html>

<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>Interface IServerSentEventsClient
| Lib.AspNetCore.ServerSentEvents </title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Interface IServerSentEventsClient
| Lib.AspNetCore.ServerSentEvents ">
<meta name="generator" content="docfx 2.22.3.0">

<link rel="shortcut icon" href="../resources/ico/favicon.ico">
<link rel="stylesheet" href="../styles/docfx.vendor.css">
<link rel="stylesheet" href="../styles/docfx.css">
<link rel="stylesheet" href="../styles/main.css">
<meta property="docfx:navrel" content="../toc.html">
<meta property="docfx:tocrel" content="toc.html">


</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="../resources/svg/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>
</header>
<div role="main" class="container body-content hide-when-search">

<div class="sidenav hide-when-search">
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
<div class="sidetoggle collapse" id="sidetoggle">
<div id="sidetoc"></div>
</div>
</div>
<div class="article row grid-right">
<div class="col-md-12">
<article class="content wrap" id="_content" data-uid="Lib.AspNetCore.ServerSentEvents.IServerSentEventsClient">


<h1 id="Lib_AspNetCore_ServerSentEvents_IServerSentEventsClient" data-uid="Lib.AspNetCore.ServerSentEvents.IServerSentEventsClient" class="text-break">Interface IServerSentEventsClient
</h1>
<div class="markdown level0 summary"><p>Contract for client listening for Server-Sent Events</p>
</div>
<div class="markdown level0 conceptual"></div>
<h6><strong>Namespace</strong>: <a class="xref" href="Lib.AspNetCore.ServerSentEvents.html">Lib.AspNetCore.ServerSentEvents</a></h6>
<h6><strong>Assembly</strong>: Lib.AspNetCore.ServerSentEvents.dll</h6>
<h5 id="Lib_AspNetCore_ServerSentEvents_IServerSentEventsClient_syntax">Syntax</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public interface IServerSentEventsClient</code></pre>
</div>
<h3 id="properties">Properties
</h3>
<a id="Lib_AspNetCore_ServerSentEvents_IServerSentEventsClient_Id_" data-uid="Lib.AspNetCore.ServerSentEvents.IServerSentEventsClient.Id*"></a>
<h4 id="Lib_AspNetCore_ServerSentEvents_IServerSentEventsClient_Id" data-uid="Lib.AspNetCore.ServerSentEvents.IServerSentEventsClient.Id">Id</h4>
<div class="markdown level1 summary"><p>Gets the unique client identifier.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">Guid Id { get; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Guid</span></td>
<td></td>
</tr>
</tbody>
</table>
<a id="Lib_AspNetCore_ServerSentEvents_IServerSentEventsClient_IsConnected_" data-uid="Lib.AspNetCore.ServerSentEvents.IServerSentEventsClient.IsConnected*"></a>
<h4 id="Lib_AspNetCore_ServerSentEvents_IServerSentEventsClient_IsConnected" data-uid="Lib.AspNetCore.ServerSentEvents.IServerSentEventsClient.IsConnected">IsConnected</h4>
<div class="markdown level1 summary"><p>Gets the value indicating if client is connected.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">bool IsConnected { get; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Boolean</span></td>
<td></td>
</tr>
</tbody>
</table>
<a id="Lib_AspNetCore_ServerSentEvents_IServerSentEventsClient_User_" data-uid="Lib.AspNetCore.ServerSentEvents.IServerSentEventsClient.User*"></a>
<h4 id="Lib_AspNetCore_ServerSentEvents_IServerSentEventsClient_User" data-uid="Lib.AspNetCore.ServerSentEvents.IServerSentEventsClient.User">User</h4>
<div class="markdown level1 summary"><p>Gets the System.Security.Claims.ClaimsPrincipal for user associated with the client.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">ClaimsPrincipal User { get; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Security.Claims.ClaimsPrincipal</span></td>
<td></td>
</tr>
</tbody>
</table>
<h3 id="methods">Methods
</h3>
<a id="Lib_AspNetCore_ServerSentEvents_IServerSentEventsClient_SendEventAsync_" data-uid="Lib.AspNetCore.ServerSentEvents.IServerSentEventsClient.SendEventAsync*"></a>
<h4 id="Lib_AspNetCore_ServerSentEvents_IServerSentEventsClient_SendEventAsync_Lib_AspNetCore_ServerSentEvents_ServerSentEvent_" data-uid="Lib.AspNetCore.ServerSentEvents.IServerSentEventsClient.SendEventAsync(Lib.AspNetCore.ServerSentEvents.ServerSentEvent)">SendEventAsync(ServerSentEvent)</h4>
<div class="markdown level1 summary"><p>Sends event to client.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">Task SendEventAsync(ServerSentEvent serverSentEvent)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="Lib.AspNetCore.ServerSentEvents.ServerSentEvent.html">ServerSentEvent</a></td>
<td><span class="parametername">serverSentEvent</span></td>
<td><p>The event.</p>
</td>
</tr>
</tbody>
</table>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Threading.Tasks.Task</span></td>
<td><p>The task object representing the asynchronous operation.</p>
</td>
</tr>
</tbody>
</table>
<a id="Lib_AspNetCore_ServerSentEvents_IServerSentEventsClient_SendEventAsync_" data-uid="Lib.AspNetCore.ServerSentEvents.IServerSentEventsClient.SendEventAsync*"></a>
<h4 id="Lib_AspNetCore_ServerSentEvents_IServerSentEventsClient_SendEventAsync_System_String_" data-uid="Lib.AspNetCore.ServerSentEvents.IServerSentEventsClient.SendEventAsync(System.String)">SendEventAsync(String)</h4>
<div class="markdown level1 summary"><p>Sends event to client.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">Task SendEventAsync(string text)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.String</span></td>
<td><span class="parametername">text</span></td>
<td><p>The simple text event.</p>
</td>
</tr>
</tbody>
</table>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Threading.Tasks.Task</span></td>
<td><p>The task object representing the asynchronous operation.</p>
</td>
</tr>
</tbody>
</table>
</article>
</div>
</div>
</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>
Copyright © 2017 Tomasz Pęczek

</div>
</div>
</footer>
</div>

<script type="text/javascript" src="../styles/docfx.vendor.js"></script>
<script type="text/javascript" src="../styles/docfx.js"></script>
<script type="text/javascript" src="../styles/main.js"></script>
</body>
</html>
Loading

0 comments on commit d55d073

Please sign in to comment.