openiddict-documentation/api/OpenIddict.Validation.OpenIddictValidationEvents.BaseRequestContext.html
2021-01-17 18:24:47 +00:00

280 lines
13 KiB
HTML

<!DOCTYPE html>
<!--[if IE]><![endif]-->
<html>
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>Class OpenIddictValidationEvents.BaseRequestContext
</title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Class OpenIddictValidationEvents.BaseRequestContext
">
<meta name="generator" content="docfx 2.56.6.0">
<link rel="shortcut icon" href="../images/favicon.ico">
<link rel="stylesheet" href="../styles/docfx.vendor.css">
<link rel="stylesheet" href="../styles/docfx.css">
<link rel="stylesheet" href="../styles/main.css">
<link href="https://fonts.googleapis.com/css?family=Roboto" rel="stylesheet">
<meta property="docfx:navrel" content="../toc.html">
<meta property="docfx:tocrel" content="toc.html">
</head> <body data-spy="scroll" data-target="#affix" data-offset="120">
<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="../images/logo.png" 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>
<div class="subnav navbar navbar-default">
<div class="container hide-when-search" id="breadcrumb">
<ul class="breadcrumb">
<li></li>
</ul>
</div>
</div>
</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-10">
<article class="content wrap" id="_content" data-uid="OpenIddict.Validation.OpenIddictValidationEvents.BaseRequestContext">
<h1 id="OpenIddict_Validation_OpenIddictValidationEvents_BaseRequestContext" data-uid="OpenIddict.Validation.OpenIddictValidationEvents.BaseRequestContext" class="text-break">Class OpenIddictValidationEvents.BaseRequestContext
</h1>
<div class="markdown level0 summary"><p>Represents an abstract base class used for certain event contexts.</p>
</div>
<div class="markdown level0 conceptual"></div>
<div class="inheritance">
<h5>Inheritance</h5>
<div class="level0"><span class="xref">System.Object</span></div>
<div class="level1"><a class="xref" href="OpenIddict.Validation.OpenIddictValidationEvents.BaseContext.html">OpenIddictValidationEvents.BaseContext</a></div>
<div class="level2"><span class="xref">OpenIddictValidationEvents.BaseRequestContext</span></div>
<div class="level3"><a class="xref" href="OpenIddict.Validation.OpenIddictValidationEvents.BaseValidatingContext.html">OpenIddictValidationEvents.BaseValidatingContext</a></div>
<div class="level3"><a class="xref" href="OpenIddict.Validation.OpenIddictValidationEvents.ProcessErrorContext.html">OpenIddictValidationEvents.ProcessErrorContext</a></div>
</div>
<div class="inheritedMembers">
<h5>Inherited Members</h5>
<div>
<a class="xref" href="OpenIddict.Validation.OpenIddictValidationEvents.BaseContext.html#OpenIddict_Validation_OpenIddictValidationEvents_BaseContext_Transaction">OpenIddictValidationEvents.BaseContext.Transaction</a>
</div>
<div>
<a class="xref" href="OpenIddict.Validation.OpenIddictValidationEvents.BaseContext.html#OpenIddict_Validation_OpenIddictValidationEvents_BaseContext_EndpointType">OpenIddictValidationEvents.BaseContext.EndpointType</a>
</div>
<div>
<a class="xref" href="OpenIddict.Validation.OpenIddictValidationEvents.BaseContext.html#OpenIddict_Validation_OpenIddictValidationEvents_BaseContext_Issuer">OpenIddictValidationEvents.BaseContext.Issuer</a>
</div>
<div>
<a class="xref" href="OpenIddict.Validation.OpenIddictValidationEvents.BaseContext.html#OpenIddict_Validation_OpenIddictValidationEvents_BaseContext_Logger">OpenIddictValidationEvents.BaseContext.Logger</a>
</div>
<div>
<a class="xref" href="OpenIddict.Validation.OpenIddictValidationEvents.BaseContext.html#OpenIddict_Validation_OpenIddictValidationEvents_BaseContext_Options">OpenIddictValidationEvents.BaseContext.Options</a>
</div>
<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.ToString()</span>
</div>
<div>
<span class="xref">System.Object.ReferenceEquals(System.Object, System.Object)</span>
</div>
</div>
<h6><strong>Namespace</strong>: <a class="xref" href="OpenIddict.Validation.html">OpenIddict.Validation</a></h6>
<h6><strong>Assembly</strong>: cs.temp.dll.dll</h6>
<h5 id="OpenIddict_Validation_OpenIddictValidationEvents_BaseRequestContext_syntax">Syntax</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public abstract class BaseRequestContext : OpenIddictValidationEvents.BaseContext</code></pre>
</div>
<h3 id="constructors">Constructors
</h3>
<a id="OpenIddict_Validation_OpenIddictValidationEvents_BaseRequestContext__ctor_" data-uid="OpenIddict.Validation.OpenIddictValidationEvents.BaseRequestContext.#ctor*"></a>
<h4 id="OpenIddict_Validation_OpenIddictValidationEvents_BaseRequestContext__ctor_OpenIddict_Validation_OpenIddictValidationTransaction_" data-uid="OpenIddict.Validation.OpenIddictValidationEvents.BaseRequestContext.#ctor(OpenIddict.Validation.OpenIddictValidationTransaction)">BaseRequestContext(OpenIddictValidationTransaction)</h4>
<div class="markdown level1 summary"><p>Creates a new instance of the <a class="xref" href="OpenIddict.Validation.OpenIddictValidationEvents.BaseRequestContext.html">OpenIddictValidationEvents.BaseRequestContext</a> class.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">protected BaseRequestContext(OpenIddictValidationTransaction transaction)</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="OpenIddict.Validation.OpenIddictValidationTransaction.html">OpenIddictValidationTransaction</a></td>
<td><span class="parametername">transaction</span></td>
<td></td>
</tr>
</tbody>
</table>
<h3 id="properties">Properties
</h3>
<a id="OpenIddict_Validation_OpenIddictValidationEvents_BaseRequestContext_IsRequestHandled_" data-uid="OpenIddict.Validation.OpenIddictValidationEvents.BaseRequestContext.IsRequestHandled*"></a>
<h4 id="OpenIddict_Validation_OpenIddictValidationEvents_BaseRequestContext_IsRequestHandled" data-uid="OpenIddict.Validation.OpenIddictValidationEvents.BaseRequestContext.IsRequestHandled">IsRequestHandled</h4>
<div class="markdown level1 summary"><p>Gets a boolean indicating whether the request was fully handled.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public bool IsRequestHandled { 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="OpenIddict_Validation_OpenIddictValidationEvents_BaseRequestContext_IsRequestSkipped_" data-uid="OpenIddict.Validation.OpenIddictValidationEvents.BaseRequestContext.IsRequestSkipped*"></a>
<h4 id="OpenIddict_Validation_OpenIddictValidationEvents_BaseRequestContext_IsRequestSkipped" data-uid="OpenIddict.Validation.OpenIddictValidationEvents.BaseRequestContext.IsRequestSkipped">IsRequestSkipped</h4>
<div class="markdown level1 summary"><p>Gets a boolean indicating whether the request processing was skipped.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public bool IsRequestSkipped { 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>
<h3 id="methods">Methods
</h3>
<a id="OpenIddict_Validation_OpenIddictValidationEvents_BaseRequestContext_HandleRequest_" data-uid="OpenIddict.Validation.OpenIddictValidationEvents.BaseRequestContext.HandleRequest*"></a>
<h4 id="OpenIddict_Validation_OpenIddictValidationEvents_BaseRequestContext_HandleRequest" data-uid="OpenIddict.Validation.OpenIddictValidationEvents.BaseRequestContext.HandleRequest">HandleRequest()</h4>
<div class="markdown level1 summary"><p>Marks the request as fully handled. Once declared handled,
a request shouldn&apos;t be processed further by the underlying host.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public void HandleRequest()</code></pre>
</div>
<a id="OpenIddict_Validation_OpenIddictValidationEvents_BaseRequestContext_SkipRequest_" data-uid="OpenIddict.Validation.OpenIddictValidationEvents.BaseRequestContext.SkipRequest*"></a>
<h4 id="OpenIddict_Validation_OpenIddictValidationEvents_BaseRequestContext_SkipRequest" data-uid="OpenIddict.Validation.OpenIddictValidationEvents.BaseRequestContext.SkipRequest">SkipRequest()</h4>
<div class="markdown level1 summary"><p>Marks the request as skipped. Once declared skipped, a request
shouldn&apos;t be processed further by OpenIddict but should be allowed
to go through the next components in the processing pipeline
(if this pattern is supported by the underlying host).</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public void SkipRequest()</code></pre>
</div>
</article>
</div>
<div class="hidden-sm col-md-2" role="complementary">
<div class="sideaffix">
<div class="contribution">
<ul class="nav">
</ul>
</div>
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
<h5>In This Article</h5>
<div></div>
</nav>
</div>
</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>
<span>Generated by <strong>DocFX</strong></span>
</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>